From 7faa04ed31132cdcf01aed883b7bbac905f965d5 Mon Sep 17 00:00:00 2001 From: Brandy Carney Date: Fri, 2 Feb 2018 14:46:11 -0500 Subject: [PATCH] docs(components): update disabled property docs to be consistent --- packages/core/src/components/button/button.tsx | 2 +- packages/core/src/components/button/readme.md | 4 ++-- packages/core/src/components/checkbox/checkbox.tsx | 2 +- packages/core/src/components/checkbox/readme.md | 4 ++-- .../core/src/components/chip-button/chip-button.tsx | 2 +- packages/core/src/components/chip-button/readme.md | 4 ++-- packages/core/src/components/fab-button/fab-button.tsx | 2 +- packages/core/src/components/fab-button/readme.md | 4 ++-- .../src/components/infinite-scroll/infinite-scroll.tsx | 5 ++--- packages/core/src/components/infinite-scroll/readme.md | 10 ++++------ packages/core/src/components/input/input-base.tsx | 1 - .../core/src/components/item-option/item-option.tsx | 2 +- packages/core/src/components/item-option/readme.md | 4 ++-- packages/core/src/components/radio/radio.tsx | 2 +- packages/core/src/components/range/range.tsx | 2 +- packages/core/src/components/refresher/readme.md | 4 ++-- packages/core/src/components/refresher/refresher.tsx | 2 +- packages/core/src/components/reorder-group/readme.md | 4 ++++ .../src/components/reorder-group/reorder-group.tsx | 3 +++ packages/core/src/components/segment/segment.tsx | 4 ++-- packages/core/src/components/select-option/readme.md | 4 ++-- .../src/components/select-option/select-option.tsx | 2 +- packages/core/src/components/split-pane/readme.md | 6 ++---- packages/core/src/components/split-pane/split-pane.tsx | 3 +-- packages/core/src/components/tab/readme.md | 8 ++------ packages/core/src/components/tab/tab.tsx | 4 +--- 26 files changed, 44 insertions(+), 50 deletions(-) diff --git a/packages/core/src/components/button/button.tsx b/packages/core/src/components/button/button.tsx index 9d339e2e17..a988b9a2e7 100644 --- a/packages/core/src/components/button/button.tsx +++ b/packages/core/src/components/button/button.tsx @@ -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; diff --git a/packages/core/src/components/button/readme.md b/packages/core/src/components/button/readme.md index 32242281d9..1a6664c63b 100644 --- a/packages/core/src/components/button/readme.md +++ b/packages/core/src/components/button/readme.md @@ -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 diff --git a/packages/core/src/components/checkbox/checkbox.tsx b/packages/core/src/components/checkbox/checkbox.tsx index 15fecb5e13..bd54055abf 100644 --- a/packages/core/src/components/checkbox/checkbox.tsx +++ b/packages/core/src/components/checkbox/checkbox.tsx @@ -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; diff --git a/packages/core/src/components/checkbox/readme.md b/packages/core/src/components/checkbox/readme.md index 9409e9f0df..b214a70374 100644 --- a/packages/core/src/components/checkbox/readme.md +++ b/packages/core/src/components/checkbox/readme.md @@ -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 diff --git a/packages/core/src/components/chip-button/chip-button.tsx b/packages/core/src/components/chip-button/chip-button.tsx index 2173fefea0..c730d9e4aa 100644 --- a/packages/core/src/components/chip-button/chip-button.tsx +++ b/packages/core/src/components/chip-button/chip-button.tsx @@ -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; diff --git a/packages/core/src/components/chip-button/readme.md b/packages/core/src/components/chip-button/readme.md index 8ee1726990..25c3e00c30 100644 --- a/packages/core/src/components/chip-button/readme.md +++ b/packages/core/src/components/chip-button/readme.md @@ -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 diff --git a/packages/core/src/components/fab-button/fab-button.tsx b/packages/core/src/components/fab-button/fab-button.tsx index 72b221960d..2c72529936 100755 --- a/packages/core/src/components/fab-button/fab-button.tsx +++ b/packages/core/src/components/fab-button/fab-button.tsx @@ -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; diff --git a/packages/core/src/components/fab-button/readme.md b/packages/core/src/components/fab-button/readme.md index 74209ac697..0dbb7d4c40 100644 --- a/packages/core/src/components/fab-button/readme.md +++ b/packages/core/src/components/fab-button/readme.md @@ -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 diff --git a/packages/core/src/components/infinite-scroll/infinite-scroll.tsx b/packages/core/src/components/infinite-scroll/infinite-scroll.tsx index f989730d71..1e7df61a98 100644 --- a/packages/core/src/components/infinite-scroll/infinite-scroll.tsx +++ b/packages/core/src/components/infinite-scroll/infinite-scroll.tsx @@ -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 diff --git a/packages/core/src/components/infinite-scroll/readme.md b/packages/core/src/components/infinite-scroll/readme.md index 97ce2cdacf..2a6e2b81c0 100644 --- a/packages/core/src/components/infinite-scroll/readme.md +++ b/packages/core/src/components/infinite-scroll/readme.md @@ -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 diff --git a/packages/core/src/components/input/input-base.tsx b/packages/core/src/components/input/input-base.tsx index 0c8933f332..797b10213f 100644 --- a/packages/core/src/components/input/input-base.tsx +++ b/packages/core/src/components/input/input-base.tsx @@ -38,7 +38,6 @@ export interface InputComponent extends InputBaseComponent { // Input Attributes accept: string; autocorrect: string; - inputmode: string; min: string; max: string; multiple: boolean; diff --git a/packages/core/src/components/item-option/item-option.tsx b/packages/core/src/components/item-option/item-option.tsx index 720570e325..de382e3fa7 100644 --- a/packages/core/src/components/item-option/item-option.tsx +++ b/packages/core/src/components/item-option/item-option.tsx @@ -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; diff --git a/packages/core/src/components/item-option/readme.md b/packages/core/src/components/item-option/readme.md index 9da5f42318..b355017385 100644 --- a/packages/core/src/components/item-option/readme.md +++ b/packages/core/src/components/item-option/readme.md @@ -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 diff --git a/packages/core/src/components/radio/radio.tsx b/packages/core/src/components/radio/radio.tsx index ad94a93f55..630db32911 100644 --- a/packages/core/src/components/radio/radio.tsx +++ b/packages/core/src/components/radio/radio.tsx @@ -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; diff --git a/packages/core/src/components/range/range.tsx b/packages/core/src/components/range/range.tsx index ae1ec00fa5..143252f9a4 100644 --- a/packages/core/src/components/range/range.tsx +++ b/packages/core/src/components/range/range.tsx @@ -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; diff --git a/packages/core/src/components/refresher/readme.md b/packages/core/src/components/refresher/readme.md index 367e5a2875..1eafa71a03 100644 --- a/packages/core/src/components/refresher/readme.md +++ b/packages/core/src/components/refresher/readme.md @@ -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 diff --git a/packages/core/src/components/refresher/refresher.tsx b/packages/core/src/components/refresher/refresher.tsx index d3506b3cc4..ed572c067e 100644 --- a/packages/core/src/components/refresher/refresher.tsx +++ b/packages/core/src/components/refresher/refresher.tsx @@ -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; diff --git a/packages/core/src/components/reorder-group/readme.md b/packages/core/src/components/reorder-group/readme.md index dbc38ef2cf..851d707310 100644 --- a/packages/core/src/components/reorder-group/readme.md +++ b/packages/core/src/components/reorder-group/readme.md @@ -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`. + ---------------------------------------------- diff --git a/packages/core/src/components/reorder-group/reorder-group.tsx b/packages/core/src/components/reorder-group/reorder-group.tsx index 118c1f6338..7716c062be 100644 --- a/packages/core/src/components/reorder-group/reorder-group.tsx +++ b/packages/core/src/components/reorder-group/reorder-group.tsx @@ -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') diff --git a/packages/core/src/components/segment/segment.tsx b/packages/core/src/components/segment/segment.tsx index e8389803b8..41fbaee7a3 100644 --- a/packages/core/src/components/segment/segment.tsx +++ b/packages/core/src/components/segment/segment.tsx @@ -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. diff --git a/packages/core/src/components/select-option/readme.md b/packages/core/src/components/select-option/readme.md index d5c70d13c4..ebc27d0a98 100644 --- a/packages/core/src/components/select-option/readme.md +++ b/packages/core/src/components/select-option/readme.md @@ -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 diff --git a/packages/core/src/components/select-option/select-option.tsx b/packages/core/src/components/select-option/select-option.tsx index a7898a135e..e6e486cc6c 100644 --- a/packages/core/src/components/select-option/select-option.tsx +++ b/packages/core/src/components/select-option/select-option.tsx @@ -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; diff --git a/packages/core/src/components/split-pane/readme.md b/packages/core/src/components/split-pane/readme.md index 256489cdc7..57bcdfa92e 100644 --- a/packages/core/src/components/split-pane/readme.md +++ b/packages/core/src/components/split-pane/readme.md @@ -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 diff --git a/packages/core/src/components/split-pane/split-pane.tsx b/packages/core/src/components/split-pane/split-pane.tsx index 70ebc88ae5..21172ee23e 100644 --- a/packages/core/src/components/split-pane/split-pane.tsx +++ b/packages/core/src/components/split-pane/split-pane.tsx @@ -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; diff --git a/packages/core/src/components/tab/readme.md b/packages/core/src/components/tab/readme.md index 519ede9f96..c80f16ae3a 100644 --- a/packages/core/src/components/tab/readme.md +++ b/packages/core/src/components/tab/readme.md @@ -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 diff --git a/packages/core/src/components/tab/tab.tsx b/packages/core/src/components/tab/tab.tsx index 469f1b2d1c..6c80c4a17f 100644 --- a/packages/core/src/components/tab/tab.tsx +++ b/packages/core/src/components/tab/tab.tsx @@ -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;