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

docs(menu-toggle): default behaviour docs

Browse Source 
fixes #15042
This commit is contained in:
Manu Mtz.-Almeida
2018-08-07 20:23:23 +02:00
parent 2c191d76d3
commit 4e565926cd
10 changed files with 73 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
core/src/components/menu-toggle/menu-toggle.tsx
View File

@ -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;

28
core/src/components/menu-toggle/readme.md
View File

@ -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`.
<!-- Auto Generated Below -->
@ -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.