docs(components): update menu and breaking changes

This commit is contained in:
Brandy Carney
2018-03-27 16:47:23 -04:00
parent ce5b47ef99
commit 98403fa883
3 changed files with 7 additions and 10 deletions

View File

@ -962,8 +962,8 @@ These have been renamed to the following:
|--------------|--------------------|----------------------------------------------------------------------------------------------------------| |--------------|--------------------|----------------------------------------------------------------------------------------------------------|
| `start` | `slot="secondary"` | Positions element to the `left` of the content in `ios` mode, and directly to the `right` in `md` mode. | | `start` | `slot="secondary"` | Positions element to the `left` of the content in `ios` mode, and directly to the `right` in `md` mode. |
| `end` | `slot="primary"` | Positions element to the `right` of the content in `ios` mode, and to the far `right` in `md` mode. | | `end` | `slot="primary"` | Positions element to the `right` of the content in `ios` mode, and to the far `right` in `md` mode. |
| `left` | `slot="start"` | Positions to the `left` of the button in LTR, and to the `right` in RTL. | | `left` | `slot="start"` | Positions to the `left` of the content in LTR, and to the `right` in RTL. |
| `right` | `slot="end"` | Positions to the `right` of the button in LTR, and to the `left` in RTL. | | `right` | `slot="end"` | Positions to the `right` of the content in LTR, and to the `left` in RTL. |
**Old Usage Example:** **Old Usage Example:**

View File

@ -15,19 +15,18 @@ export class MenuButton {
private custom = true; private custom = true;
@Prop({ context: 'config' }) config: Config;
/** /**
* 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 `left` or `right` for the menu side. This is used to find the correct menu to toggle
*/ */
@Prop() menu: string; @Prop() menu: string;
/** /**
* Automatically hides the content when the corresponding menu is not * Automatically hides the menu button when the corresponding menu is not active
* active
*/ */
@Prop() autoHide = true; @Prop() autoHide = true;
@Prop({ context: 'config' }) config: Config;
@Element() el: HTMLElement; @Element() el: HTMLElement;
componentWillLoad() { componentWillLoad() {

View File

@ -11,8 +11,7 @@
boolean boolean
Automatically hides the content when the corresponding menu is not Automatically hides the menu button when the corresponding menu is not active
active
#### menu #### menu
@ -28,8 +27,7 @@ Optional property that maps to a Menu's `menuId` prop. Can also be `left` or `ri
boolean boolean
Automatically hides the content when the corresponding menu is not Automatically hides the menu button when the corresponding menu is not active
active
#### menu #### menu