paper-dialog-behavior

WebJar for paper-dialog-behavior

License	BSD 3-Clause
GroupId	org.webjars.bower
ArtifactId	paper-dialog-behavior
Last Version	2.0.1
Release Date	Oct 7, 2017
Type	jar
Description	paper-dialog-behavior WebJar for paper-dialog-behavior
Project URL	http://webjars.org
Source Code Management	https://github.com/PolymerElements/paper-dialog-behavior

Download paper-dialog-behavior

Filename	Size
paper-dialog-behavior-2.0.1.pom
paper-dialog-behavior-2.0.1.jar	20 KB
paper-dialog-behavior-2.0.1-sources.jar	22 bytes
paper-dialog-behavior-2.0.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.bower/paper-dialog-behavior/ -->
<dependency>
    <groupId>org.webjars.bower</groupId>
    <artifactId>paper-dialog-behavior</artifactId>
    <version>2.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.bower/paper-dialog-behavior/
implementation 'org.webjars.bower:paper-dialog-behavior:2.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.bower/paper-dialog-behavior/
implementation ("org.webjars.bower:paper-dialog-behavior:2.0.1")

Apache Buildr

'org.webjars.bower:paper-dialog-behavior:jar:2.0.1'

Apache Ivy

<dependency org="org.webjars.bower" name="paper-dialog-behavior" rev="2.0.1">
  <artifact name="paper-dialog-behavior" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.bower', module='paper-dialog-behavior', version='2.0.1')
)

Scala SBT

libraryDependencies += "org.webjars.bower" % "paper-dialog-behavior" % "2.0.1"

Leiningen

[org.webjars.bower/paper-dialog-behavior "2.0.1"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.bower : github-com-polymerelements-iron-overlay-behavior	jar	[1,3)
org.webjars.bower : github-com-polymerelements-paper-styles	jar	[1,3)
org.webjars.bower : github-com-polymer-polymer	jar	[1.9,3)

Project Modules

There are no modules declared in this project.

PaperDialogBehavior

Use PaperDialogBehavior and paper-dialog-shared-styles.js 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.js 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.

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.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/paper-dialog-behavior

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {PaperDialogBehavior} from '@polymer/paper-dialog-behavior/paper-dialog-behavior.js';

class SampleElement extends mixinBehaviors(PaperDialogBehavior, PolymerElement) {
  static get template() {
    return html`
      <style include="paper-dialog-shared-styles"></style>
      <slot></slot>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Contributing

If you want to send a PR to this element, here are the instructions for running the tests and demo locally:

Installation

git clone https://github.com/PolymerElements/paper-dialog-behavior
cd paper-dialog-behavior
npm install
npm install -g polymer-cli

Running the demo locally

polymer serve --npm
open http://127.0.0.1:<port>/demo/

Running the tests

polymer test --npm

Versions

Version
2.0.1 Oct 7, 2017