HistoryManager | Swim Toolkit

Type parameters

C: Component = Component

Hierarchy

ComponentManager<C>
- HistoryManager

Index

Constructors

constructor

Properties

Accessors

historyUri

Methods

Constructors

constructor

new HistoryManager<C>(): HistoryManager<C>

Overrides ComponentManager.constructor
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:6
Type parameters
- C: Component<C> = Component
Returns HistoryManager<C>

Properties

Readonly componentManagerObservers

componentManagerObservers: readonly HistoryManagerObserver<Component, HistoryManager<Component>>[]

Readonly historyState

historyState: HistoryState

Readonly rootComponents

rootComponents: readonly C[]

Accessors

historyUri

get historyUri(): Uri

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:9
Returns Uri

Methods

addComponentManagerObserver

addComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.addComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:6
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected attachEvents

attachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:25
Returns void

Protected detachEvents

detachEvents(): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:26
Returns void

Protected didAddComponentManagerObserver

didAddComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.didAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:9
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected didAttach

didAttach(): void

Inherited from ComponentManager.didAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:19
Returns void

Protected didDetach

didDetach(): void

Inherited from ComponentManager.didDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:22
Returns void

Protected didInsertRootComponent

didInsertRootComponent(rootComponent: C): void

Inherited from ComponentManager.didInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:27
Parameters
- rootComponent: C
Returns void

Protected didObserve

didObserve<T>(callback: (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>) => void | T): undefined | T

Inherited from ComponentManager.didObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:15
Type parameters
- T
Parameters
- callback: (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>) => void | T
  - - (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void | T
    - Parameters
      - componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
      Returns void | T
Returns undefined | T

Protected didPopHistory

didPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:21
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didPushHistory

didPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:13
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected didRemoveComponentManagerObserver

didRemoveComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.didRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:13
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected didRemoveRootComponent

didRemoveRootComponent(rootComponent: C): void

Inherited from ComponentManager.didRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:31
Parameters
- rootComponent: C
Returns void

Protected didReplaceHistory

didReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:17
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

insertRootComponent

insertRootComponent(rootComponent: C): void

Inherited from ComponentManager.insertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:24
Parameters
- rootComponent: C
Returns void

isAttached

isAttached(): boolean

Inherited from ComponentManager.isAttached
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:16
Returns boolean

Protected onAddComponentManagerObserver

onAddComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.onAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:8
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected onAttach

onAttach(): void

Overrides ComponentManager.onAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:23
Returns void

Protected onDetach

onDetach(): void

Overrides ComponentManager.onDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:24
Returns void

Protected onInsertRootComponent

onInsertRootComponent(rootComponent: C): void

Inherited from ComponentManager.onInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:26
Parameters
- rootComponent: C
Returns void

Protected onPopHistory

onPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:20
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onPushHistory

onPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:12
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected onRemoveComponentManagerObserver

onRemoveComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.onRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:12
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected onRemoveRootComponent

onRemoveRootComponent(rootComponent: C): void

Inherited from ComponentManager.onRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:30
Parameters
- rootComponent: C
Returns void

Protected onReplaceHistory

onReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:16
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

popHistory

popHistory(event: PopStateEvent): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:18
Parameters
- event: PopStateEvent
Returns void

pushHistory

pushHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:10
Parameters
- deltaState: HistoryStateInit
Returns void

removeComponentManagerObserver

removeComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.removeComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:10
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

removeRootComponent

removeRootComponent(rootComponent: C): void

Inherited from ComponentManager.removeRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:28
Parameters
- rootComponent: C
Returns void

replaceHistory

replaceHistory(deltaState: HistoryStateInit): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:14
Parameters
- deltaState: HistoryStateInit
Returns void

Protected willAddComponentManagerObserver

willAddComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.willAddComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:7
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected willAttach

willAttach(): void

Inherited from ComponentManager.willAttach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:17
Returns void

Protected willDetach

willDetach(): void

Inherited from ComponentManager.willDetach
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:20
Returns void

Protected willInsertRootComponent

willInsertRootComponent(rootComponent: C): void

Inherited from ComponentManager.willInsertRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:25
Parameters
- rootComponent: C
Returns void

Protected willObserve

willObserve<T>(callback: (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>) => void | T): undefined | T

Inherited from ComponentManager.willObserve
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:14
Type parameters
- T
Parameters
- callback: (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>) => void | T
  - - (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void | T
    - Parameters
      - componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
      Returns void | T
Returns undefined | T

Protected willPopHistory

willPopHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:19
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willPushHistory

willPushHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:11
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Protected willRemoveComponentManagerObserver

willRemoveComponentManagerObserver(componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>): void

Inherited from ComponentManager.willRemoveComponentManagerObserver
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:11
Parameters
- componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>
Returns void

Protected willRemoveRootComponent

willRemoveRootComponent(rootComponent: C): void

Inherited from ComponentManager.willRemoveRootComponent
- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/manager/ComponentManager.d.ts:29
Parameters
- rootComponent: C
Returns void

Protected willReplaceHistory

willReplaceHistory(newState: HistoryState, oldState: HistoryState): void

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:15
Parameters
- newState: HistoryState
- oldState: HistoryState
Returns void

Static global

global<C>(): HistoryManager<C>

- Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryManager.d.ts:27
Type parameters
- C: Component<C>
Returns HistoryManager<C>

Type parameters

C: Component = Component

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

C: Component<C> = Component

Returns HistoryManager<C>

Properties

Readonly componentManagerObservers

Readonly historyState

Readonly rootComponents

Accessors

historyUri

Returns Uri

Methods

addComponentManagerObserver

Parameters

componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>

Returns void

Protected attachEvents

Returns void

Protected detachEvents

Returns void

Protected didAddComponentManagerObserver

Parameters

componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>

Returns void

Protected didAttach

Returns void

Protected didDetach

Returns void

Protected didInsertRootComponent

Parameters

rootComponent: C

Returns void

Protected didObserve

Type parameters

T

Parameters

callback: (componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>) => void | T

Parameters

componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>

Returns void | T

Returns undefined | T

Protected didPopHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

Protected didPushHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

Protected didRemoveComponentManagerObserver

Parameters

componentManagerObserver: HistoryManagerObserver<Component, HistoryManager<Component>>

Returns void

Protected didRemoveRootComponent

Parameters

rootComponent: C

Returns void

Protected didReplaceHistory

Parameters

newState: HistoryState

oldState: HistoryState

Returns void

insertRootComponent

Parameters

rootComponent: C

Returns void

isAttached

Returns boolean

Protected onAddComponentManagerObserver