Skip to content

Latest commit

 

History

History
 
 

makeup-modal

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
dist
dist
 
 
src
src
 
 
test
test
 
 
.npmrc
.npmrc
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
babel.config.json
babel.config.json
 
 
browser.json
browser.json
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 

README.md

makeup-modal

Sets an element to a modal state using makeup-keyboard-trap and makeup-screenreader-trap. All other elements become "inert".

Experimental

This CommonJS module is still in an experimental state, until it reaches v1.0.0 you must consider all minor releases as breaking changes. Patch releases may introduce new features, but will be backwards compatible.

const modal = require('makeup-modal');

// set an element to modal
modal.modal(document.querySelector('el'));

// reset the element to non-modal
modal.unmodal();

Install

npm install makeup-modal

Options

  • useHiddenProperty: use hidden property for inert content instead of aria-hidden (useful for fullscreen modals) (default: false)
  • hoist: moves the element to the document root (default: false)
  • wrap: if element is at document root, wraps all "inert" sibling elements into a single container (default: false)

Events

  • makeup-modal
  • makeup-unmodal