Simple-dialog NPM

simple-dialog

A simple dialog component for the browser.

Open Dialog Window

Features

content from string or element
(optional) backdrop
(optional) close handle
(optional) modal
return values
life-cycle events

Usage

var SimpleDialog = require('simple-dialog');

var dialog = SimpleDialog({
  template: '<h1>HEADER</h1>'
});

// open dialog
dialog.open(function(returnValue) {
  console.log('dialog closed with', returnValue);
});

// close with value
dialog.close({ foo: 'BAR' });

Configuration Options

The dialog constructor accepts the following configuration options:

{Boolean}        [backdrop=true]     if false, do not show backdrop
{Boolean}        [closable=true]     if false, do not close via close control/backdrop
{String}         [id]                an id to assign to the dialog
{Element|String} [parent='body']     the parent node to attach the dialog to
{Element|String} [template]          the element to display as the dialog content
{String}         [className='']      classes to add to the .dlg element

API

`open([closeFn])`

`close([resultValue])`

`toggleClass('class list')`

`element: DOMElement`

Template

The dialog is built from the following template:

<div class="dlg">
  <div class="dlg-body">
    <a class="dlg-close" href>&times;</a>
    <div class="dlg-content"></div>
  </div>
</div>

Default styling can be found in the less/dialog.less file.

Access from the DOM

The dialog will attach itself to its dom node via the dialog property once it is attached to the document tree.

SimpleDialog({
  id: 'how-are-you',
  template: 'How are you?'
});

setTimeout(function() {
  SimpleDialog('#how-are-you').close();
}, 2000);

Close from Template

The dialog will close on elements annotated with .dlg-close. A custom close result can be provided via the dlg-close-result attribute on .dlg-close elements.

SimpleDialog({
  id: 'how-are-you',
  template: '<button class="dlg-close" dlg-close-result="foo">FOO</button>'
});

Extend the Dialog

The dialog is an EventEmitter. Extend it by hooking into one of the following life-cycle events:

attach(parentElement)     attached to parentElement
pre-open                  about to open
open                      dialog is open
pre-close(resultValue)    about to close with returnValue
close(resultValue)        dialog closed with returnValue
detach(parentElement)     detached from parentElement

The this argument inside an event listener will always refer to the respective dialog instance:

SimpleDialog({ template: 'HUUUU!' }).on('pre-open', function() {
  var dialog = this;

  setTimeout(function() {
    dialog.close('timeout, haha!');
  }, 2000);
});

Use the life-cycle events in order to make it fit into your favourite front-end library. An example integration into AngularJS can be found here.