Nonsense Placement Mandatory
Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

simple-modal

2.0.0 • Public • Published

simple-modal

A module to create a modal. The purpose of this module is to have an easy to use modal that does not have any hidden dependencies (no jQuery!), and features a few useful options.

The modal comes with a default style.

Usage

var modalStyle = require('../index.js');
var theModal = modalStyle( options );

Options

  • title (string) a title for the modal.
  • content (string or DOM object) the content of the modal.
  • clickOutsideToClose (boolean) (default=true) whether a click outside the modal should close it.
  • removeOnClose (boolean) (default=true) whether the modal should be removed from the DOM upon close.
  • attachToBody (boolean) (default=true) whether the modal should be attached to the body upon invoke.
  • buttons (array of objects) a list of buttons to add to the modal. Has a "Cancel" and "Confirm" button as defaults.
    • text (string) text of the button.
    • closeOnClick (boolean) whether a click of the button should close the modal
    • className (string) classes to add to the button
    • callback (function) a function to fire when the button is clicked

Methods

theModal.updateContent( newContent);

Change the content inside of the modal. Currently, this cannot change the buttons or title of the modal.

theModal.deconstruct( newContent);

Remove the modal from the DOM.

theModal.close( newContent);

Hide the modal.

theModal.show( newContent);

Show the modal.

Properties

theModal.m - the DOM object. If you set attachToBody=false, then you could instead do: div.appendChild(theModal.m);

theModal.opts - the options you passed in upon invoking the modal, plus any defaults that you did not pass in your options.

Note

Based off of https://github.com/bengourley/modal.js

Keywords

install

npm i simple-modal

Downloadsweekly downloads

6

version

2.0.0

license

BSD

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
Report a vulnerability