JSPM

  • Created
  • Published
  • Downloads 11339
  • Score
    100M100P100Q149701F
  • License BSD-3-Clause

Implements a behavior used for material design dialogs

Package Exports

  • @polymer/paper-dialog-behavior/paper-dialog-behavior
  • @polymer/paper-dialog-behavior/paper-dialog-behavior.js
  • @polymer/paper-dialog-behavior/paper-dialog-shared-styles
  • @polymer/paper-dialog-behavior/paper-dialog-shared-styles.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@polymer/paper-dialog-behavior) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Build status Published on webcomponents.org

Polymer.PaperDialogBehavior

Use Polymer.PaperDialogBehavior and paper-dialog-shared-styles.html to implement a Material Design dialog.

For example, if <paper-dialog-impl> implements this behavior:

<paper-dialog-impl>
    <h2>Header</h2>
    <div>Dialog body</div>
    <div class="paper-dialog-buttons">
        <paper-button dialog-dismiss>Cancel</paper-button>
        <paper-button dialog-confirm>Accept</paper-button>
    </div>
</paper-dialog-impl>

paper-dialog-shared-styles.html provide styles for a header, content area, and an action area for buttons. Use the <h2> tag for the header and the paper-dialog-buttons or buttons class for the action area. You can use the paper-dialog-scrollable element (in its own repository) if you need a scrolling content area.

Use the dialog-dismiss and dialog-confirm attributes on interactive controls to close the dialog. If the user dismisses the dialog with dialog-confirm, the closingReason will update to include confirmed: true.

Changes in 2.0

  • paper-dialog-shared-styles styles direct h2 and .buttons children of the dialog because of how ::slotted works (compound selector will select only top level nodes)
  • Removed paper-dialog-common.css as it's a duplicate of paper-dialog-shared-styles.html. Import the shared styles via <style include="paper-dialog-shared-styles"> (see example)

Accessibility

This element has role="dialog" by default. Depending on the context, it may be more appropriate to override this attribute with role="alertdialog".

If modal is set, the element will prevent the focus from exiting the element. It will also ensure that focus remains in the dialog.