# @polymer/iron-input > An input element with data binding Latest version **3.0.1** (published 2018-09-14) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install @polymer/iron-input pnpm add @polymer/iron-input yarn add @polymer/iron-input bun add @polymer/iron-input ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.0.1 | | Published | 2018-09-14 | | First published | 2016-02-02 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 30.2 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 31 | | Author | The Polymer Authors | | Maintainers | aomarks, azakus, bicknellr, emarquez, justinfagnani, keanulee, notwaldorf, polymer-devs, samli, sorvell, usergenic | | Keywords | web-components, polymer, input | ## Links - npm: https://www.npmjs.com/package/@polymer/iron-input - Repository: https://github.com/PolymerElements/iron-input - Issues: https://github.com/PolymerElements/iron-input/issues - npm.io page: https://npm.io/package/@polymer/iron-input ## Dependencies (3) - [@polymer/polymer](https://npm.io/package/@polymer/polymer.md) ^3.0.0 - [@polymer/iron-a11y-announcer](https://npm.io/package/@polymer/iron-a11y-announcer.md) ^3.0.0-pre.26 - [@polymer/iron-validatable-behavior](https://npm.io/package/@polymer/iron-validatable-behavior.md) ^3.0.0-pre.26 ## Recent versions - 3.0.1 (latest) — 2018-09-14 - 3.0.0-pre.20 (next) — 2018-06-23 - 1.0.10-pre.3 (preview) — 2017-01-24 - 3.0.0 — 2018-09-13 - 3.0.0-pre.26 — 2018-09-12 - 3.0.0-pre.25 — 2018-08-29 - 3.0.0-pre.24 — 2018-08-29 - 3.0.0-pre.23 — 2018-08-25 - 3.0.0-pre.22 — 2018-08-25 - 3.0.0-pre.21 — 2018-06-23 - 3.0.0-pre.19 — 2018-05-09 - 3.0.0-pre.18 — 2018-05-09 - 3.0.0-pre.17 — 2018-05-08 - 3.0.0-pre.16 — 2018-05-04 - 3.0.0-pre.15 — 2018-05-02 - … 17 more at https://npm.io/package/@polymer/iron-input/versions ## README [![Published on NPM](https://img.shields.io/npm/v/@polymer/iron-input.svg)](https://www.npmjs.com/package/@polymer/iron-input) [![Build status](https://travis-ci.org/PolymerElements/iron-input.svg?branch=master)](https://travis-ci.org/PolymerElements/iron-input) [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://webcomponents.org/element/@polymer/iron-input) ## <iron-input> `` adds two-way binding and custom validators using `Polymer.IronValidatorBehavior` to ``. See: [Documentation](https://www.webcomponents.org/element/@polymer/iron-input), [Demo](https://www.webcomponents.org/element/@polymer/iron-input/demo/demo/index.html). ## Usage ### Installation ``` npm install --save @polymer/iron-input ``` ### In an html file ```html ``` ### In a Polymer 3 element ```js import {PolymerElement, html} from '@polymer/polymer'; import '@polymer/iron-input/iron-input.js'; class SampleElement extends PolymerElement { static get template() { return html` `; } } customElements.define('sample-element', SampleElement); ``` ### Two-way binding By default you can only get notified of changes to an `input`'s `value` due to user input: ```html ``` `iron-input` adds the `bind-value` property that mirrors the `value` property, and can be used for two-way data binding. `bind-value` will notify if it is changed either by user input or by script. ```html ``` ### Custom validators You can use custom validators that implement `Polymer.IronValidatorBehavior` with ``. ```html ``` ### Stopping invalid input It may be desirable to only allow users to enter certain characters. You can use the `prevent-invalid-input` and `allowed-pattern` attributes together to accomplish this. This feature is separate from validation, and `allowed-pattern` does not affect how the input is validated. ```html ``` ## 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/iron-input cd iron-input 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 ``` --- _Source: https://npm.io/package/@polymer/iron-input · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._