npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ok-modals

v1.0.0

Published

vue2 modals plugin

Downloads

3

Readme

Modal Plugin

  1. Register plugin in the root js-file
import Vue from "vue";
import ModalPlugin from "@/plugins/modal/ModalPlugin";
...
Vue.use(ModalPlugin);
...
new Vue({ ... })
  1. Use <modals-wrapper /> inside vue-component as a root modal-component (no need to import and register it, plugin does it globally).
  2. To create/show/hide modal:
import ModalDialog from "@/ui/modals/ModalDialog";
methods: {
  ...
  myShowModalFn() {
    this.$modal.create({
      // The names of properties do matter!
      id: "foo", // Required, unique, string or number
      modalComponent: ModalDialog, // Required, vue-component
      text: "Lorem ipsum", // Optional
      props: { 
        myFirstPropName: myFirstPropValue,
        mySecondPropName: mySecondPropValue,
        ....
      }, // Optional
      onConfirm: someFn, // Optional, async fn is ok
      onCancel: someFn, //  Optional, async fn is ok
    });
    this.$modal.show("foo"); // Pass an id of modal here
  },
  myHideModalFn() {
    this.$modal.hide("foo"); // Pass an id of modal here
  }
}
  1. Modal-component (ModalDialog in example) gets from parent such props:
    disabled: {
      type: Boolean,
    },
    text: {
      type: String,
    },
    isVisible: {
      type: Boolean,
    },
  1. Modal-component (ModalDialog in example) must emit "cancel" and "confirm" events on related buttons click.
  2. Modal-component (ModalDialog in example) does not get onConfirm and onCancel functions. These functions run in ModalsWrapper.
  3. ModalsWrapper is transparent for custom-events and for props.
  4. For testing create, show, hide methods use spyOn:
    // wrapper here is the VTU-wrapper for component where the modal was created
    const modalCreateSpyOn = jest.spyOn(wrapper.vm.$modal, "create");
    // do something to show a modal (click on button for instance)
    expect(modalCreateSpyOn).toHaveBeenCalled();
    expect(modalCreateSpyOn).toHaveBeenCalledWith({
        id: `your-expected-id`,
        modalComponent: `YourExpectedComponent`,
        text: `your-expected-text`,
        onCancel: expect.any(Function), // or particular fn
        onConfirm: expect.any(Function), // or particular fn
    });
    modalCreateSpyOn.mockReset();
  1. Testing of onConfirm/onCancel methods should be done in the component that includes <modals-wrapper>.