ui/webui/resources/cr_elements/cr_checkbox/cr_checkbox.js

   1 // Copyright 2015 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /**
   6  * @fileoverview
   7  * `cr-checkbox` is a button that can be either checked or unchecked. User
   8  * can tap the checkbox to check or uncheck it. Usually you use checkboxes
   9  * to allow user to select multiple options from a set. If you have a single
  10  * ON/OFF option, avoid using a single checkbox and use `cr-toggle-button`
  11  * instead.
  12  *
  13  * Example:
  14  *     <cr-checkbox></cr-checkbox>
  15  *     <cr-checkbox checked></cr-checkbox>
  16  *
  17  * @element cr-checkbox
  18  */
  19 Polymer({
  20   publish: {
  21     /**
  22      * Gets or sets the state. `true` is checked and `false` is unchecked.
  23      *
  24      * @attribute checked
  25      * @type boolean
  26      * @default false
  27      */
  28     checked: {value: false, reflect: true},
  29
  30     /**
  31      * The label for the checkbox.
  32      *
  33      * @attribute label
  34      * @type string
  35      * @default ''
  36      */
  37     label: '',
  38
  39     /**
  40      * If true, the user cannot interact with this element.
  41      *
  42      * @attribute disabled
  43      * @type boolean
  44      * @default false
  45      */
  46     disabled: {value: false, reflect: true},
  47   },
  48
  49   toggle: function() {
  50     this.$.checkbox.toggle();
  51   },
  52
  53   ready: function() {
  54     this.$.events.forward(this.$.checkbox, ['change']);
  55   },
  56 });