diff --git a/core/src/components.d.ts b/core/src/components.d.ts index dff7b1edc3..22af47533c 100644 --- a/core/src/components.d.ts +++ b/core/src/components.d.ts @@ -1305,11 +1305,11 @@ declare global { interface IonMenuToggle { /** - * Automatically hides the content when the corresponding menu is not active + * Automatically hides the content when the corresponding menu is not active. By default, it's `true`. Change it to `false` in order to keep `ion-menu-toggle` always visible regardless the state of the menu. */ 'autoHide': boolean; /** - * Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `right` for the menu side. This is used to find the correct menu to toggle + * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle. If this property is not used, `ion-menu-toggle` will toggle the first menu that is active. */ 'menu': string; } @@ -4285,7 +4285,7 @@ declare global { */ 'onIonCancel'?: (event: CustomEvent) => void; /** - * Emitted when the checked property has changed. + * Emitted when the value (selected date) has changed. */ 'onIonChange'?: (event: CustomEvent) => void; /** @@ -4862,11 +4862,11 @@ declare global { export interface IonMenuToggleAttributes extends HTMLAttributes { /** - * Automatically hides the content when the corresponding menu is not active + * Automatically hides the content when the corresponding menu is not active. By default, it's `true`. Change it to `false` in order to keep `ion-menu-toggle` always visible regardless the state of the menu. */ 'autoHide'?: boolean; /** - * Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `right` for the menu side. This is used to find the correct menu to toggle + * Optional property that maps to a Menu's `menuId` prop. Can also be `start` or `end` for the menu side. This is used to find the correct menu to toggle. If this property is not used, `ion-menu-toggle` will toggle the first menu that is active. */ 'menu'?: string; } @@ -5051,6 +5051,9 @@ declare global { export interface IonPickerColumnAttributes extends HTMLAttributes { 'col'?: PickerColumn; + /** + * Emitted when the selected option has changed. + */ 'onIonChange'?: (event: CustomEvent) => void; } diff --git a/core/src/components/chip-icon/readme.md b/core/src/components/chip-icon/readme.md index 82c9425165..b30b8a08e7 100644 --- a/core/src/components/chip-icon/readme.md +++ b/core/src/components/chip-icon/readme.md @@ -32,6 +32,14 @@ The icon to use. Possible values are the same as `"ion-icon"`. +#### src + +string + +The icon src to use. +Possible values are the same as `"ion-icon"`. + + ## Attributes #### color @@ -59,6 +67,14 @@ The icon to use. Possible values are the same as `"ion-icon"`. +#### src + +string + +The icon src to use. +Possible values are the same as `"ion-icon"`. + + ---------------------------------------------- diff --git a/core/src/components/datetime/datetime.tsx b/core/src/components/datetime/datetime.tsx index 053d499e82..1e6cc89158 100644 --- a/core/src/components/datetime/datetime.tsx +++ b/core/src/components/datetime/datetime.tsx @@ -192,7 +192,7 @@ export class Datetime { @Event() ionCancel!: EventEmitter; /** - * Emitted when the checked property has changed. + * Emitted when the value (selected date) has changed. */ @Event() ionChange!: EventEmitter; diff --git a/core/src/components/datetime/readme.md b/core/src/components/datetime/readme.md index 1dedcd4d76..e27ace3bce 100644 --- a/core/src/components/datetime/readme.md +++ b/core/src/components/datetime/readme.md @@ -571,6 +571,11 @@ recent leap years, then this input's value would be `yearValues="2024,2020,2016, Emitted when the datetime selection was cancelled. +#### ionChange + +Emitted when the value (selected date) has changed. + + #### ionStyle Emitted when the styles change. diff --git a/core/src/components/menu-toggle/menu-toggle.tsx b/core/src/components/menu-toggle/menu-toggle.tsx index 06b34b5925..fc317e5c85 100644 --- a/core/src/components/menu-toggle/menu-toggle.tsx +++ b/core/src/components/menu-toggle/menu-toggle.tsx @@ -13,13 +13,19 @@ export class MenuToggle { /** * Optional property that maps to a Menu's `menuId` prop. - * Can also be `left` or `right` for the menu side. - * This is used to find the correct menu to toggle + * Can also be `start` or `end` for the menu side. + * This is used to find the correct menu to toggle. + * + * If this property is not used, `ion-menu-toggle` will toggle the + * first menu that is active. */ @Prop() menu?: string; /** - * Automatically hides the content when the corresponding menu is not active + * Automatically hides the content when the corresponding menu is not active. + * + * By default, it's `true`. Change it to `false` in order to + * keep `ion-menu-toggle` always visible regardless the state of the menu. */ @Prop() autoHide = true; diff --git a/core/src/components/menu-toggle/readme.md b/core/src/components/menu-toggle/readme.md index e4ea9be170..ef6876d0d3 100644 --- a/core/src/components/menu-toggle/readme.md +++ b/core/src/components/menu-toggle/readme.md @@ -1,6 +1,10 @@ # ion-menu-toggle + The MenuToggle component can be used to toggle a menu open or closed. +By default, it's only visible when the selected menu is active. A menu is active when it can be opened/closed. If the menu is disabled or it's being presented as a split-pane, the menu is marked as non-active and ion-menu-toggle hides itself. + +In case it's desired to keep `ion-menu-toggle` always visible, the `autoHide` property can be set to `false`. @@ -11,7 +15,10 @@ The MenuToggle component can be used to toggle a menu open or closed. boolean -Automatically hides the content when the corresponding menu is not active +Automatically hides the content when the corresponding menu is not active. + +By default, it's `true`. Change it to `false` in order to +keep `ion-menu-toggle` always visible regardless the state of the menu. #### menu @@ -19,8 +26,11 @@ Automatically hides the content when the corresponding menu is not active string Optional property that maps to a Menu's `menuId` prop. -Can also be `left` or `right` for the menu side. -This is used to find the correct menu to toggle +Can also be `start` or `end` for the menu side. +This is used to find the correct menu to toggle. + +If this property is not used, `ion-menu-toggle` will toggle the +first menu that is active. ## Attributes @@ -29,7 +39,10 @@ This is used to find the correct menu to toggle boolean -Automatically hides the content when the corresponding menu is not active +Automatically hides the content when the corresponding menu is not active. + +By default, it's `true`. Change it to `false` in order to +keep `ion-menu-toggle` always visible regardless the state of the menu. #### menu @@ -37,8 +50,11 @@ Automatically hides the content when the corresponding menu is not active string Optional property that maps to a Menu's `menuId` prop. -Can also be `left` or `right` for the menu side. -This is used to find the correct menu to toggle +Can also be `start` or `end` for the menu side. +This is used to find the correct menu to toggle. + +If this property is not used, `ion-menu-toggle` will toggle the +first menu that is active. diff --git a/core/src/components/picker-column/picker-column.tsx b/core/src/components/picker-column/picker-column.tsx index 2ed9718750..a82eaf586a 100644 --- a/core/src/components/picker-column/picker-column.tsx +++ b/core/src/components/picker-column/picker-column.tsx @@ -30,6 +30,9 @@ export class PickerColumnCmp { @Prop() col!: PickerColumn; + /** + * Emitted when the selected option has changed. + */ @Event() ionChange!: EventEmitter; componentWillLoad() { diff --git a/core/src/components/picker-column/readme.md b/core/src/components/picker-column/readme.md index 88cfd3525a..0970809833 100644 --- a/core/src/components/picker-column/readme.md +++ b/core/src/components/picker-column/readme.md @@ -19,6 +19,13 @@ PickerColumn +## Events + +#### ionChange + +Emitted when the selected option has changed. + + ---------------------------------------------- diff --git a/core/src/components/picker/readme.md b/core/src/components/picker/readme.md index 28c8c8c2c9..263385eac6 100644 --- a/core/src/components/picker/readme.md +++ b/core/src/components/picker/readme.md @@ -197,16 +197,6 @@ Emitted before the picker has presented. ## Methods -#### addButton() - -Add a new PickerButton to the picker - - -#### addColumn() - -Add a new PickerColumn to the picker - - #### dismiss() Dismiss the picker overlay after it has been presented. @@ -217,11 +207,6 @@ Dismiss the picker overlay after it has been presented. Returns the column the matches the specified name -#### getColumns() - -Returns all the PickerColumns - - #### onDidDismiss() Returns a promise that resolves when the picker did dismiss. It also accepts a callback diff --git a/core/src/components/range/readme.md b/core/src/components/range/readme.md index 2c7fd4e000..fbbd00d6ab 100644 --- a/core/src/components/range/readme.md +++ b/core/src/components/range/readme.md @@ -102,7 +102,7 @@ Specifies the value granularity. Defaults to `1`. #### value -any +number the value of the range. @@ -194,7 +194,7 @@ Specifies the value granularity. Defaults to `1`. #### value -any +number the value of the range.