javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-19 03:32:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs(checkbox): checkbox attribute docs

Browse Source
This commit is contained in:
Drew Rygh
2015-12-01 17:22:32 -06:00
parent 262b883211
commit 8d6ec9efa5
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
ionic/components/checkbox/checkbox.ts
View File

@ -4,10 +4,13 @@ import {Ion} from '../ion';
import {Form} from '../../util/form'; import {Form} from '../../util/form';
/** /**
* The checkbox is no different than the HTML checkbox input, except it's styled differently * The checkbox is no different than the HTML checkbox input, except it's styled differently.
* *
* See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/core/Form-interface.html) for more info on forms and input. * See the [Angular 2 Docs](https://angular.io/docs/js/latest/api/core/Form-interface.html) for more info on forms and input.
* *
* @property [checked] - whether or not the checkbox is checked (defaults to false)
* @property [value] - the value of the checkbox component
*
* @usage * @usage
* ```html * ```html
* <ion-checkbox checked="true" value="isChecked" ng-control="htmlCtrl"> * <ion-checkbox checked="true" value="isChecked" ng-control="htmlCtrl">
@ -66,8 +69,7 @@ export class Checkbox {
} }
/** /**
* Toggle the checked state of the checkbox. Calls onChange to pass the * Toggle the checked state of the checkbox. Calls onChange to pass the updated checked state to the model (Control).
* updated checked state to the model (Control).
*/ */
toggle() { toggle() {
this.checked = !this.checked; this.checked = !this.checked;