https://github.com/startpolymer/s-checkbox
Up-to-date fork of Material Design checkbox <paper-checkbox> with new features.
https://github.com/startpolymer/s-checkbox
Last synced: 4 months ago
JSON representation
Up-to-date fork of Material Design checkbox <paper-checkbox> with new features.
- Host: GitHub
- URL: https://github.com/startpolymer/s-checkbox
- Owner: StartPolymer
- Created: 2017-01-24T23:29:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-01-30T09:17:27.000Z (over 9 years ago)
- Last Synced: 2025-03-11T21:09:15.067Z (over 1 year ago)
- Language: HTML
- Homepage: https://material.io/guidelines/components/selection-controls.html#selection-controls-checkbox
- Size: 155 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
[![Published on webcomponents.org][webcomponents-image]][webcomponents-url]
## \
`s-checkbox` is a [material design checkbox](https://material.io/guidelines/components/selection-controls.html#selection-controls-checkbox).
User can tap the checkbox to check or uncheck it. Usually you use checkboxes
to allow user to select multiple options from a set. If you have a single
ON/OFF option, avoid using a single checkbox and use `paper-toggle-button`
instead.
`s-checkbox` is up-to-date fork of [`paper-checkbox`](https://github.com/PolymerElements/paper-checkbox).
## New Features
- [Fix colors by Material Design](https://github.com/StartPolymer/s-checkbox/commit/6e5241b43786071277cc7a13eee7a5c91f1a238d)
- [Support for custom prefix element](https://github.com/StartPolymer/s-checkbox/commit/710c8b946738c9b9042e43b6844e940d6e8e0429), which is displayed before the checkbox itself. From `paper-input` element.
## Demo
[Full demo][webcomponents-demo]
## Usage
```html
Checked
•
With prefix
Checkbox
With a longer label
Disabled
```
## Installation
`bower i s-checkbox -S`
## Install the Polymer-CLI
First, make sure you have the [Polymer CLI](https://www.npmjs.com/package/polymer-cli) installed. Then run `polymer serve` to serve your application locally.
## Viewing Your Application
```
$ polymer serve
```
## Building Your Application
```
$ polymer build
```
This will create a `build/` folder with `bundled/` and `unbundled/` sub-folders
containing a bundled (Vulcanized) and unbundled builds, both run through HTML,
CSS, and JS optimizers.
You can serve the built versions by giving `polymer serve` a folder to serve
from:
```
$ polymer serve build/bundled
```
## Running Tests
```
$ polymer test
```
Your application is already set up to be tested via [web-component-tester](https://github.com/Polymer/web-component-tester). Run `polymer test` to run your application's test suite locally.
## License
MIT: [StartPolymer/license](https://github.com/StartPolymer/license)
[webcomponents-image]: https://img.shields.io/badge/webcomponents.org-published-blue.svg
[webcomponents-url]: https://beta.webcomponents.org/element/StartPolymer/s-checkbox
[webcomponents-demo]: https://beta.webcomponents.org/element/StartPolymer/s-checkbox/demo/demo/index.html