feat(nav-link): merge nav-push/pop/set-root into a single component (#18909)

This commit is contained in:
Manu MA
2019-08-27 18:14:13 +02:00
committed by GitHub
parent d031434b5d
commit c3044f59df
32 changed files with 313 additions and 19 deletions

View File

@ -43,6 +43,7 @@ d.IonApp,
d.IonMenuButton, d.IonMenuButton,
d.IonMenuToggle, d.IonMenuToggle,
d.IonNav, d.IonNav,
d.IonNavLink,
d.IonNavPop, d.IonNavPop,
d.IonNavPush, d.IonNavPush,
d.IonNavSetRoot, d.IonNavSetRoot,

View File

@ -505,6 +505,17 @@ export class IonNav {
proxyMethods(IonNav, ['push', 'insert', 'insertPages', 'pop', 'popTo', 'popToRoot', 'removeIndex', 'setRoot', 'setPages', 'getActive', 'getByIndex', 'canGoBack', 'getPrevious']); proxyMethods(IonNav, ['push', 'insert', 'insertPages', 'pop', 'popTo', 'popToRoot', 'removeIndex', 'setRoot', 'setPages', 'getActive', 'getByIndex', 'canGoBack', 'getPrevious']);
proxyInputs(IonNav, ['animated', 'animation', 'root', 'rootParams', 'swipeGesture']); proxyInputs(IonNav, ['animated', 'animation', 'root', 'rootParams', 'swipeGesture']);
export declare interface IonNavLink extends Components.IonNavLink {}
@Component({ selector: 'ion-nav-link', changeDetection: ChangeDetectionStrategy.OnPush, template: '<ng-content></ng-content>', inputs: ['component', 'componentProps', 'routerDirection'] })
export class IonNavLink {
protected el: HTMLElement;
constructor(c: ChangeDetectorRef, r: ElementRef, protected z: NgZone) {
c.detach();
this.el = r.nativeElement;
}
}
proxyInputs(IonNavLink, ['component', 'componentProps', 'routerDirection']);
export declare interface IonNavPop extends Components.IonNavPop {} export declare interface IonNavPop extends Components.IonNavPop {}
@Component({ selector: 'ion-nav-pop', changeDetection: ChangeDetectionStrategy.OnPush, template: '<ng-content></ng-content>' }) @Component({ selector: 'ion-nav-pop', changeDetection: ChangeDetectionStrategy.OnPush, template: '<ng-content></ng-content>' })
export class IonNavPop { export class IonNavPop {

View File

@ -13,7 +13,7 @@ import { IonRouterOutlet } from './directives/navigation/ion-router-outlet';
import { IonTabs } from './directives/navigation/ion-tabs'; import { IonTabs } from './directives/navigation/ion-tabs';
import { NavDelegate } from './directives/navigation/nav-delegate'; import { NavDelegate } from './directives/navigation/nav-delegate';
import { RouterLinkDelegate } from './directives/navigation/router-link-delegate'; import { RouterLinkDelegate } from './directives/navigation/router-link-delegate';
import { IonApp, IonAvatar, IonBackButton, IonBackdrop, IonBadge, IonButton, IonButtons, IonCard, IonCardContent, IonCardHeader, IonCardSubtitle, IonCardTitle, IonCheckbox, IonChip, IonCol, IonContent, IonDatetime, IonFab, IonFabButton, IonFabList, IonFooter, IonGrid, IonHeader, IonIcon, IonImg, IonInfiniteScroll, IonInfiniteScrollContent, IonInput, IonItem, IonItemDivider, IonItemGroup, IonItemOption, IonItemOptions, IonItemSliding, IonLabel, IonList, IonListHeader, IonMenu, IonMenuButton, IonMenuToggle, IonNav, IonNavPop, IonNavPush, IonNavSetRoot, IonNote, IonProgressBar, IonRadio, IonRadioGroup, IonRange, IonRefresher, IonRefresherContent, IonReorder, IonReorderGroup, IonRippleEffect, IonRow, IonSearchbar, IonSegment, IonSegmentButton, IonSelect, IonSelectOption, IonSkeletonText, IonSlide, IonSlides, IonSpinner, IonSplitPane, IonTabBar, IonTabButton, IonText, IonTextarea, IonThumbnail, IonTitle, IonToggle, IonToolbar } from './directives/proxies'; import { IonApp, IonAvatar, IonBackButton, IonBackdrop, IonBadge, IonButton, IonButtons, IonCard, IonCardContent, IonCardHeader, IonCardSubtitle, IonCardTitle, IonCheckbox, IonChip, IonCol, IonContent, IonDatetime, IonFab, IonFabButton, IonFabList, IonFooter, IonGrid, IonHeader, IonIcon, IonImg, IonInfiniteScroll, IonInfiniteScrollContent, IonInput, IonItem, IonItemDivider, IonItemGroup, IonItemOption, IonItemOptions, IonItemSliding, IonLabel, IonList, IonListHeader, IonMenu, IonMenuButton, IonMenuToggle, IonNav, IonNavLink, IonNavPop, IonNavPush, IonNavSetRoot, IonNote, IonProgressBar, IonRadio, IonRadioGroup, IonRange, IonRefresher, IonRefresherContent, IonReorder, IonReorderGroup, IonRippleEffect, IonRow, IonSearchbar, IonSegment, IonSegmentButton, IonSelect, IonSelectOption, IonSkeletonText, IonSlide, IonSlides, IonSpinner, IonSplitPane, IonTabBar, IonTabButton, IonText, IonTextarea, IonThumbnail, IonTitle, IonToggle, IonToolbar } from './directives/proxies';
import { VirtualFooter } from './directives/virtual-scroll/virtual-footer'; import { VirtualFooter } from './directives/virtual-scroll/virtual-footer';
import { VirtualHeader } from './directives/virtual-scroll/virtual-header'; import { VirtualHeader } from './directives/virtual-scroll/virtual-header';
import { VirtualItem } from './directives/virtual-scroll/virtual-item'; import { VirtualItem } from './directives/virtual-scroll/virtual-item';
@ -66,6 +66,7 @@ const DECLARATIONS = [
IonMenuButton, IonMenuButton,
IonMenuToggle, IonMenuToggle,
IonNav, IonNav,
IonNavLink,
IonNavPop, IonNavPop,
IonNavPush, IonNavPush,
IonNavSetRoot, IonNavSetRoot,

View File

@ -53,10 +53,10 @@ export class MenuController {
* @param shouldEnable True if it should be swipe-able, false if not. * @param shouldEnable True if it should be swipe-able, false if not.
* @param [menuId] Optionally get the menu by its id, or side. * @param [menuId] Optionally get the menu by its id, or side.
* @return Returns the instance of the menu, which is useful for chaining. * @return Returns the instance of the menu, which is useful for chaining.
* @deprecated Use swipeGesture() instead * @deprecated Use swipeGesture() instead.
*/ */
swipeEnable(shouldEnable: boolean, menuId?: string) { swipeEnable(shouldEnable: boolean, menuId?: string) {
console.warn('MenuController.swipeEnable is deprecated. Use MenuController.swipeGesture() instead'); console.warn('[DEPRECATED][ion-menu-controller] swipeEnable() is deprecated. Use MenuController.swipeGesture() instead');
return this.swipeGesture(shouldEnable, menuId); return this.swipeGesture(shouldEnable, menuId);
} }

View File

@ -729,6 +729,11 @@ ion-nav,method,setRoot,setRoot<T extends NavComponent>(component: T, componentPr
ion-nav,event,ionNavDidChange,void,false ion-nav,event,ionNavDidChange,void,false
ion-nav,event,ionNavWillChange,void,false ion-nav,event,ionNavWillChange,void,false
ion-nav-link,none
ion-nav-link,prop,component,Function | HTMLElement | ViewController | null | string | undefined,undefined,false,false
ion-nav-link,prop,componentProps,undefined | { [key: string]: any; },undefined,false,false
ion-nav-link,prop,routerDirection,"back" | "forward" | "root",'forward',false,false
ion-nav-pop,none ion-nav-pop,none
ion-nav-push,none ion-nav-push,none

View File

@ -1639,6 +1639,20 @@ export namespace Components {
*/ */
'swipeGesture'?: boolean; 'swipeGesture'?: boolean;
} }
interface IonNavLink {
/**
* Component to navigate to. Only used if the `routerDirection` is `"forward"` or `"root"`.
*/
'component'?: NavComponent;
/**
* Data you want to pass to the component as props. Only used if the `"routerDirection"` is `"forward"` or `"root"`.
*/
'componentProps'?: ComponentProps;
/**
* The transition direction when navigating to another page.
*/
'routerDirection': RouterDirection;
}
interface IonNavPop {} interface IonNavPop {}
interface IonNavPush { interface IonNavPush {
/** /**
@ -3186,6 +3200,12 @@ declare global {
new (): HTMLIonNavElement; new (): HTMLIonNavElement;
}; };
interface HTMLIonNavLinkElement extends Components.IonNavLink, HTMLStencilElement {}
var HTMLIonNavLinkElement: {
prototype: HTMLIonNavLinkElement;
new (): HTMLIonNavLinkElement;
};
interface HTMLIonNavPopElement extends Components.IonNavPop, HTMLStencilElement {} interface HTMLIonNavPopElement extends Components.IonNavPop, HTMLStencilElement {}
var HTMLIonNavPopElement: { var HTMLIonNavPopElement: {
prototype: HTMLIonNavPopElement; prototype: HTMLIonNavPopElement;
@ -3524,6 +3544,7 @@ declare global {
'ion-modal': HTMLIonModalElement; 'ion-modal': HTMLIonModalElement;
'ion-modal-controller': HTMLIonModalControllerElement; 'ion-modal-controller': HTMLIonModalControllerElement;
'ion-nav': HTMLIonNavElement; 'ion-nav': HTMLIonNavElement;
'ion-nav-link': HTMLIonNavLinkElement;
'ion-nav-pop': HTMLIonNavPopElement; 'ion-nav-pop': HTMLIonNavPopElement;
'ion-nav-push': HTMLIonNavPushElement; 'ion-nav-push': HTMLIonNavPushElement;
'ion-nav-set-root': HTMLIonNavSetRootElement; 'ion-nav-set-root': HTMLIonNavSetRootElement;
@ -4931,6 +4952,20 @@ declare namespace LocalJSX {
*/ */
'swipeGesture'?: boolean; 'swipeGesture'?: boolean;
} }
interface IonNavLink extends JSXBase.HTMLAttributes<HTMLIonNavLinkElement> {
/**
* Component to navigate to. Only used if the `routerDirection` is `"forward"` or `"root"`.
*/
'component'?: NavComponent;
/**
* Data you want to pass to the component as props. Only used if the `"routerDirection"` is `"forward"` or `"root"`.
*/
'componentProps'?: ComponentProps;
/**
* The transition direction when navigating to another page.
*/
'routerDirection'?: RouterDirection;
}
interface IonNavPop extends JSXBase.HTMLAttributes<HTMLIonNavPopElement> {} interface IonNavPop extends JSXBase.HTMLAttributes<HTMLIonNavPopElement> {}
interface IonNavPush extends JSXBase.HTMLAttributes<HTMLIonNavPushElement> { interface IonNavPush extends JSXBase.HTMLAttributes<HTMLIonNavPushElement> {
/** /**
@ -6207,6 +6242,7 @@ declare namespace LocalJSX {
'ion-modal': IonModal; 'ion-modal': IonModal;
'ion-modal-controller': IonModalController; 'ion-modal-controller': IonModalController;
'ion-nav': IonNav; 'ion-nav': IonNav;
'ion-nav-link': IonNavLink;
'ion-nav-pop': IonNavPop; 'ion-nav-pop': IonNavPop;
'ion-nav-push': IonNavPush; 'ion-nav-push': IonNavPush;
'ion-nav-set-root': IonNavSetRoot; 'ion-nav-set-root': IonNavSetRoot;

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { ActionSheetOptions, OverlayController } from '../../interface'; import { ActionSheetOptions, OverlayController } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `actionSheetController` exported from core.
*/
@Component({ @Component({
tag: 'ion-action-sheet-controller' tag: 'ion-action-sheet-controller'
}) })

View File

@ -5,6 +5,8 @@ Action Sheet controllers programmatically control the action sheet component. Ac
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `actionSheetController` exported from core.
## Methods ## Methods
### `create(options: ActionSheetOptions) => Promise<HTMLIonActionSheetElement>` ### `create(options: ActionSheetOptions) => Promise<HTMLIonActionSheetElement>`

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { AlertOptions, OverlayController } from '../../interface'; import { AlertOptions, OverlayController } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `alertController` exported from core.
*/
@Component({ @Component({
tag: 'ion-alert-controller' tag: 'ion-alert-controller'
}) })

View File

@ -6,6 +6,8 @@ Alert controllers programmatically control the alert component. Alerts can be cr
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `alertController` exported from core.
## Methods ## Methods
### `create(options: AlertOptions) => Promise<HTMLIonAlertElement>` ### `create(options: AlertOptions) => Promise<HTMLIonAlertElement>`

View File

@ -40,7 +40,7 @@ export class Anchor implements ComponentInterface {
@Prop() routerDirection: RouterDirection = 'forward'; @Prop() routerDirection: RouterDirection = 'forward';
componentDidLoad() { componentDidLoad() {
console.warn('The <ion-anchor> component has been deprecated. Please use an <ion-router-link> if you are using a vanilla JS or Stencil project or an <a> with the Angular router.'); console.warn('[DEPRECATED][ion-anchor] The <ion-anchor> component has been deprecated. Please use an <ion-router-link> if you are using a vanilla JS or Stencil project or an <a> with the Angular router.');
} }
private onClick = (ev: Event) => { private onClick = (ev: Event) => {

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { LoadingOptions, OverlayController } from '../../interface'; import { LoadingOptions, OverlayController } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `loadingController` exported from core.
*/
@Component({ @Component({
tag: 'ion-loading-controller' tag: 'ion-loading-controller'
}) })

View File

@ -8,6 +8,8 @@ Loading controllers programmatically control the loading component. Loadings can
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `loadingController` exported from core.
## Methods ## Methods
### `create(options?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement>` ### `create(options?: LoadingOptions | undefined) => Promise<HTMLIonLoadingElement>`

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { ComponentRef, ModalOptions, OverlayController } from '../../interface'; import { ComponentRef, ModalOptions, OverlayController } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `modalController` exported from core.
*/
@Component({ @Component({
tag: 'ion-modal-controller' tag: 'ion-modal-controller'
}) })

View File

@ -6,6 +6,8 @@ Modal controllers programmatically control the modal component. Modals can be cr
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `modalController` exported from core.
## Methods ## Methods
### `create<T extends ComponentRef>(options: ModalOptions<T>) => Promise<HTMLIonModalElement>` ### `create<T extends ComponentRef>(options: ModalOptions<T>) => Promise<HTMLIonModalElement>`

View File

@ -0,0 +1,20 @@
import { ComponentProps, NavComponent } from '../../interface';
import { RouterDirection } from '../router/utils/interface';
export const navLink = (el: HTMLElement, routerDirection: RouterDirection, component?: NavComponent, componentProps?: ComponentProps) => {
const nav = el.closest('ion-nav');
if (nav) {
if (routerDirection === 'forward') {
if (component !== undefined) {
return nav.push(component, componentProps, { skipIfBusy: true });
}
} else if (routerDirection === 'root') {
if (component !== undefined) {
return nav.setRoot(component, componentProps, { skipIfBusy: true });
}
} else if (routerDirection === 'back') {
return nav.pop({ skipIfBusy: true });
}
}
return Promise.resolve(false);
};

View File

@ -0,0 +1,37 @@
import { Component, ComponentInterface, Element, Host, Prop, h } from '@stencil/core';
import { ComponentProps, NavComponent, RouterDirection } from '../../interface';
import { navLink } from './nav-link-utils';
@Component({
tag: 'ion-nav-link'
})
export class NavLink implements ComponentInterface {
@Element() el!: HTMLElement;
/**
* Component to navigate to. Only used if the `routerDirection` is `"forward"` or `"root"`.
*/
@Prop() component?: NavComponent;
/**
* Data you want to pass to the component as props. Only used if the `"routerDirection"` is `"forward"` or `"root"`.
*/
@Prop() componentProps?: ComponentProps;
/**
* The transition direction when navigating to another page.
*/
@Prop() routerDirection: RouterDirection = 'forward';
private onClick = () => {
return navLink(this.el, this.routerDirection, this.component, this.componentProps);
}
render() {
return (
<Host onClick={this.onClick}></Host>
);
}
}

View File

@ -0,0 +1,22 @@
# ion-nav-link
A navigation link is used to navigate to a specified component. The component can be navigated to by going `forward`, `back` or as a `root` component.
It is the element form of calling the `push()`, `pop()`, and `setRoot()` methods on the navigation controller.
<!-- Auto Generated Below -->
## Properties
| Property | Attribute | Description | Type | Default |
| ----------------- | ------------------ | ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ----------- |
| `component` | `component` | Component to navigate to. Only used if the `routerDirection` is `"forward"` or `"root"`. | `Function \| HTMLElement \| ViewController \| null \| string \| undefined` | `undefined` |
| `componentProps` | -- | Data you want to pass to the component as props. Only used if the `"routerDirection"` is `"forward"` or `"root"`. | `undefined \| { [key: string]: any; }` | `undefined` |
| `routerDirection` | `router-direction` | The transition direction when navigating to another page. | `"back" \| "forward" \| "root"` | `'forward'` |
----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)*

View File

@ -0,0 +1,106 @@
<!DOCTYPE html>
<html dir="ltr">
<head>
<meta charset="UTF-8">
<title>Nav Push</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no">
<link href="../../../../../css/ionic.bundle.css" rel="stylesheet">
<link href="../../../../../scripts/testing/styles.css" rel="stylesheet">
<script src="../../../../../scripts/testing/scripts.js"></script>
<script nomodule src="../../../../../dist/ionic/ionic.js"></script>
<script type="module" src="../../../../../dist/ionic/ionic.esm.js"></script></head>
<body onload="loadFirstPage()">
<ion-app>
<ion-nav></ion-nav>
</ion-app>
<style>
f {
display: block;
margin: 15px auto;
max-width: 150px;
height: 150px;
background: blue;
}
f:last-of-type {
background: yellow;
}
</style>
</body>
<script>
class FirstPage extends HTMLElement {
async connectedCallback() {
this.innerHTML = `
<ion-header>
<ion-toolbar>
<ion-title>Page One</ion-title>
</ion-toolbar>
</ion-header>
<ion-content class="ion-padding">
<h1>Page One</h1>
<ion-nav-push component="page-two">
<ion-button class="next">Go to Page Two</ion-button>
</ion-nav-push>
</ion-content>
`;
}
}
class SecondPage extends HTMLElement {
async connectedCallback() {
this.innerHTML = `
<ion-header>
<ion-toolbar>
<ion-title>Page Two</ion-title>
</ion-toolbar>
</ion-header>
<ion-content class="ion-padding">
<h1>Page Two</h1>
<ion-nav-push component="page-three">
<ion-button class="next">Go to Page Three</ion-button>
</ion-nav-push>
<ion-nav-pop>
<ion-button class="back">Go Back</ion-button>
</ion-nav-pop>
</ion-content>
`;
}
}
class ThirdPage extends HTMLElement {
async connectedCallback() {
this.innerHTML = `
<ion-header>
<ion-toolbar>
<ion-title>Page Three</ion-title>
</ion-toolbar>
</ion-header>
<ion-content class="ion-padding">
<h1>Page Three</h1>
<ion-nav-pop>
<ion-button class="back">Go Back</ion-button>
</ion-nav-pop>
</ion-content>
`;
}
}
customElements.define('page-one', FirstPage);
customElements.define('page-two', SecondPage);
customElements.define('page-three', ThirdPage);
async function loadFirstPage() {
const nav = document.querySelector('ion-nav');
await nav.setRoot('page-one');
}
</script>
</html>

View File

@ -1,5 +1,10 @@
import { Component, ComponentInterface, Element, Host, h } from '@stencil/core'; import { Component, ComponentInterface, Element, Host, h } from '@stencil/core';
import { navLink } from '../nav-link/nav-link-utils';
/**
* @deprecated Use `<ion-nav-link routerDirection="back">` instead.
*/
@Component({ @Component({
tag: 'ion-nav-pop', tag: 'ion-nav-pop',
}) })
@ -7,11 +12,12 @@ export class NavPop implements ComponentInterface {
@Element() el!: HTMLElement; @Element() el!: HTMLElement;
componentDidLoad() {
console.warn('[DEPRECATED][ion-nav-pop] <ion-nav-pop> is deprecated. Use `<ion-nav-link routerDirection="back">` instead.');
}
private pop = () => { private pop = () => {
const nav = this.el.closest('ion-nav'); return navLink(this.el, 'back');
if (nav) {
nav.pop({ skipIfBusy: true });
}
} }
render() { render() {

View File

@ -6,6 +6,8 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use `<ion-nav-link routerDirection="back">` instead.
---------------------------------------------- ----------------------------------------------
*Built with [StencilJS](https://stenciljs.com/)* *Built with [StencilJS](https://stenciljs.com/)*

View File

@ -1,7 +1,11 @@
import { Component, ComponentInterface, Element, Host, Prop, h } from '@stencil/core'; import { Component, ComponentInterface, Element, Host, Prop, h } from '@stencil/core';
import { ComponentProps, NavComponent } from '../../interface'; import { ComponentProps, NavComponent } from '../../interface';
import { navLink } from '../nav-link/nav-link-utils';
/**
* @deprecated Use `<ion-nav-link component="MyComponent">` instead.
*/
@Component({ @Component({
tag: 'ion-nav-push' tag: 'ion-nav-push'
}) })
@ -18,12 +22,12 @@ export class NavPush implements ComponentInterface {
*/ */
@Prop() componentProps?: ComponentProps; @Prop() componentProps?: ComponentProps;
componentDidLoad() {
console.warn('[DEPRECATED][ion-nav-push] `<ion-nav-push component="MyComponent">` is deprecated. Use `<ion-nav-link component="MyComponent">` instead.');
}
private push = () => { private push = () => {
const nav = this.el.closest('ion-nav'); return navLink(this.el, 'forward', this.component, this.componentProps);
const toPush = this.component;
if (nav && toPush !== undefined) {
nav.push(toPush, this.componentProps, { skipIfBusy: true });
}
} }
render() { render() {

View File

@ -7,6 +7,8 @@ It is the element form of `NavController.push()`
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use `<ion-nav-link component="MyComponent">` instead.
## Properties ## Properties
| Property | Attribute | Description | Type | Default | | Property | Attribute | Description | Type | Default |

View File

@ -1,7 +1,11 @@
import { Component, ComponentInterface, Element, Host, Prop, h } from '@stencil/core'; import { Component, ComponentInterface, Element, Host, Prop, h } from '@stencil/core';
import { ComponentProps, NavComponent } from '../../interface'; import { ComponentProps, NavComponent } from '../../interface';
import { navLink } from '../nav-link/nav-link-utils';
/**
* @deprecated Use `<ion-nav-link component="MyComponent" routerDirection="root">` instead.
*/
@Component({ @Component({
tag: 'ion-nav-set-root' tag: 'ion-nav-set-root'
}) })
@ -19,12 +23,12 @@ export class NavSetRoot implements ComponentInterface {
*/ */
@Prop() componentProps?: ComponentProps; @Prop() componentProps?: ComponentProps;
componentDidLoad() {
console.warn('[DEPRECATED][ion-nav-set-root] `<ion-nav-set-root component="MyComponent">` is deprecated. Use `<ion-nav-link component="MyComponent" routerDirection="root">` instead.');
}
private setRoot = () => { private setRoot = () => {
const nav = this.el.closest('ion-nav'); return navLink(this.el, 'root', this.component, this.componentProps);
const toPush = this.component;
if (nav && toPush !== undefined) {
nav.setRoot(toPush, this.componentProps, { skipIfBusy: true });
}
} }
render() { render() {

View File

@ -7,6 +7,8 @@ It is the component form of calling `NavController.setRoot()`
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use `<ion-nav-link component="MyComponent" routerDirection="root">` instead.
## Properties ## Properties
| Property | Attribute | Description | Type | Default | | Property | Attribute | Description | Type | Default |

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { OverlayController, PickerOptions } from '../../interface'; import { OverlayController, PickerOptions } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `pickerController` exported from core.
*/
@Component({ @Component({
tag: 'ion-picker-controller' tag: 'ion-picker-controller'
}) })

View File

@ -5,6 +5,8 @@
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `pickerController` exported from core.
## Methods ## Methods
### `create(options: PickerOptions) => Promise<HTMLIonPickerElement>` ### `create(options: PickerOptions) => Promise<HTMLIonPickerElement>`

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { ComponentRef, OverlayController, PopoverOptions } from '../../interface'; import { ComponentRef, OverlayController, PopoverOptions } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `popoverController` exported from core.
*/
@Component({ @Component({
tag: 'ion-popover-controller', tag: 'ion-popover-controller',
}) })

View File

@ -6,6 +6,8 @@ Popover controllers programmatically control the popover component. Popovers can
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `popoverController` exported from core.
## Usage ## Usage
### Javascript ### Javascript

View File

@ -6,6 +6,8 @@ ToastController is a component used to create Toast components. Please see the d
<!-- Auto Generated Below --> <!-- Auto Generated Below -->
> **[DEPRECATED]** Use the `toastController` exported from core.
## Methods ## Methods
### `create(options?: ToastOptions | undefined) => Promise<HTMLIonToastElement>` ### `create(options?: ToastOptions | undefined) => Promise<HTMLIonToastElement>`

View File

@ -3,6 +3,9 @@ import { Build, Component, ComponentInterface, Method } from '@stencil/core';
import { OverlayController, ToastOptions } from '../../interface'; import { OverlayController, ToastOptions } from '../../interface';
import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays'; import { createOverlay, dismissOverlay, getOverlay } from '../../utils/overlays';
/**
* @deprecated Use the `toastController` exported from core.
*/
@Component({ @Component({
tag: 'ion-toast-controller' tag: 'ion-toast-controller'
}) })

View File

@ -28,7 +28,7 @@ export const config: Config = {
{ components: ['ion-loading'] }, { components: ['ion-loading'] },
{ components: ['ion-menu', 'ion-menu-controller', 'ion-menu-toggle', 'ion-menu-button'] }, { components: ['ion-menu', 'ion-menu-controller', 'ion-menu-toggle', 'ion-menu-button'] },
{ components: ['ion-modal'] }, { components: ['ion-modal'] },
{ components: ['ion-nav', 'ion-nav-pop', 'ion-nav-push', 'ion-nav-set-root'] }, { components: ['ion-nav', 'ion-nav-link', 'ion-nav-pop', 'ion-nav-push', 'ion-nav-set-root'] },
{ components: ['ion-img'] }, { components: ['ion-img'] },
{ components: ['ion-popover'] }, { components: ['ion-popover'] },
{ components: ['ion-progress-bar'] }, { components: ['ion-progress-bar'] },