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

docs(all): possible values are extracted by stencil (#16190)

Browse Source 
* docs(all): possible values are extracted by stencil

* add defaults

* remove all hardcoded defaults

* update stencil
This commit is contained in:
Manu MA
2018-11-02 00:06:40 +01:00
committed by GitHub
parent 335acf96ee
commit ecc2c55370
151 changed files with 1363 additions and 1430 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
core/src/components/segment-button/readme.md
View File

@ -8,20 +8,20 @@ Segment buttons are groups of related buttons inside of a [Segment](../../segmen
## Properties
| Property | Attribute | Description | Type |
| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `checked` | `checked` | If `true`, the segment button 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). | `string \| undefined` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the segment button. Defaults to `false`. | `boolean` |
| `mode` | `mode` | The mode determines which platform styles to use. Possible values are: `"ios"` or `"md"`. | `"ios" \| "md"` |
| `value` | `value` | The value of the segment button. | `string` |
| Property | Attribute | Description | Type | Default |
| ---------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | --------------------- |
| `checked` | `checked` | If `true`, the segment button is selected. | `boolean` | `false` |
| `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). | `string \| undefined` | `undefined` |
| `disabled` | `disabled` | If `true`, the user cannot interact with the segment button. | `boolean` | `false` |
| `mode` | `mode` | The mode determines which platform styles to use. | `"ios" \| "md"` | `undefined` |
| `value` | `value` | The value of the segment button. | `string` | `'ion-sb-' + (ids++)` |
## Events
| Event | Detail | Description |
| ----------- | ------ | ------------------------------------------- |
| `ionSelect` | | Emitted when the segment button is clicked. |
| Event | Description | Detail |
| ----------- | ------------------------------------------- | ------ |
| `ionSelect` | Emitted when the segment button is clicked. | void |
## CSS Custom Properties

5
core/src/components/segment-button/segment-button.tsx
View File

@ -23,17 +23,16 @@ export class SegmentButton implements ComponentInterface {
/**
* The mode determines which platform styles to use.
* Possible values are: `"ios"` or `"md"`.
*/
@Prop() mode!: Mode;
/**
* If `true`, the segment button is selected. Defaults to `false`.
* If `true`, the segment button is selected.
*/
@Prop({ mutable: true }) checked = false;
/**
* If `true`, the user cannot interact with the segment button. Defaults to `false`.
* If `true`, the user cannot interact with the segment button.
*/
@Prop() disabled = false;