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

fix(all): docs for all missing props

Browse Source
This commit is contained in:
Manu Mtz.-Almeida
2018-10-11 16:02:15 -05:00
committed by Manu MA
parent 53305741a0
commit a72fced6fe
119 changed files with 1026 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
core/src/components/menu-controller/animations/overlay.ts
View File

@@ -4,7 +4,6 @@ import { baseAnimation } from './base';
const BOX_SHADOW_WIDTH = 8;
/**
* @hidden
* Menu Overlay Type
* The menu slides over the content. The content
* itself, which is under the menu, does not move.

1
core/src/components/menu-controller/animations/push.ts
View File

@@ -3,7 +3,6 @@ import { Animation, MenuI } from '../../../interface';
import { baseAnimation } from './base';
/**
* @hidden
* Menu Push Type
* The content slides over to reveal the menu underneath.
* The menu itself also slides over to reveal its bad self.

1
core/src/components/menu-controller/animations/reveal.ts
View File

@@ -3,7 +3,6 @@ import { Animation, MenuI } from '../../../interface';
import { baseAnimation } from './base';
/**
* @hidden
* Menu Reveal Type
* The content slides over to reveal the menu underneath.
* The menu itself, which is under the content, does not move.

13
core/src/components/menu-controller/menu-controller.ts
View File

@@ -90,7 +90,7 @@ export class MenuController implements MenuControllerI {
}
/**
* Returns true if the specified menu is open. If the menu is not specified, it
* Returns `true` if the specified menu is open. If the menu is not specified, it
* will return true if any menu is currently open.
*/
@Method()
@@ -105,7 +105,7 @@ export class MenuController implements MenuControllerI {
}
/**
* Returns true if the specified menu is enabled.
* Returns `true` if the specified menu is enabled.
*/
@Method()
async isEnabled(menuId?: string | null): Promise<boolean> {
@@ -184,7 +184,7 @@ export class MenuController implements MenuControllerI {
}
/**
* Returns true if any menu is currently animating.
* Returns `true` if any menu is currently animating.
*/
@Method()
async isAnimating(): Promise<boolean> {
@@ -192,6 +192,13 @@ export class MenuController implements MenuControllerI {
return this.isAnimatingSync();
}
/**
* Registers a new animation that can be used in any `ion-menu`.
*
* ```
* <ion-menu type="my-animation">
* ```
*/
@Method()
registerAnimation(name: string, animation: AnimationBuilder) {
this.menuAnimations.set(name, animation);

10
core/src/components/menu-controller/readme.md
View File

@@ -87,7 +87,7 @@ Type: `Promise<HTMLIonMenuElement | undefined>`
### `isAnimating() => Promise<boolean>`
Returns true if any menu is currently animating.
Returns `true` if any menu is currently animating.
#### Returns
@@ -97,7 +97,7 @@ Type: `Promise<boolean>`
### `isEnabled(menuId?: string | null | undefined) => Promise<boolean>`
Returns true if the specified menu is enabled.
Returns `true` if the specified menu is enabled.
#### Parameters
@@ -113,7 +113,7 @@ Type: `Promise<boolean>`
### `isOpen(menuId?: string | null | undefined) => Promise<boolean>`
Returns true if the specified menu is open. If the menu is not specified, it
Returns `true` if the specified menu is open. If the menu is not specified, it
will return true if any menu is currently open.
#### Parameters
@@ -146,7 +146,11 @@ Type: `Promise<boolean>`
### `registerAnimation(name: string, animation: AnimationBuilder) => void`
Registers a new animation that can be used in any `ion-menu`.
```
* <ion-menu type="my-animation">
* ```
#### Parameters