search

PolymerElements / gold-phone-input

An input element that only allows phone numbers
https://webcomponents.org/element/PolymerElements/gold-phone-input
13 stars 30 forks source link

readme

Published on NPM Build status Published on webcomponents.org

<gold-phone-input>

<gold-phone-input> is a single-line text field with Material Design styling for entering a phone number.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/gold-phone-input

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/gold-phone-input/gold-phone-input.js';
    </script>
  </head>
  <body>
    <gold-phone-input
        label="France phone number"
        country-code="33"
        phone-number-pattern="X-XX-XX-XX-XX"
        auto-validate>
    </gold-phone-input>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/gold-phone-input/gold-phone-input.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <gold-phone-input
          label="France phone number"
          country-code="33"
          phone-number-pattern="X-XX-XX-XX-XX"
          auto-validate>
      </gold-phone-input>
    `;
  }
}
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/gold-phone-input
cd gold-phone-input
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