Socket
Socket
Sign inDemoInstall

modal-styled

Package Overview
Dependencies
141
Maintainers
1
Versions
5
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    modal-styled

Somewhat based on modal.js (https://github.com/bengourley/modal.js)


Version published
Weekly downloads
2
Maintainers
1
Created
Weekly downloads
 

Readme

Source

modal-styled

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

FAQs

Last updated on 05 May 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc