javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2026-03-13 10:22:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore(): update to latest stencil

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-08-12 12:04:27 +02:00
parent 149039bd12
commit d856ecfbbf
101 changed files with 1098 additions and 8675 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
core/src/components/menu/readme.md
View File

@@ -13,149 +13,37 @@ These can be controlled from the templates, or programmatically using the MenuCo
## Properties
#### contentId
string
The content's id the menu should use.
#### disabled
boolean
If true, the menu is disabled. Default `false`.
#### maxEdgeStart
number
The edge threshold for dragging the menu open.
If a drag/swipe happens over this value, the menu is not triggered.
#### menuId
string
An id for the menu.
#### side
string
Which side of the view the menu should be placed. Default `"start"`.
#### swipeEnabled
boolean
If true, swiping the menu is enabled. Default `true`.
#### type
string
The display type of the menu.
Available options: `"overlay"`, `"reveal"`, `"push"`.
## Attributes
#### content-id
string
The content's id the menu should use.
#### disabled
boolean
If true, the menu is disabled. Default `false`.
#### max-edge-start
number
The edge threshold for dragging the menu open.
If a drag/swipe happens over this value, the menu is not triggered.
#### menu-id
string
An id for the menu.
#### side
string
Which side of the view the menu should be placed. Default `"start"`.
#### swipe-enabled
boolean
If true, swiping the menu is enabled. Default `true`.
#### type
string
The display type of the menu.
Available options: `"overlay"`, `"reveal"`, `"push"`.
| Property | Attribute | Description | Type |
| -------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------ | --------- |
| `contentId` | `content-id` | The content's id the menu should use. | `string` |
| `disabled` | `disabled` | If true, the menu is disabled. Default `false`. | `boolean` |
| `maxEdgeStart` | `max-edge-start` | The edge threshold for dragging the menu open. If a drag/swipe happens over this value, the menu is not triggered. | `number` |
| `menuId` | `menu-id` | An id for the menu. | `string` |
| `side` | `side` | Which side of the view the menu should be placed. Default `"start"`. | `Side` |
| `swipeEnabled` | `swipe-enabled` | If true, swiping the menu is enabled. Default `true`. | `boolean` |
| `type` | `type` | The display type of the menu. Available options: `"overlay"`, `"reveal"`, `"push"`. | `string` |
## Events
#### ionClose
Emitted when the menu is closed.
#### ionMenuChange
Emitted when the menu state is changed.
#### ionOpen
Emitted when the menu is open.
| Event | Description |
| --------------- | --------------------------------------- |
| `ionClose` | Emitted when the menu is closed. |
| `ionMenuChange` | Emitted when the menu state is changed. |
| `ionOpen` | Emitted when the menu is open. |
## Methods
#### close()
#### getWidth()
#### isActive()
#### isOpen()
#### open()
#### setOpen()
#### toggle()
| Method | Description |
| ---------- | ----------- |
| `close` | |
| `getWidth` | |
| `isActive` | |
| `isOpen` | |
| `open` | |
| `setOpen` | |
| `toggle` | |
----------------------------------------------