Contact us
Get started

Directory

← Back

checkbox

Polymer-based web component for D2L checkboxes

Author

Contributors

Rating

Links

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

d2l-checkbox

Published on webcomponents.org Bower version Build status

Polymer-based web component for D2L checkboxes.

screenshot of checkbox component

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

Installation

d2l-checkbox can be installed from Bower:

bower install d2l-checkbox

Usage

Include the webcomponents.js "lite" polyfill (for browsers who don't natively support web components), then import d2l-checkbox.html:

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

A <d2l-checkbox> custom element can now be used in your application. The label for your checkbox should be placed inside the element:

<d2l-checkbox>Label for checkbox</d2l-checkbox>

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

<d2l-checkbox checked>Checked checkbox</d2l-checkbox>

To hide the label when space is limited, use the aria-label attribute to provide an accessible label:

<d2l-checkbox aria-label="label for checkbox"></d2l-checkbox>

To align following related content below checkboxes, the d2l-checkbox-spacer element can be used.

<d2l-checkbox>Label for checkbox</d2l-checkbox>
<d2l-checkbox-spacer style="color:#999999;">
  Additional content can go here and will<br>
  also line up nicely with the checkbox.
</d2l-checkbox-spacer>

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 lint

To run unit tests locally using Polymer test:

polymer test --skip-plugin sauce

To lint AND run local unit tests:

npm test

Compatibility

(Loading compatibility data...)

Last updated: 2017-10-04

Was this helpful? Need more help?
Leave a comment or a question below. You can also join the chat on Discord or ask questions on StackOverflow.

Version

Dependencies

  • d2l-colors#^3.1.2
  • d2l-typography#^6.0.0
  • polymer#1 - 2
Released
2018-01-30
Maturity
IMPORTED
License
Apache License 2.0

Compatibility

Framework
Polymer 2.0+
Browser
Browser Independent

checkbox - Vaadin Add-on Directory

Polymer-based web component for D2L checkboxes checkbox - Vaadin Add-on Directory
**[ This description is mirrored from README.md at [github.com/BrightspaceUI/checkbox](https://github.com//BrightspaceUI/checkbox/blob/v0.2.1/README.md) on 2019-05-10 ]** # d2l-checkbox [![Published on webcomponents.org](https://img.shields.io/badge/webcomponents.org-published-blue.svg)](https://www.webcomponents.org/element/BrightspaceUI/checkbox) [![Bower version][bower-image]][bower-url] [![Build status][ci-image]][ci-url] [Polymer](https://www.polymer-project.org)-based web component for D2L checkboxes. ![screenshot of checkbox component](/checkbox.gif?raw=true) For further information on this and other Brightspace UI components, see the docs at [ui.developers.brightspace.com](http://ui.developers.brightspace.com/). ## Installation `d2l-checkbox` can be installed from [Bower][bower-url]: ```shell bower install d2l-checkbox ``` ## Usage Include the [webcomponents.js](http://webcomponents.org/polyfills/) "lite" polyfill (for browsers who don't natively support web components), then import `d2l-checkbox.html`: ```html ``` A `` custom element can now be used in your application. The label for your checkbox should be placed inside the element: ```html Label for checkbox ``` Many of the same attributes from native `` are available: ```html Checked checkbox ``` To hide the label when space is limited, use the `aria-label` attribute to provide an accessible label: ```html ``` To align following related content below checkboxes, the `d2l-checkbox-spacer` element can be used. ```html Label for checkbox Additional content can go here and will
also line up nicely with the checkbox. ``` ## 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](https://www.polymer-project.org/2.0/docs/tools/polymer-cli) globally: ```shell npm install -g polymer-cli ``` To start a [local web server](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#serve) that hosts the demo page and tests: ```shell polymer serve ``` To lint ([eslint](http://eslint.org/) and [Polymer lint](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#lint)): ```shell npm run lint ``` To run unit tests locally using [Polymer test](https://www.polymer-project.org/2.0/docs/tools/polymer-cli-commands#tests): ```shell polymer test --skip-plugin sauce ``` To lint AND run local unit tests: ```shell npm test ``` [bower-url]: http://bower.io/search/?q=d2l-checkbox [bower-image]: https://badge.fury.io/bo/d2l-checkbox.svg [ci-url]: https://travis-ci.org/BrightspaceUI/checkbox [ci-image]: https://travis-ci.org/BrightspaceUI/checkbox.svg
Online