A version of the <label> element that works with Custom Elements as well as native elements.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Update `.github/CODEOWNERS` Aug 23, 2018
demo
test fix tests Jul 12, 2018
.gitignore Tedium automated v3 element updates. Aug 16, 2018
.npmignore Tedium automated v3 element updates. Aug 16, 2018
.travis.yml
CONTRIBUTING.md [skip ci] Update contribution guide May 17, 2016
README.md update readme Jul 12, 2018
bower.json Add `bower.json` so that webcomponents.org can read the repo. Sep 14, 2018
formatconfig.json
iron-label.js run npm format Jul 12, 2018
manifest.json auto-converted by polymer-modulizer Jun 23, 2018
package-lock.json 3.0.1 Sep 14, 2018
package.json 3.0.1 Sep 14, 2018
wct.conf.json Update WCT config Jun 5, 2018

README.md

Published on NPM Build status Published on webcomponents.org

<iron-label>

<iron-label> provides a version of the <label> element that works with Custom Elements as well as native elements. All text in the iron-label will be applied to the target element as a screen-reader accessible description.

See: Documentation, Demo.

Usage

Installation

npm install --save @polymer/iron-label

In an html file

<html>
  <head>
    <script type="module">
      import '@polymer/iron-label/iron-label.js';
      import '@polymer/paper-button/paper-button.js';
    </script>
  </head>
  <body>
    <iron-label>Label for a button
      <paper-button>button</paper-button>
    </iron-label>

    <iron-label for="foo">Label for the foo button</iron-label>
    <paper-button id="foo">Another button</paper-button>
  </body>
</html>

In a Polymer 3 element

import {PolymerElement, html} from '@polymer/polymer';
import '@polymer/iron-label/iron-label.js';
import '@polymer/paper-button/paper-button.js';

class SampleElement extends PolymerElement {
  static get template() {
    return html`
      <iron-label>Label for a button
        <paper-button>button</paper-button>
      </iron-label>

      <iron-label for="foo">Label for the foo button</iron-label>
      <paper-button id="foo">Another button</paper-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

git clone https://github.com/PolymerElements/iron-label
cd iron-label
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