Swim Controller Library

The Swim Controller library implements a componentized controller layer with application state and lifecycle management.

Index

Classes

Interfaces

Variables

Type aliases

AnyController

AnyController<C>: C | ControllerFactory<C> | InitType<C>

Type parameters

C: Controller = Controller

ControllerContextType

ControllerContextType<C>: C extends { contextType?: Class<infer T> } ? T : never

Type parameters

C: Controller

ControllerCreator

ControllerCreator<F, C>: abstract new (...args: any[]) => InstanceType<F> & Creatable<InstanceType<F>>

Type parameters

F: abstract new (...args: any[]) => C & Creatable<InstanceType<F>>
C: Controller = Controller

ControllerFlags

ControllerFlags: HierarchyFlags

ControllerRefDescriptor

ControllerRefDescriptor<O, C, I>: ThisType<ControllerRef<O, C> & I> & ControllerRefInit<C> & Partial

Type parameters

O = unknown
C: Controller = Controller
I = {}

ControllerRefType

ControllerRefType<F>: F extends ControllerRef<any, infer C> ? C : never

Type parameters

F: ControllerRef<any, any>

ControllerRelationDescriptor

ControllerRelationDescriptor<O, C, I>: ThisType<ControllerRelation<O, C> & I> & ControllerRelationInit<C> & Partial

Type parameters

O = unknown
C: Controller = Controller
I = {}

ControllerRelationType

ControllerRelationType<F>: F extends ControllerRelation<any, infer C> ? C : never

Type parameters

F: ControllerRelation<any, any>

ControllerSetDescriptor

ControllerSetDescriptor<O, C, I>: ThisType<ControllerSet<O, C> & I> & ControllerSetInit<C> & Partial

Type parameters

O = unknown
C: Controller = Controller
I = {}

ControllerSetType

ControllerSetType<F>: F extends ControllerSet<any, infer C> ? C : never

Type parameters

F: ControllerSet<any, any>

TraitControllerRefDescriptor

TraitControllerRefDescriptor<O, T, C, I>: ThisType<TraitControllerRef<O, T, C> & I> & TraitControllerRefInit<T, C> & Partial

Type parameters

O = unknown
T: Trait = Trait
C: Controller = Controller
I = {}

TraitControllerRefType

TraitControllerRefType<F>: F extends TraitControllerRef<any, any, infer C> ? C : never

Type parameters

F: TraitControllerRef<any, any, any>

TraitControllerSetDescriptor

TraitControllerSetDescriptor<O, T, C, I>: ThisType<TraitControllerSet<O, T, C> & I> & TraitControllerSetInit<T, C> & Partial

Type parameters

O = unknown
T: Trait = Trait
C: Controller = Controller
I = {}

TraitControllerSetType

TraitControllerSetType<F>: F extends TraitControllerSet<any, any, infer C> ? C : never

Type parameters

F: TraitControllerSet<any, any, any>

TraitViewControllerRefDescriptor

TraitViewControllerRefDescriptor<O, T, V, C, I>: ThisType<TraitViewControllerRef<O, T, V, C> & I> & TraitViewControllerRefInit<T, V, C> & Partial

Type parameters

O = unknown
T: Trait = Trait
V: View = View
C: Controller = Controller
I = {}

TraitViewControllerRefType

TraitViewControllerRefType<F>: F extends TraitViewControllerRef<any, any, any, infer C> ? C : never

Type parameters

F: TraitViewControllerRef<any, any, any, any>

TraitViewControllerSetDescriptor

TraitViewControllerSetDescriptor<O, T, V, C, I>: ThisType<TraitViewControllerSet<O, T, V, C> & I> & TraitViewControllerSetInit<T, V, C> & Partial

Type parameters

O = unknown
T: Trait = Trait
V: View = View
C: Controller = Controller
I = {}

TraitViewControllerSetType

TraitViewControllerSetType<F>: F extends TraitViewControllerSet<any, any, any, infer C> ? C : never

Type parameters

F: TraitViewControllerSet<any, any, any, any>

TraitViewRefDescriptor

TraitViewRefDescriptor<O, T, V, I>: ThisType<TraitViewRef<O, T, V> & I> & TraitViewRefInit<T, V> & Partial

Type parameters

O = unknown
T: Trait = Trait
V: View = View
I = {}

TraitViewRefTraitType

TraitViewRefTraitType<F>: F extends TraitViewRef<any, infer T, any> ? T : never

Type parameters

F: TraitViewRef<any, any, any>

TraitViewRefViewType

TraitViewRefViewType<F>: F extends TraitViewRef<any, any, infer V> ? V : never

Type parameters

F: TraitViewRef<any, any, any>

Variables

ControllerContext

ControllerContext: { current: null | ControllerContext; create: any }

Type declaration

current: null | ControllerContext
create: function
- create(): ControllerContext
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/controller/ControllerContext.d.ts:6
  Returns ControllerContext

ExecuteProvider

ExecuteProvider: ProviderClass<ExecuteProvider<any, any>>

HistoryProvider

HistoryProvider: ProviderClass<HistoryProvider<any, any>>

HistoryState

HistoryState: { cloned: any; current: any; empty: any; fromUri: any; fromUriFragment: any; toUri: any; updated: any }

Type declaration

cloned: function
- cloned(state: HistoryState): MutableHistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:33
  Parameters
  - state: HistoryState
  Returns MutableHistoryState
current: function
- current(): MutableHistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:31
  Returns MutableHistoryState
empty: function
- empty(): HistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:30
  Returns HistoryState
fromUri: function
- fromUri(uri: AnyUri): HistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:34
  Parameters
  - uri: AnyUri
  Returns HistoryState
fromUriFragment: function
- fromUriFragment(fragment: AnyUriFragment): HistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:35
  Parameters
  - fragment: AnyUriFragment
  Returns HistoryState
toUri: function
- toUri(state: HistoryState): Uri
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:36
  Parameters
  - state: HistoryState
  Returns Uri
updated: function
- updated(delta: HistoryStateInit, state?: MutableHistoryState): MutableHistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/controller/lib/main/history/HistoryState.d.ts:32
  Parameters
  - delta: HistoryStateInit
  - Optional state: MutableHistoryState
  Returns MutableHistoryState

StorageProvider

StorageProvider: ProviderClass<StorageProvider<any, any>>

TraitControllerRef

TraitControllerRef: TraitControllerRefFactory<TraitControllerRef<any, any, any>>

TraitControllerSet

TraitControllerSet: TraitControllerSetFactory<TraitControllerSet<any, any, any>>

TraitViewControllerRef

TraitViewControllerRef: TraitViewControllerRefFactory<TraitViewControllerRef<any, any, any, any>>

TraitViewControllerSet

TraitViewControllerSet: TraitViewControllerSetFactory<TraitViewControllerSet<any, any, any, any>>

TraitViewRef

TraitViewRef: TraitViewRefFactory<TraitViewRef<any, any, any>>

Swim Controller Library

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyController

Type parameters

C: Controller = Controller

ControllerContextType

Type parameters

C: Controller

ControllerCreator

Type parameters

F: abstract new (...args: any[]) => C & Creatable<InstanceType<F>>

C: Controller = Controller

ControllerFlags

ControllerRefDescriptor

Type parameters

O = unknown

C: Controller = Controller

I = {}

ControllerRefType

Type parameters

F: ControllerRef<any, any>

ControllerRelationDescriptor

Type parameters

O = unknown

C: Controller = Controller

I = {}

ControllerRelationType

Type parameters

F: ControllerRelation<any, any>

ControllerSetDescriptor

Type parameters

O = unknown

C: Controller = Controller

I = {}

ControllerSetType

Type parameters

F: ControllerSet<any, any>

TraitControllerRefDescriptor

Type parameters

O = unknown

T: Trait = Trait

C: Controller = Controller

I = {}

TraitControllerRefType

Type parameters

F: TraitControllerRef<any, any, any>

TraitControllerSetDescriptor

Type parameters

O = unknown

T: Trait = Trait

C: Controller = Controller

I = {}

TraitControllerSetType

Type parameters

F: TraitControllerSet<any, any, any>

TraitViewControllerRefDescriptor

Type parameters

O = unknown

T: Trait = Trait

V: View = View

C: Controller = Controller

I = {}

TraitViewControllerRefType

Type parameters

F: TraitViewControllerRef<any, any, any, any>

TraitViewControllerSetDescriptor

Type parameters

O = unknown

T: Trait = Trait

V: View = View

C: Controller = Controller

I = {}

TraitViewControllerSetType

Type parameters

F: TraitViewControllerSet<any, any, any, any>