useChaynsHistoryNavigate

Callable

• useChaynsHistoryNavigate(): (opts: { activeChild?: string | null; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigateOptions) => Promise<ChaynsHistoryActionResult>

---

• Returns a stable navigate function for the nearest ChaynsHistoryLayer.

  ---

  Returns (opts: { activeChild?: string | null; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigateOptions) => Promise<ChaynsHistoryActionResult>

  • • (opts: { activeChild?: string | null; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigateOptions): Promise<ChaynsHistoryActionResult>

    • Parameters

      • opts: { activeChild?: string | null; activeChildInit?: { route?: string | string[]; state?: Record<string, unknown> }; route?: string | string[]; state?: Record<string, unknown> } & ChaynsHistoryNavigateOptions

      Returns Promise<ChaynsHistoryActionResult>