javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-20 12:29:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix(all): docs for all missing props

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-10-11 16:02:15 -05:00
committed by Manu MA
parent 53305741a0
commit a72fced6fe
119 changed files with 1026 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
core/src/components/toggle/readme.md
View File

@ -11,9 +11,9 @@ Toggles change the state of a single option. Toggles can be switched on or off b
| Property | Attribute | Description | Type |
| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `checked` | `checked` | If true, the toggle is selected. Defaults to `false`. | `boolean` |
| `checked` | `checked` | If `true`, the toggle is selected. Defaults to `false`. | `boolean` |
| `color` | `color` | The color to use from your application's color palette. Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`. For more information on colors, see [theming](/docs/theming/basics). | `Color` |
| `disabled` | `disabled` | | `boolean` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the toggle. Default false. | `boolean` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `Mode` |
| `name` | `name` | The name of the control, which is submitted with the form data. | `string` |
| `value` | `value` | the value of the toggle. | `string` |

18
core/src/components/toggle/toggle.tsx
View File

@ -27,6 +27,12 @@ export class Toggle implements ComponentInterface {
@State() activated = false;
@State() keyFocus = false;
/**
* The mode determines which platform styles to use.
* Possible values are: `"ios"` or `"md"`.
*/
@Prop() mode!: Mode;
/**
* The color to use from your application's color palette.
* Default options are: `"primary"`, `"secondary"`, `"tertiary"`, `"success"`, `"warning"`, `"danger"`, `"light"`, `"medium"`, and `"dark"`.
@ -34,24 +40,18 @@ export class Toggle implements ComponentInterface {
*/
@Prop() color?: Color;
/**
* The mode determines which platform styles to use.
* Possible values are: `"ios"` or `"md"`.
*/
@Prop() mode!: Mode;
/**
* The name of the control, which is submitted with the form data.
*/
@Prop() name: string = this.inputId;
/**
* If true, the toggle is selected. Defaults to `false`.
* If `true`, the toggle is selected. Defaults to `false`.
*/
@Prop({ mutable: true }) checked = false;
/*
* If true, the user cannot interact with the toggle. Default false.
/**
* If `true`, the user cannot interact with the toggle. Default false.
*/
@Prop() disabled = false;