Skip to main content

FrameHistoryLayer

A ChaynsHistoryLayer proxy that runs inside an iframe (FrameWrapper).

  • Reads are served from a local cache for synchronous access.
  • Writes are forwarded to the parent window via bridge functions.
  • The cache is kept in sync by FrameWrapper.init(), which sets up a single comlink listener and calls _applyAndEmit() on every navigation event.
  • Child layers are not supported in the frame context — manage sub-routing with a local initRootChaynsHistoryLayer inside the iframe instead.

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

readonlydepth

depth: number

readonlyid

id: string

Methods

addBlock

  • Parameters

    Returns () => void

      • (): void

      • Returns void

addEventListener

  • Parameters

    Returns () => void

      • (): void

      • Returns void

createChildLayer

  • Parameters

    • _id: string

    Returns ChaynsHistoryLayer

destroyChildLayer

  • destroyChildLayer(_id: string): void

  • Parameters

    • _id: string

    Returns void

getActiveChildId

  • getActiveChildId(): null | string

  • Returns null | string

getChildLayer

  • Parameters

    • _id: string

    Returns undefined | ChaynsHistoryLayer

getHash

  • getHash(): string

  • Returns string

getParams

  • getParams(): Record<string, string>

  • Returns Record<string, string>

getRoute

  • getRoute(): string[]

  • Returns string[]

getSegmentCount

  • getSegmentCount(): number

  • Returns number

getState

  • getState<T>(): undefined | T

  • Type parameters

    • T: object = Record<string, unknown>

    Returns undefined | T

navigate

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

  • Parameters

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

    Returns Promise<ChaynsHistoryActionResult>

setActiveChild

  • setActiveChild(id: null | string, init?: { route?: string | string[]; state?: Record<string, unknown> }): Promise<ChaynsHistoryActionResult>

  • Parameters

    • id: null | string
    • optionalinit: { route?: string | string[]; state?: Record<string, unknown> }
      • optionalroute: string | string[]
      • optionalstate: Record<string, unknown>

    Returns Promise<ChaynsHistoryActionResult>

setHash

setParams

setRoute

setSegmentCount

  • setSegmentCount(n: number): void

  • Parameters

    • n: number

    Returns void

setState

Page Options