← Back

paper-behaviors

Common behaviors used across paper-* elements.

Author

Rating

Popularity

<100

<paper-behaviors>

<paper-behaviors> is a set of behaviours to help implement Material Design elements:

PaperCheckedElementBehavior to implement a custom element that has a checked property similar to IronCheckedElementBehavior and is compatible with having a ripple effect.
PaperInkyFocusBehavior implements a ripple when the element has keyboard focus.
PaperRippleBehavior dynamically implements a ripple when the element has focus via pointer or keyboard. This behavior is intended to be used in conjunction with and after IronButtonState and IronControlState.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/paper-behaviors

Example of using one of the behaviours in a Polymer 3 element

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

class SampleElement extends mixinBehaviors([PaperButtonBehavior], PolymerElement) {
  static get template() {
    return html`
      <style>
        :host {
          display: block;
        }
        /* Some properties inherited from the behaviour */
        :host([disabled]) {
          background-color: grey;
          pointer-events: none;
        }
        :host([active]),
        :host([pressed]) {
          background-color: blue;
        }
      </style>
      <div>I am a ripple-y button</div>
    `;
  }
}
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-behaviors
cd paper-behaviors
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

Compatibility

(Loading compatibility data...)

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

@polymer/iron-behaviors#^3.0.0-pre.26
@polymer/iron-checked-element-behavior#^3.0.0-pre.26
@polymer/paper-ripple#^3.0.0-pre.26
@polymer/polymer#^3.0.0

Released: 2018-09-14
Maturity: IMPORTED
License: BSD 3-clause "New" or "Revised" License

Compatibility

Framework: Polymer 3.0+; Polymer 2.0+ in 2.1.1; Polymer 1.0+ in 1.0.13
Browser: Browser Independent

paper-behaviors - Vaadin Add-on Directory

Name: paper-behaviors
Availability: InStock
Author: PolymerElements

Common behaviors used across paper-* elements.

paper-behaviors - Vaadin Add-on Directory

[![Published on NPM](https://img.shields.io/npm/v/@polymer/paper-behaviors.svg)](https://www.npmjs.com/package/@polymer/paper-behaviors) [![Build status](https://travis-ci.org/PolymerElements/paper-behaviors.svg?branch=master)](https://travis-ci.org/PolymerElements/paper-behaviors) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/paper-behaviors) ## <paper-behaviors> `` is a set of behaviours to help implement Material Design elements: - `PaperCheckedElementBehavior` to implement a custom element that has a `checked` property similar to `IronCheckedElementBehavior` and is compatible with having a ripple effect. - `PaperInkyFocusBehavior` implements a ripple when the element has keyboard focus. - `PaperRippleBehavior` dynamically implements a ripple when the element has focus via pointer or keyboard. This behavior is intended to be used in conjunction with and after `IronButtonState` and `IronControlState`. See: [Documentation](https://www.webcomponents.org/element/@polymer/paper-behaviors), [Demo](https://www.webcomponents.org/element/@polymer/paper-behaviors/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/paper-behaviors ``` ### Example of using one of the behaviours in a Polymer 3 element ```js import {PolymerElement, html} from '@polymer/polymer'; import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js'; import {PaperButtonBehavior} from '@polymer/paper-behaviors/paper-button-behavior.js'; class SampleElement extends mixinBehaviors([PaperButtonBehavior], PolymerElement) { static get template() { return html`

I am a ripple-y button

`; } } 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 ```sh git clone https://github.com/PolymerElements/paper-behaviors cd paper-behaviors npm install npm install -g polymer-cli ``` ### Running the demo locally ```sh polymer serve --npm open http://127.0.0.1:/demo/ ``` ### Running the tests ```sh polymer test --npm ```

License
View on NPM
View on GitHub

paper-behaviors version 0.8.2
### Dependencies * polymer#polymer/polymer#v0.8.0-rc.7 * iron-behaviors#PolymerElements/iron-behaviors#^0.8.0

paper-behaviors version 0.8.3
### Dependencies * polymer#polymer/polymer#v0.8.0-rc.7 * iron-behaviors#PolymerElements/iron-behaviors#^0.8.0

paper-behaviors version 0.9.0
### Dependencies * polymer#polymer/polymer#v0.9.0-rc.1 * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0

paper-behaviors version 0.9.1
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.2
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.3
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.4
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.5
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.6
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 0.9.7
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^0.9.0 * polymer#Polymer/polymer#^0.9.0

paper-behaviors version 1.0.0
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.1
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.2
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.3
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.4
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.5
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.6
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.7
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.8
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.9
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.0.0

paper-behaviors version 1.0.10
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * polymer#Polymer/polymer#^1.2.1

paper-behaviors version 1.0.11
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * paper-ripple#PolymerElements/paper-ripple#^1.0.0 * polymer#Polymer/polymer#^1.2.1

paper-behaviors version 0.0.1
### Dependencies * @polymer/iron-behaviors#^0.0.1 * @polymer/iron-checked-element-behavior#^0.0.1 * @polymer/paper-ripple#^0.0.1 * @polymer/polymer#^1.2.5-npm-test.2

paper-behaviors version 0.0.3
### Dependencies * @polymer/iron-behaviors#^0.0.3 * @polymer/iron-checked-element-behavior#^0.0.3 * @polymer/paper-ripple#^0.0.3 * @polymer/polymer#^1.2.5-npm-test.2

paper-behaviors version 1.0.12
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * paper-ripple#PolymerElements/paper-ripple#^1.0.0 * polymer#Polymer/polymer#^1.2.1

paper-behaviors version 1.0.13
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#^1.0.0 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#^1.0.0 * paper-ripple#PolymerElements/paper-ripple#^1.0.0 * polymer#Polymer/polymer#^1.2.1

paper-behaviors version 2.0.0
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#1 - 2 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#1 - 2 * paper-ripple#PolymerElements/paper-ripple#1 - 2 * polymer#Polymer/polymer#1.9 - 2

paper-behaviors version 3.0.0-pre.1
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.1 * @polymer/iron-checked-element-behavior#^3.0.0-pre.1 * @polymer/paper-ripple#^3.0.0-pre.1 * @polymer/polymer#^3.0.0-pre.1

paper-behaviors version 2.0.1
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#1 - 2 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#1 - 2 * paper-ripple#PolymerElements/paper-ripple#1 - 2 * polymer#Polymer/polymer#1.9 - 2

paper-behaviors version 3.0.0-pre.2
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.1 * @polymer/iron-checked-element-behavior#^3.0.0-pre.1 * @polymer/paper-ripple#^3.0.0-pre.1 * @polymer/polymer#^3.0.0-pre.1

paper-behaviors version 3.0.0-pre.3
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.3 * @polymer/iron-checked-element-behavior#^3.0.0-pre.3 * @polymer/paper-ripple#^3.0.0-pre.3 * @polymer/polymer#^3.0.0-pre.3

paper-behaviors version 3.0.0-pre.4
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.4 * @polymer/iron-checked-element-behavior#^3.0.0-pre.4 * @polymer/paper-ripple#^3.0.0-pre.4 * @polymer/polymer#^3.0.0-pre.4

paper-behaviors version 3.0.0-pre.6
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.6 * @polymer/iron-checked-element-behavior#^3.0.0-pre.6 * @polymer/paper-ripple#^3.0.0-pre.6 * @polymer/polymer#^3.0.0-pre.6

paper-behaviors version 3.0.0-pre.7
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.7 * @polymer/iron-checked-element-behavior#^3.0.0-pre.7 * @polymer/paper-ripple#^3.0.0-pre.7 * @polymer/polymer#^3.0.0-pre.7

paper-behaviors version 3.0.0-pre.8
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.7 * @polymer/iron-checked-element-behavior#^3.0.0-pre.7 * @polymer/paper-ripple#^3.0.0-pre.7 * @polymer/polymer#^3.0.0-pre.7

paper-behaviors version 3.0.0-pre.10
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.10 * @polymer/iron-checked-element-behavior#^3.0.0-pre.10 * @polymer/paper-ripple#^3.0.0-pre.10 * @polymer/polymer#^3.0.0-pre.10

paper-behaviors version 2.1.0
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#1 - 2 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#1 - 2 * paper-ripple#PolymerElements/paper-ripple#1 - 2 * polymer#Polymer/polymer#1.9 - 2

paper-behaviors version 3.0.0-pre.11
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.10 * @polymer/iron-checked-element-behavior#^3.0.0-pre.10 * @polymer/paper-ripple#^3.0.0-pre.10 * @polymer/polymer#^3.0.0-pre.10

paper-behaviors version 3.0.0-pre.12
### Dependencies * @polymer/iron-behaviors#3.0.0-pre.12 * @polymer/iron-checked-element-behavior#3.0.0-pre.12 * @polymer/paper-ripple#3.0.0-pre.12 * @polymer/polymer#3.0.0-pre.12

paper-behaviors version 2.1.1
### Dependencies * iron-behaviors#PolymerElements/iron-behaviors#1 - 2 * iron-checked-element-behavior#PolymerElements/iron-checked-element-behavior#1 - 2 * paper-ripple#PolymerElements/paper-ripple#1 - 2 * polymer#Polymer/polymer#1.9 - 2

paper-behaviors version 3.0.0-pre.13
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.13 * @polymer/iron-checked-element-behavior#^3.0.0-pre.13 * @polymer/paper-ripple#^3.0.0-pre.13 * @polymer/polymer#^3.0.0-pre.13

paper-behaviors version 3.0.0-pre.14
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.14 * @polymer/iron-checked-element-behavior#^3.0.0-pre.14 * @polymer/paper-ripple#^3.0.0-pre.14 * @polymer/polymer#^3.0.0-pre.13

paper-behaviors version 3.0.0-pre.15
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.15 * @polymer/iron-checked-element-behavior#^3.0.0-pre.15 * @polymer/paper-ripple#^3.0.0-pre.15 * @polymer/polymer#^3.0.0-pre.13

paper-behaviors version 3.0.0-pre.16
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.16 * @polymer/iron-checked-element-behavior#^3.0.0-pre.16 * @polymer/paper-ripple#^3.0.0-pre.16 * @polymer/polymer#^3.0.0-pre.13

paper-behaviors version 3.0.0-pre.17
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.17 * @polymer/iron-checked-element-behavior#^3.0.0-pre.17 * @polymer/paper-ripple#^3.0.0-pre.17 * @polymer/polymer#^3.0.0-pre.13

paper-behaviors version 3.0.0-pre.18
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.18 * @polymer/iron-checked-element-behavior#^3.0.0-pre.18 * @polymer/paper-ripple#^3.0.0-pre.18 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.19
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.19 * @polymer/iron-checked-element-behavior#^3.0.0-pre.19 * @polymer/paper-ripple#^3.0.0-pre.19 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.20
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.20 * @polymer/iron-checked-element-behavior#^3.0.0-pre.20 * @polymer/paper-ripple#^3.0.0-pre.20 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.21
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.21 * @polymer/iron-checked-element-behavior#^3.0.0-pre.21 * @polymer/paper-ripple#^3.0.0-pre.21 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.22
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.20 * @polymer/iron-checked-element-behavior#^3.0.0-pre.20 * @polymer/paper-ripple#^3.0.0-pre.20 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.23
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.20 * @polymer/iron-checked-element-behavior#^3.0.0-pre.20 * @polymer/paper-ripple#^3.0.0-pre.20 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.24
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.22 * @polymer/iron-checked-element-behavior#^3.0.0-pre.22 * @polymer/paper-ripple#^3.0.0-pre.22 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.25
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.22 * @polymer/iron-checked-element-behavior#^3.0.0-pre.22 * @polymer/paper-ripple#^3.0.0-pre.22 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.26
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.24 * @polymer/iron-checked-element-behavior#^3.0.0-pre.24 * @polymer/paper-ripple#^3.0.0-pre.24 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0-pre.27
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.25 * @polymer/iron-checked-element-behavior#^3.0.0-pre.25 * @polymer/paper-ripple#^3.0.0-pre.25 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.0
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.26 * @polymer/iron-checked-element-behavior#^3.0.0-pre.26 * @polymer/paper-ripple#^3.0.0-pre.26 * @polymer/polymer#^3.0.0

paper-behaviors version 3.0.1
### Dependencies * @polymer/iron-behaviors#^3.0.0-pre.26 * @polymer/iron-checked-element-behavior#^3.0.0-pre.26 * @polymer/paper-ripple#^3.0.0-pre.26 * @polymer/polymer#^3.0.0

Directory

paper-behaviors

Author

Rating

Links

Popularity

<paper-behaviors>

Usage

Installation

Example of using one of the behaviours in a Polymer 3 element

Contributing

Installation

Running the demo locally

Running the tests

Links

Compatibility

Version

Dependencies

Compatibility

paper-behaviors - Vaadin Add-on Directory