A version of the element that works with Custom Elements as well as native elements.

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

Install

Link to this version
ImportedReleased 14 September 2018BSD 3-clause "New" or "Revised" License
Framework Support
Polymer 3.0+
Also supported:
Polymer 1 (1.0.2)Polymer 2 (2.1.0)
Browser Independent
Install with
npm install @polymer/iron-label"@3.0.1"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 3.0.1

Dependencies

  • @polymer/polymer#^3.0.0