ion-router

路由是一个用于处理普通和 Stencil JavaScript 项目内部路由的组件。

¥The router is a component for handling routing inside vanilla and Stencil JavaScript projects.

注意

注意：该组件只能与普通和 Stencil JavaScript 项目一起使用。有关特定于框架的路由解决方案，请参阅 Angular、React 和 Vue 的路由指南。

¥Note: This component should only be used with vanilla and Stencil JavaScript projects. See the routing guides for Angular, React, and Vue for framework-specific routing solutions.

应用的代码库中应该有一个 ion-router 组件。该组件控制与浏览器历史记录的所有交互，并通过事件系统聚合更新。

¥Apps should have a single ion-router component in the codebase. This component controls all interactions with the browser history and it aggregates updates through an event system.

ion-router 只是 ionic 导航出口的 URL 协调器：ion-nav、ion-tabs 和 ion-router-outlet。

¥ion-router is just a URL coordinator for the navigation outlets of ionic: ion-nav, ion-tabs, and ion-router-outlet.

这意味着 ion-router 永远不会接触 DOM，它不会显示组件或发出任何类型的生命周期事件，它只是根据浏览器的 URL 告诉 ion-nav、ion-tabs 和 ion-router-outlet 到 "show" 的内容和时间。

¥That means the ion-router never touches the DOM, it does NOT show the components or emit any kind of lifecycle events, it just tells ion-nav, ion-tabs, and ion-router-outlet what and when to "show" based on the browser's URL.

为了配置组件（加载/选择）和 URL 之间的关系，ion-router 使用声明性语法，使用 JSX/HTML 来定义路由树。

¥In order to configure this relationship between components (to load/select) and URLs, ion-router uses a declarative syntax using JSX/HTML to define a tree of routes.

基本用法

¥Basic Usage

接口

¥Interfaces

RouterEventDetail

interface RouterEventDetail {
  from: string | null;
  redirectedFrom: string | null;
  to: string;
}

RouterCustomEvent

虽然不是必需的，但可以使用此接口代替 CustomEvent 接口，以便使用从此组件发出的 Ionic 事件进行更强的键入。

¥While not required, this interface can be used in place of the CustomEvent interface for stronger typing with Ionic events emitted from this component.

interface RouterCustomEvent extends CustomEvent {
  detail: RouterEventDetail;
  target: HTMLIonRouterElement;
}

用法

¥Usage

<ion-router>
  <ion-route component="page-tabs">
    <ion-route url="/schedule" component="tab-schedule">
      <ion-route component="page-schedule"></ion-route>
      <ion-route url="/session/:sessionId" component="page-session"></ion-route>
    </ion-route>

    <ion-route url="/speakers" component="tab-speaker">
      <ion-route component="page-speaker-list"></ion-route>
      <ion-route url="/session/:sessionId" component="page-session"></ion-route>
      <ion-route url="/:speakerId" component="page-speaker-detail"></ion-route>
    </ion-route>

    <ion-route url="/map" component="page-map"></ion-route>
    <ion-route url="/about" component="page-about"></ion-route>
  </ion-route>

  <ion-route url="/tutorial" component="page-tutorial"></ion-route>
  <ion-route url="/login" component="page-login"></ion-route>
  <ion-route url="/account" component="page-account"></ion-route>
  <ion-route url="/signup" component="page-signup"></ion-route>
  <ion-route url="/support" component="page-support"></ion-route>
</ion-router>

属性

¥Properties

root

Description	The root path to use when matching URLs. By default, this is set to "/", but you can specify an alternate prefix for all URL paths.
Attribute	`root`
Type	`string`
Default	`'/'`

useHash

Description	The router can work in two "modes": - With hash: `/index.html#/path/to/page` - Without hash: `/path/to/page` Using one or another might depend in the requirements of your app and/or where it's deployed. Usually "hash-less" navigation works better for SEO and it's more user friendly too, but it might requires additional server-side configuration in order to properly work. On the other side hash-navigation is much easier to deploy, it even works over the file protocol. By default, this property is `true`, change to `false` to allow hash-less URLs.
Attribute	`use-hash`
Type	`boolean`
Default	`true`

事件

¥Events

Name	Description	Bubbles
`ionRouteDidChange`	Emitted when the route had changed	`true`
`ionRouteWillChange`	Event emitted when the route is about to change	`true`

方法

¥Methods

back

Description	Go back to previous page in the window.history.
Signature	`back() => Promise<void>`

push

Description	Navigate to the specified path.
Signature	`push(path: string, direction?: RouterDirection, animation?: AnimationBuilder) => Promise<boolean>`

CSS 阴影部分

¥CSS Shadow Parts

No CSS shadow parts available for this component.

CSS 自定义属性

¥CSS Custom Properties

No CSS custom properties available for this component.

插槽

¥Slots

No slots available for this component.

基本用法​

接口​

RouterEventDetail​

RouterCustomEvent​

用法​

属性​

root​

useHash​

事件​

方法​

back​

push​

CSS 阴影部分​

CSS 自定义属性​

插槽​

目录