docs(components): update disabled property docs to be consistent

This commit is contained in:
Brandy Carney
2018-02-02 14:46:11 -05:00
parent 58952d3c12
commit 7faa04ed31
26 changed files with 44 additions and 50 deletions

View File

@ -34,7 +34,7 @@ export class Button {
@Prop() size: 'small' | 'default' | 'large';
/**
* If true, sets the button into a disabled state.
* If true, the user cannot interact with the button. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -99,7 +99,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the button. Defaults to `false`.
#### expand
@ -181,7 +181,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the button. Defaults to `false`.
#### expand

View File

@ -43,7 +43,7 @@ export class Checkbox implements CheckboxInput {
@Prop({ mutable: true }) checked = false;
/**
* If true, the user cannot interact with the checkbox. Default false.
* If true, the user cannot interact with the checkbox. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -64,7 +64,7 @@ Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"da
boolean
If true, the user cannot interact with the checkbox. Default false.
If true, the user cannot interact with the checkbox. Defaults to `false`.
#### mode
@ -110,7 +110,7 @@ Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"da
boolean
If true, the user cannot interact with the checkbox. Default false.
If true, the user cannot interact with the checkbox. Defaults to `false`.
#### mode

View File

@ -25,7 +25,7 @@ export class ChipButton {
@Prop() mode: 'ios' | 'md';
/**
* If true, sets the button into a disabled state.
* If true, the user cannot interact with the chip button. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -50,7 +50,7 @@ Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"da
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the chip button. Defaults to `false`.
#### fill
@ -90,7 +90,7 @@ Default options are: `"primary"`, `"secondary"`, `"danger"`, `"light"`, and `"da
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the chip button. Defaults to `false`.
#### fill

View File

@ -47,7 +47,7 @@ export class FabButton {
@State() private inList = false;
/**
* If true, sets the button into a disabled state.
* If true, the user cannot interact with the fab button. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -56,7 +56,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the fab button. Defaults to `false`.
#### href
@ -114,7 +114,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the fab button. Defaults to `false`.
#### href

View File

@ -52,9 +52,8 @@ export class InfiniteScroll {
/**
* If true, whether or not the infinite scroll should be
* disabled or not. Setting to `true` will remove scroll event listeners
* and hide the display.
* If true, the infinite scroll will be hidden and scroll event listeners
* will be removed.
*
* Call `enable(false)` to disable the infinite scroll from actively
* trying to receive new data while scrolling. This method is useful

View File

@ -139,9 +139,8 @@ You could replace our default content with custom SVG or CSS animations.
boolean
If true, whether or not the infinite scroll should be
disabled or not. Setting to `true` will remove scroll event listeners
and hide the display.
If true, the infinite scroll will be hidden and scroll event listeners
will be removed.
Call `enable(false)` to disable the infinite scroll from actively
trying to receive new data while scrolling. This method is useful
@ -178,9 +177,8 @@ Defaults to `15%`.
boolean
If true, whether or not the infinite scroll should be
disabled or not. Setting to `true` will remove scroll event listeners
and hide the display.
If true, the infinite scroll will be hidden and scroll event listeners
will be removed.
Call `enable(false)` to disable the infinite scroll from actively
trying to receive new data while scrolling. This method is useful

View File

@ -38,7 +38,6 @@ export interface InputComponent extends InputBaseComponent {
// Input Attributes
accept: string;
autocorrect: string;
inputmode: string;
min: string;
max: string;
multiple: boolean;

View File

@ -29,7 +29,7 @@ export class ItemOption {
@Prop() href: string;
/**
* If true, sets the button into a disabled state.
* If true, the user cannot interact with the item option. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -23,7 +23,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the item option. Defaults to `false`.
#### href
@ -58,7 +58,7 @@ For more information, see [Theming your App](/docs/theming/theming-your-app).
boolean
If true, sets the button into a disabled state.
If true, the user cannot interact with the item option. Defaults to `false`.
#### href

View File

@ -43,7 +43,7 @@ export class Radio implements RadioButtonInput, ComponentDidLoad, ComponentDidUn
@Prop() name: string;
/*
* If true, the user cannot interact with the radio. Default false.
* If true, the user cannot interact with the radio. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -85,7 +85,7 @@ export class Range implements BaseInputComponent {
}
/*
* If true, the user cannot interact with the range. Default false.
* If true, the user cannot interact with the range. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -35,7 +35,7 @@ Time it takes to close the refresher. Defaults to `280ms`.
boolean
If the refresher is disabled or not. Defaults to `true`.
If true, the refresher will be hidden. Defaults to `true`.
#### pullMax
@ -75,7 +75,7 @@ Time it takes to close the refresher. Defaults to `280ms`.
boolean
If the refresher is disabled or not. Defaults to `true`.
If true, the refresher will be hidden. Defaults to `true`.
#### pull-max

View File

@ -67,7 +67,7 @@ export class Refresher {
@Prop() snapbackDuration = '280ms';
/**
* If the refresher is disabled or not. Defaults to `true`.
* If true, the refresher will be hidden. Defaults to `true`.
*/
@Prop() disabled = true;

View File

@ -125,6 +125,8 @@ Alternatevely you can execute helper function inside template:
boolean
If true, the reorder will be hidden. Defaults to `true`.
## Attributes
@ -132,6 +134,8 @@ boolean
boolean
If true, the reorder will be hidden. Defaults to `true`.
----------------------------------------------

View File

@ -47,6 +47,9 @@ export class ReorderGroup {
@Prop({ context: 'dom' }) dom: DomController;
/**
* If true, the reorder will be hidden. Defaults to `true`.
*/
@Prop() disabled = true;
@Watch('disabled')

View File

@ -35,9 +35,9 @@ export class Segment {
@Prop() mode: 'ios' | 'md';
/*
* If true, the user cannot interact with the segment. Default false.
* If true, the user cannot interact with the segment. Defaults to `false`.
*/
@Prop({ mutable: true }) disabled = false;
@Prop() disabled = false;
/**
* the value of the segment.

View File

@ -11,7 +11,7 @@
boolean
If true, the user cannot interact with the select option.
If true, the user cannot interact with the select option. Defaults to `false`.
#### selected
@ -34,7 +34,7 @@ The text value of the option.
boolean
If true, the user cannot interact with the select option.
If true, the user cannot interact with the select option. Defaults to `false`.
#### selected

View File

@ -13,7 +13,7 @@ export class SelectOption {
@Element() el: HTMLElement;
/**
* If true, the user cannot interact with the select option.
* If true, the user cannot interact with the select option. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -119,8 +119,7 @@ SplitPane also provides some predefined media queries that can be used.
boolean
If `false`, the split-pane is disabled, ie. the side pane will
never be displayed. Default `true`.
If true, the split pane will be hidden. Defaults to `false`.
#### when
@ -138,8 +137,7 @@ Can also be a boolean expression.
boolean
If `false`, the split-pane is disabled, ie. the side pane will
never be displayed. Default `true`.
If true, the split pane will be hidden. Defaults to `false`.
#### when

View File

@ -30,8 +30,7 @@ export class SplitPane {
@State() private visible = false;
/**
* If `false`, the split-pane is disabled, ie. the side pane will
* never be displayed. Default `true`.
* If true, the split pane will be hidden. Defaults to `false`.
*/
@Prop() disabled = false;

View File

@ -75,9 +75,7 @@ Set the root page for this tab.
boolean
If true, enable the tab. If false,
the user cannot interact with this element.
Default: `true`.
If true, the user cannot interact with the tab. Defaults to `false`.
#### icon
@ -148,9 +146,7 @@ Set the root page for this tab.
boolean
If true, enable the tab. If false,
the user cannot interact with this element.
Default: `true`.
If true, the user cannot interact with the tab. Defaults to `false`.
#### icon

View File

@ -43,9 +43,7 @@ export class Tab {
@Prop() badgeStyle = 'default';
/**
* If true, enable the tab. If false,
* the user cannot interact with this element.
* Default: `true`.
* If true, the user cannot interact with the tab. Defaults to `false`.
*/
@Prop() disabled = false;