smart-dialog
v0.0.3
Published
A small wrapper around the native HTML <dialog> element, adding support for restoring focus after close, and closing by clicking on the backdrop.
Downloads
3
Readme
Smart Dialog
A small wrapper around the native HTML <dialog> element, adding support for restoring focus after close, and closing by clicking on the backdrop. It includes the dialog-polyfill by Google.
Note: This library doesn't yet support form
elements with the attribute method="dialog"
inside dialogs.
Check out a demo.
Installation
Install from npm:
npm install smart-dialog --save
Or download the repo, and include the smart-dialog.js
file from the dist
folder:
<script src="PATH/TO/smart-dialog.js"></script>
Usage
Create an instance by passing a dialog
element and an optional options object to the SmartDialog
constructor:
const myDialog = new SmartDialog(document.getElementById('my-dialog'), options)
The following options are available:
handleFocus
Boolean. Defaults to truehandleBackdropClick
Boolean. Defaults to true
For example:
const myDialog = new SmartDialog(document.getElementById('my-dialog'), {
handleFocus: false,
})
The exposed API is mostly the same as for the HTMLDialogElement, so please refer to that for details.
Available properties:
open
returnValue
Additionally you can access the underlying dialog
element with the element
property.
Available methods:
close()
show()
showModal()
Note: Check out the example folder for a usage example.