@polymer/iron-validatable-behavior

WebJar for @polymer/iron-validatable-behavior

License

License

BSD 3-Clause
Categories

Categories

Data
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

polymer__iron-validatable-behavior
Last Version

Last Version

3.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

@polymer/iron-validatable-behavior
WebJar for @polymer/iron-validatable-behavior
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/PolymerElements/iron-validatable-behavior

Download polymer__iron-validatable-behavior

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/polymer__iron-validatable-behavior/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>polymer__iron-validatable-behavior</artifactId>
    <version>3.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/polymer__iron-validatable-behavior/
implementation 'org.webjars.npm:polymer__iron-validatable-behavior:3.0.1'
// https://jarcasting.com/artifacts/org.webjars.npm/polymer__iron-validatable-behavior/
implementation ("org.webjars.npm:polymer__iron-validatable-behavior:3.0.1")
'org.webjars.npm:polymer__iron-validatable-behavior:jar:3.0.1'
<dependency org="org.webjars.npm" name="polymer__iron-validatable-behavior" rev="3.0.1">
  <artifact name="polymer__iron-validatable-behavior" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='polymer__iron-validatable-behavior', version='3.0.1')
)
libraryDependencies += "org.webjars.npm" % "polymer__iron-validatable-behavior" % "3.0.1"
[org.webjars.npm/polymer__iron-validatable-behavior "3.0.1"]

Dependencies

compile (2)

Group / Artifact Type Version
org.webjars.npm : polymer__iron-meta jar [3.0.0-pre.26,4)
org.webjars.npm : polymer__polymer jar [3.0.0,4)

Project Modules

There are no modules declared in this project.

Published on NPM Build status Published on webcomponents.org

IronValidatableBehavior

Use IronValidatableBehavior to implement an element that validates user input. By using this behaviour, your custom element will get a public validate() method, which will return the validity of the element, and a corresponding invalid attribute, which can be used for styling. Can be used alongside an element implementing the IronValidatableBehavior behaviour.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/iron-validatable-behavior

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import {mixinBehaviors} from '@polymer/polymer/lib/legacy/class.js';
import {IronValidatableBehavior} from '@polymer/iron-validatable-behavior/iron-validatable-behavior.js';

class SampleElement extends mixinBehaviors([IronValidatableBehavior], PolymerElement) {
  static get template() {
    return html`
      <style>
        :host {
          border: 1px solid green;
          color: green;
        }
        :host([invalid]) {
          border: 1px solid red;
          color: red;
        }
      </style>
      <input id="input">
    `;

    // Override this method if you want to implement custom validity
    // for your element. This element is only valid if the value in the
    // input is "cat".
    function _getValidity() {
      return this.$.input.value === 'cat';
    }
  }
}
customElements.define('sample-element', SampleElement);

In an html file using the element

<html>
  <head>
    <script type="module" src="./sample-element.js"></script>
  </head>
  <body>
    <sample-element id="el"></sample-element>
    <button onclick="el.validate()">Validate!</button>
  </body>
</html>

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/iron-validatable-behavior
cd iron-validatable-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
org.webjars.npm

Versions

Version
3.0.1
3.0.0-pre.8
3.0.0-pre.1
3.0.0