<details-dialog> element

A modal dialog that's opened with a <details> button.

Installation

$ npm install --save @github/details-dialog-element

Usage

import '@github/details-dialog-element'

<details>
  <summary>Open dialog</summary>
  <details-dialog>
    Modal content
    <button type="button" data-close-dialog>Close</button>
  </details-dialog>
</details>

Deferred loading

Dialog content can be loaded from a server by embedding an <include-fragment> element.

<details>
  <summary>Robots</summary>
  <details-dialog src="/robots" preload>
    <include-fragment>Loading…</include-fragment>
  </details-dialog>
</details>

The src attribute value is copied to the <include-fragment> the first time the <details> button is toggled open, which starts the server fetch.

If the preload attribute is present, hovering over the <details> element will trigger the server fetch.

Events

`details-dialog-close`

details-dialog-close event is fired from <details-dialog> when a request to close the dialog is made from

pressing escape,
clicking on summary, [data-close-dialog], or
dialog.toggle(false)

This event bubbles, and can be canceled to keep the dialog open.

document.addEventListener('details-dialog-close', function(event) {
  if (!confirm('Are you sure?')) {
    event.preventDefault()
  }
})

Browser support

Browsers without native custom element support require a polyfill.

Chrome
Firefox
Safari
Microsoft Edge

Development

npm install
npm test

License

Distributed under the MIT license. See LICENSE for details.

Assets 3

23 Jul 14:27

koddsson

v3.0.7

4a8e480

v3.0.7

npm audit fix 70eb697
Merge pull request #42 from github/update-deps abdf5e3
update eslint, eslint-plugin-github and flow-bin manually to latest versions 265bf09
fix shadowed variable ea1422d
run npm update 229d2b9