Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Router<SS>

ルーティング機能を提供するためのReactコンポーネントツリーの最上位に位置するコンポーネント。スクリーンを跨いだ操作のためのインスタンスメソッドも提供する。 ルータインスタンスにはscreenProps.routerでアクセスすることができ、Screen表示/非表示などの操作メソッドを呼び出せます。

Type parameters

  • SS

Hierarchy

  • Component<RouterProps, RouterState>
    • Router

Index

Properties

context

context: any

props

props: Readonly<object> & Readonly<RouterProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<RouterState>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<RouterProps>, nextContext: any): void
  • Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes.

    Calling Component#setState generally does not trigger this method.

    This method will not stop working in React 17.

    Note: the presence of getSnapshotBeforeUpdate or getDerivedStateFromProps prevents this from being invoked.

    deprecated

    16.3, use static getDerivedStateFromProps instead

    see

    https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props

    see

    https://reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path

    Parameters

    • nextProps: Readonly<RouterProps>
    • nextContext: any

    Returns void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<RouterProps>, nextState: Readonly<RouterState>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a component is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<RouterProps>, prevState: Readonly<RouterState>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<RouterProps>
    • prevState: Readonly<RouterState>
    • Optional snapshot: SS

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<RouterProps>, nextContext: any): void

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<RouterProps>, nextState: Readonly<RouterState>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: function): void
  • Parameters

    • Optional callBack: function
        • (): void
        • Returns void

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<RouterProps>, prevState: Readonly<RouterState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<RouterProps>
    • prevState: Readonly<RouterState>

    Returns SS | null

popHorizontal

  • 横移動アニメーションと共に現在のスクリーンをスタックから破棄する

    Parameters

    Returns void

popVertical

  • 縦移動アニメーションと共に現在のスクリーンをスタックから破棄する

    Parameters

    Returns void

pushHorizontal

  • pushHorizontal(__namedParameters: object): void
  • 横移動アニメーションと共にスクリーンを追加表示する。

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

pushHorizontalWithStickTab

  • pushHorizontalWithStickTab(__namedParameters: object): void
  • 横移動アニメーションと共にスクリーンを追加表示する。 タブはアニメーションせずに先行表示するので、遷移前スクリーンと遷移後スクリーンが同じタブを使っていると、遷移中にタブをスティッキーに見せることができる。

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

pushVertical

  • pushVertical(__namedParameters: object): void
  • 縦移動アニメーションと共にスクリーンを追加表示する。

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

resetWithPopHorizontal

  • 横移動アニメーションと共に現在のスクリーンを破棄し、新しいスクリーンスタックに差し替える

    Parameters

    Returns void

resetWithPopVertical

  • 縦移動アニメーションと共に現在のスクリーンを破棄し、新しいスクリーンスタックに差し替える

    Parameters

    Returns void

resetWithPushHorizontal

  • resetWithPushHorizontal(__namedParameters: object): void
  • 横移動アニメーションと共にスクリーンを表示し、それまでのスクリーンスタックを破棄し、新しいスクリーンスタックに差し替える

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

resetWithPushVertical

  • resetWithPushVertical(__namedParameters: object): void
  • 縦移動アニメーションと共にスクリーンを表示し、それまでのスクリーンスタックを破棄し、新しいスクリーンスタックに差し替える

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

resetWithoutEffect

  • resetWithoutEffect(__namedParameters: object): void
  • 移動アニメーションなしで現在のスクリーンを破棄し、新しいスクリーンスタックに差し替える

    Parameters

    • __namedParameters: object
      • allowMultipleTransition: boolean
      • childTabIndex: number
      • params: object
        • [param: string]: any
      • routeName: string
      • tabIndex: number

    Returns void

routeNameStack

  • routeNameStack(): string[]
  • 現在スタックされているスクリーンのルート名一覧を返す

    Returns string[]

screenLength

  • screenLength(): number
  • スクリーンのスタック数を返す

    Returns number

setState

  • setState<K>(state: function | S | object, callback?: function): void
  • Type parameters

    • K: keyof RouterState

    Parameters

    • state: function | S | object
    • Optional callback: function
        • (): void
        • Returns void

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<RouterProps>, nextState: Readonly<RouterState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<RouterProps>
    • nextState: Readonly<RouterState>
    • nextContext: any

    Returns boolean

topRouteName

  • topRouteName(): string
  • 現在表示されているスクリーンのルート名を返す

    Returns string

transitionState

  • transitionState(): "pushing" | "popping" | "noop"
  • スクリーンのスタック操作状態を返す

    Returns "pushing" | "popping" | "noop"

Generated using TypeDoc