javascript/ionic-framework
1
0
Fork 0
mirror of https://github.com/ionic-team/ionic-framework.git synced 2025-08-19 03:32:21 +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

23
core/src/components/nav/nav.tsx
View File

@ -31,8 +31,11 @@ export class Nav implements NavOutlet {
@Prop({ context: 'window' }) win!: Window;
@Prop({ connect: 'ion-animation-controller' }) animationCtrl!: HTMLIonAnimationControllerElement;
/** @internal */
@Prop() delegate?: FrameworkDelegate;
/**
* If the nav component should allow for swipe-to-go-back
* If the nav component should allow for swipe-to-go-back.
*/
@Prop({ mutable: true }) swipeGesture?: boolean;
@Watch('swipeGesture')
@ -43,13 +46,15 @@ export class Nav implements NavOutlet {
}
/**
* If the nav should animate the components or not
* If `true`, the nav should animate the transition of components. Default to `true`.
*/
@Prop() animated = true;
@Prop() animation?: AnimationBuilder;
/** @hidden */
@Prop() delegate?: FrameworkDelegate;
/**
* By default `ion-nav` animates transition between pages based in the mode (ios or material design).
* However, this property allows to create custom transition using `AnimateBuilder` functions.
*/
@Prop() animation?: AnimationBuilder;
/**
* Any parameters for the root component
@ -321,7 +326,7 @@ export class Nav implements NavOutlet {
);
}
/** @hidden */
/** @internal */
@Method()
setRouteId(
id: string,
@ -379,7 +384,7 @@ export class Nav implements NavOutlet {
return promise;
}
/** @hidden */
/** @internal */
@Method()
async getRouteId(): Promise<RouteID | undefined> {
const active = this.getActiveSync();
@ -409,7 +414,7 @@ export class Nav implements NavOutlet {
}
/**
* Returns true or false if the current view can go back
* Returns `true` or false if the current view can go back
*/
@Method()
canGoBack(view?: ViewController): Promise<boolean> {
@ -448,7 +453,7 @@ export class Nav implements NavOutlet {
// _queueTrns() adds a navigation stack change to the queue and schedules it to run:
// 1. _nextTrns(): consumes the next transition in the queue
// 2. _viewInit(): initializes enteringView if required
// 3. _viewTest(): ensures canLeave/canEnter returns true, so the operation can continue
// 3. _viewTest(): ensures canLeave/canEnter Returns `true`, so the operation can continue
// 4. _postViewInit(): add/remove the views from the navigation stack
// 5. _transitionInit(): initializes the visual transition if required and schedules it to run
// 6. _viewAttachToDOM(): attaches the enteringView to the DOM

18
core/src/components/nav/readme.md
View File

@ -9,14 +9,14 @@ Unlike RouterOutlet, Nav is not tied to a particular router. Meaning that if we
## Properties
| Property | Attribute | Description | Type |
| -------------- | --------------- | ------------------------------------------------------ | ------------------- |
| `animated` | `animated` | If the nav should animate the components or not | `boolean` |
| `animation` | -- | | `AnimationBuilder` |
| `delegate` | -- | | `FrameworkDelegate` |
| `rootParams` | -- | Any parameters for the root component | `ComponentProps` |
| `root` | `root` | Root NavComponent to load | `NavComponent` |
| `swipeGesture` | `swipe-gesture` | If the nav component should allow for swipe-to-go-back | `boolean` |
| Property | Attribute | Description | Type |
| -------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| `animated` | `animated` | If `true`, the nav should animate the transition of components. Default to `true`. | `boolean` |
| `animation` | -- | By default `ion-nav` animates transition between pages based in the mode (ios or material design). However, this property allows to create custom transition using `AnimateBuilder` functions. | `AnimationBuilder` |
| `delegate` | -- | | `FrameworkDelegate` |
| `rootParams` | -- | Any parameters for the root component | `ComponentProps` |
| `root` | `root` | Root NavComponent to load | `NavComponent` |
| `swipeGesture` | `swipe-gesture` | If the nav component should allow for swipe-to-go-back. | `boolean` |
## Events
@ -32,7 +32,7 @@ Unlike RouterOutlet, Nav is not tied to a particular router. Meaning that if we
### `canGoBack(view?: ViewController | undefined) => Promise<boolean>`
Returns true or false if the current view can go back
Returns `true` or false if the current view can go back
#### Parameters

4
core/src/components/nav/view-controller.ts
View File

@ -20,9 +20,6 @@ export class ViewController {
public params: ComponentProps | undefined
) {}
/**
* @hidden
*/
async init(container: HTMLElement) {
this.state = ViewState.Attached;
@ -33,7 +30,6 @@ export class ViewController {
}
/**
* @hidden
* DOM WRITE
*/
_destroy() {