Polymer-based web component for D2L text inputs

[ This description is mirrored from README.md at github.com/BrightspaceUI/text-input on 2019-05-10 ]

d2l-text-input

Published on webcomponents.org Bower version Build status

Polymer-based web component for D2L text inputs.

screenshot of text input component

For further information on this and other Brightspace UI components, see the docs at ui.developers.brightspace.com.

Installation

d2l-text-input can be installed from Bower:

bower install d2l-text-input

Usage

Include the webcomponents.js "lite" polyfill (for browsers who don't natively support web components), then import the component as needed:

<head>
  <script src="../webcomponentsjs/webcomponents-lite.js"></script>
  <link rel="import" href="../d2l-text-input/d2l-text-input.html">
</head>

Then use the <d2l-text-input> custom element in your application.

<d2l-text-input name="myInput" value="input value"></d2l-text-input>

Many of the same attributes from native <input type="text"> are available:

<d2l-text-input disabled></d2l-text-input>

Developing, Testing and Contributing

After cloning the repo, run npm install to install dependencies.

If you don't have it already, install the Polymer CLI globally:

npm install -g polymer-cli

To start a local web server that hosts the demo page and tests:

polymer serve

To lint (eslint and Polymer lint):

npm run test:lint

To run unit tests locally using Polymer test:

npm run test:polymer:local

To lint AND run local unit tests:

npm test

Install

Link to this version
ImportedReleased 30 August 2018Apache License 2.0
Framework Support
Polymer 2.0+
Browser Compatibility
Install with
bower install --save BrightspaceUI/text-input"#0.6.0"
Run the above Bower command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 0.6.0

Dependencies

  • d2l-colors#^3.1.2
  • d2l-polymer-behaviors#>=1.4.0 <2.0
  • d2l-typography#^6.1.2
  • polymer#1 - 2