@swim/component

@swim/component provides componentized controller layer with application lifecycle and service management. @swim/component is part of the @swim/ui framework.

For an npm-managed project, npm install @swim/component to make it a dependency. TypeScript sources will be installed into node_modules/@swim/component/main. Transpiled JavaScript and TypeScript definition files install into node_modules/@swim/component/lib/main. And a pre-built UMD script can be found in node_modules/@swim/component/dist/main/swim-component.js.

Browser

Browser applications can load swim-ui.js—which bundles the @swim/component library—along with its swim-core.js and swim-mesh.js dependencies, directly from the SwimOS CDN.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-core.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-mesh.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-core.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-mesh.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-ui.min.js"></script>

Alternatively, the swim-toolkit.js script may be loaded, along with its swim-system.js dependency, from the SwimOS CDN. The swim-toolkit.js script bundles @swim/component together with all other @swim/toolkit frameworks.

<!-- Development -->
<script src="https://cdn.swimos.org/js/latest/swim-system.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.js"></script>

<!-- Production -->
<script src="https://cdn.swimos.org/js/latest/swim-system.min.js"></script>
<script src="https://cdn.swimos.org/js/latest/swim-toolkit.min.js"></script>

Usage

ES6/TypeScript

@swim/component can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

import * as component from "@swim/component";

CommonJS/Node.js

@swim/component can also be used as a CommonJS module in Node.js applications.

var component = require("@swim/component");

Browser

When loaded by a web browser, the swim-ui.js script adds all @swim/component library exports to the global swim namespace. The swim-ui.js script requires that swim-core.js and swim-mesh.js have already been loaded.

The swim-toolkit.js script also adds all @swim/component library exports to the global swim namespace, making it a drop-in replacement for swim-ui.js and swim-component.js when additional @swim/toolkit frameworks are needed.

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

ComponentContextType

ComponentContextType<C>: C extends { componentContext: infer C } ? C : unknown

Type parameters

C: Component

ComponentFastenerDescriptor

ComponentFastenerDescriptor<C, S, U, I>: ComponentFastenerInit<S, U> & ThisType<ComponentFastener<C, S, U> & I> & Partial

Type parameters

C: Component
S: Component
U = never
I = {}

ComponentFastenerFlags

ComponentFastenerFlags: number

ComponentFastenerMemberInit

ComponentFastenerMemberInit<C, K>: C[K] extends ComponentFastener<any, infer T, infer U> ? T | U : never

Type parameters

C
K: keyof C

ComponentFastenerMemberType

ComponentFastenerMemberType<C, K>: C[K] extends ComponentFastener<any, infer S, any> ? S : never

Type parameters

C
K: keyof C

ComponentFlags

ComponentFlags: number

ComponentManagerObserverType

ComponentManagerObserverType<CM>: CM extends { componentManagerObservers: ReadonlyArray<infer CMO> } ? CMO : never

Type parameters

CM: ComponentManager

ComponentModelDescriptor

ComponentModelDescriptor<C, M, U, I>: ComponentModelInit<M, U> & ThisType<ComponentModel<C, M, U> & I> & Partial

Type parameters

C: Component
M: Model
U = never
I = {}

ComponentModelFlags

ComponentModelFlags: number

ComponentModelMemberInit

ComponentModelMemberInit<C, K>: C[K] extends ComponentModel<any, infer M, infer U> ? M | U : never

Type parameters

C
K: keyof C

ComponentModelMemberType

ComponentModelMemberType<C, K>: C[K] extends ComponentModel<any, infer M, any> ? M : never

Type parameters

C
K: keyof C

ComponentObserverType

ComponentObserverType<C>: C extends { componentObservers: ReadonlyArray<infer CO> } ? CO : never

Type parameters

C: Component

ComponentPrecedence

ComponentPrecedence: number

ComponentPropertyDescriptor

ComponentPropertyDescriptor<C, T, U, I>: ComponentPropertyInit<T, U> & ThisType<ComponentProperty<C, T, U> & I> & Partial

Type parameters

C: Component
T
U = never
I = {}

ComponentPropertyDescriptorExtends

ComponentPropertyDescriptorExtends<C, T, U, I>: { extends: ComponentPropertyClass | undefined } & ComponentPropertyDescriptor<C, T, U, I>

Type parameters

C: Component
T
U = never
I = {}

ComponentPropertyDescriptorFromAny

ComponentPropertyDescriptorFromAny<C, T, U, I>: { type: FromAny<T, U> } | { fromAny: any } & ComponentPropertyDescriptor<C, T, U, I>

Type parameters

C: Component
T
U = never
I = {}

ComponentPropertyFlags

ComponentPropertyFlags: number

ComponentPropertyMemberInit

ComponentPropertyMemberInit<C, K>: C[K] extends ComponentProperty<any, infer T, infer U> ? T | U : never

Type parameters

C
K: keyof C

ComponentPropertyMemberKey

ComponentPropertyMemberKey<C, K>: C[K] extends ComponentProperty<any, any> ? K : never

Type parameters

C
K: keyof C

ComponentPropertyMemberMap

ComponentPropertyMemberMap<C>: {-readonly [ K in keyof C as ComponentPropertyMemberKey<C, K>]-?: ComponentPropertyMemberInit<C, K> }

Type parameters

ComponentPropertyMemberType

ComponentPropertyMemberType<C, K>: C[K] extends ComponentProperty<any, infer T, any> ? T : never

Type parameters

C
K: keyof C

ComponentServiceDescriptor

ComponentServiceDescriptor<C, T, I>: ComponentServiceInit<T> & ThisType<ComponentService<C, T> & I> & Partial

Type parameters

C: Component
T
I = {}

ComponentServiceDescriptorExtends

ComponentServiceDescriptorExtends<C, T, I>: { extends: ComponentServiceClass | undefined } & ComponentServiceDescriptor<C, T, I>

Type parameters

C: Component
T
I = {}

ComponentServiceFlags

ComponentServiceFlags: number

ComponentServiceMemberType

ComponentServiceMemberType<C, K>: C[K] extends ComponentService<any, infer T> ? T : never

Type parameters

C
K: keyof C

ComponentTraitDescriptor

ComponentTraitDescriptor<C, R, U, I>: ComponentTraitInit<R, U> & ThisType<ComponentTrait<C, R, U> & I> & Partial

Type parameters

C: Component
R: Trait
U = never
I = {}

ComponentTraitFlags

ComponentTraitFlags: number

ComponentTraitMemberInit

ComponentTraitMemberInit<C, K>: C[K] extends ComponentTrait<any, infer R, infer U> ? R | U : never

Type parameters

C
K: keyof C

ComponentTraitMemberType

ComponentTraitMemberType<C, K>: C[K] extends ComponentTrait<any, infer R, any> ? R : never

Type parameters

C
K: keyof C

ComponentViewDescriptor

ComponentViewDescriptor<C, V, U, I>: ComponentViewInit<V, U> & ThisType<ComponentView<C, V, U> & I> & Partial

Type parameters

C: Component
V: View
U = never
I = {}

ComponentViewFlags

ComponentViewFlags: number

ComponentViewMemberInit

ComponentViewMemberInit<C, K>: C[K] extends ComponentView<any, infer V, infer U> ? V | U : never

Type parameters

C
K: keyof C

ComponentViewMemberType

ComponentViewMemberType<C, K>: C[K] extends ComponentView<any, infer V, any> ? V : never

Type parameters

C
K: keyof C

ComponentViewTraitDescriptor

ComponentViewTraitDescriptor<C, V, R, VU, RU, I>: ComponentViewTraitInit<V, R, VU, RU> & ThisType<ComponentViewTrait<C, V, R, VU, RU> & I> & Partial

Type parameters

C: Component
V: View
R: Trait
VU = never
RU = never
I = {}

ComponentViewTraitFlags

ComponentViewTraitFlags: number

Variables

ComponentContext

ComponentContext: { default: any }

Type declaration

default: function
- default(): ComponentContext
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/ComponentContext.d.ts:9
  Returns ComponentContext

ComponentFastener

ComponentFastener: { MountedFlag: number; prototype: ComponentFastener<any, any, never>; define: any }

Type declaration

- <C, S, U, I>(descriptor: { observe: boolean } & ComponentFastenerInit<S, U> & ThisType<ComponentFastener<C, S, U> & I & ComponentObserverType<S>> & Partial>): PropertyDecorator
- <C_1, S_1, U_1, I_1>(descriptor: ComponentFastenerDescriptor<C_1, S_1, U_1, I_1>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - S: Component<S> = Component
 - U = never
 - I = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentFastenerInit<S, U> & ThisType<ComponentFastener<C, S, U> & I & ComponentObserverType<S>> & Partial>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - S_1: Component<S_1> = Component
 - U_1 = never
 - I_1 = {}
 Parameters
 - descriptor: ComponentFastenerDescriptor<C_1, S_1, U_1, I_1>
 Returns PropertyDecorator
MountedFlag: number
prototype: ComponentFastener<any, any, never>
define: function
- define<C_3, S_3, U_3, I_2>(descriptor: { observe: boolean } & ComponentFastenerInit<S_3, U_3> & ThisType<ComponentFastener<C_3, S_3, U_3> & I_2 & ComponentObserverType<S_3>> & Partial<I_2 & ComponentObserverType<S_3>>): ComponentFastenerConstructor<C_3, S_3, U_3, I_2>
- define<C_4, S_4, U_4, I_3>(descriptor: ComponentFastenerDescriptor<C_4, S_4, U_4, I_3>): ComponentFastenerConstructor<C_4, S_4, U_4, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentFastener.d.ts:75
 Type parameters
 - C_3: Component<C_3>
 - S_3: Component<S_3> = Component
 - U_3 = never
 - I_2 = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentFastenerInit<S_3, U_3> & ThisType<ComponentFastener<C_3, S_3, U_3> & I_2 & ComponentObserverType<S_3>> & Partial<I_2 & ComponentObserverType<S_3>>
 Returns ComponentFastenerConstructor<C_3, S_3, U_3, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentFastener.d.ts:78
 Type parameters
 - C_4: Component<C_4>
 - S_4: Component<S_4> = Component
 - U_4 = never
 - I_3 = {}
 Parameters
 - descriptor: ComponentFastenerDescriptor<C_4, S_4, U_4, I_3>
 Returns ComponentFastenerConstructor<C_4, S_4, U_4, I_3>

ComponentModel

ComponentModel: { MountedFlag: number; prototype: ComponentModel<any, any, never>; define: any }

Type declaration

- <C, M, U, I>(descriptor: { observe: boolean } & ComponentModelInit<M, U> & ThisType<ComponentModel<C, M, U> & I & ModelObserverType<M>> & Partial>): PropertyDecorator
- <C_1, M_1, U_1, I_1>(descriptor: ComponentModelDescriptor<C_1, M_1, U_1, I_1>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - M: Model<M> = Model
 - U = never
 - I = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentModelInit<M, U> & ThisType<ComponentModel<C, M, U> & I & ModelObserverType<M>> & Partial>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - M_1: Model<M_1> = Model
 - U_1 = never
 - I_1 = {}
 Parameters
 - descriptor: ComponentModelDescriptor<C_1, M_1, U_1, I_1>
 Returns PropertyDecorator
MountedFlag: number
prototype: ComponentModel<any, any, never>
define: function
- define<C_3, M_3, U_3, I_2>(descriptor: { observe: boolean } & ComponentModelInit<M_3, U_3> & ThisType<ComponentModel<C_3, M_3, U_3> & I_2 & ModelObserverType<M_3>> & Partial<I_2 & ModelObserverType<M_3>>): ComponentModelConstructor<C_3, M_3, U_3, I_2>
- define<C_4, M_4, U_4, I_3>(descriptor: ComponentModelDescriptor<C_4, M_4, U_4, I_3>): ComponentModelConstructor<C_4, M_4, U_4, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentModel.d.ts:70
 Type parameters
 - C_3: Component<C_3>
 - M_3: Model<M_3> = Model
 - U_3 = never
 - I_2 = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentModelInit<M_3, U_3> & ThisType<ComponentModel<C_3, M_3, U_3> & I_2 & ModelObserverType<M_3>> & Partial<I_2 & ModelObserverType<M_3>>
 Returns ComponentModelConstructor<C_3, M_3, U_3, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentModel.d.ts:73
 Type parameters
 - C_4: Component<C_4>
 - M_4: Model<M_4> = Model
 - U_4 = never
 - I_3 = {}
 Parameters
 - descriptor: ComponentModelDescriptor<C_4, M_4, U_4, I_3>
 Returns ComponentModelConstructor<C_4, M_4, U_4, I_3>

ComponentProperty

ComponentProperty: { InheritedFlag: number; MountedFlag: number; OverrideFlag: number; UpdatedFlag: number; prototype: ComponentProperty<any, any, never>; define: any; getConstructor: any }

Type declaration

- <C, T, U>(descriptor: { type: StringConstructor } & ComponentPropertyInit<T, U> & ThisType<ComponentProperty<C, T, U>> & Partial<{}>): PropertyDecorator
- <C_1, T_1, U_1>(descriptor: { type: BooleanConstructor } & ComponentPropertyInit<T_1, U_1> & ThisType<ComponentProperty<C_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <C_2, T_2, U_2>(descriptor: { type: NumberConstructor } & ComponentPropertyInit<T_2, U_2> & ThisType<ComponentProperty<C_2, T_2, U_2>> & Partial<{}>): PropertyDecorator
- <C_3, T_3, U_3>(descriptor: ComponentPropertyDescriptorFromAny<C_3, T_3, U_3, {}>): PropertyDecorator
- <C_4, T_4, U_4, I>(descriptor: ComponentPropertyDescriptorExtends<C_4, T_4, U_4, I>): PropertyDecorator
- <C_5, T_5, U_5>(descriptor: ComponentPropertyDescriptor<C_5, T_5, U_5, {}>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - T: undefined | string = undefined | string
 - U: undefined | string = undefined | string
 Parameters
 - descriptor: { type: StringConstructor } & ComponentPropertyInit<T, U> & ThisType<ComponentProperty<C, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - T_1: undefined | boolean = undefined | boolean
 - U_1: undefined | string | boolean = undefined | string | boolean
 Parameters
 - descriptor: { type: BooleanConstructor } & ComponentPropertyInit<T_1, U_1> & ThisType<ComponentProperty<C_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - C_2: Component<C_2>
 - T_2: undefined | number = undefined | number
 - U_2: undefined | string | number = undefined | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & ComponentPropertyInit<T_2, U_2> & ThisType<ComponentProperty<C_2, T_2, U_2>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - C_3: Component<C_3>
 - T_3
 - U_3 = never
 Parameters
 - descriptor: ComponentPropertyDescriptorFromAny<C_3, T_3, U_3, {}>
 Returns PropertyDecorator
- Type parameters
 - C_4: Component<C_4>
 - T_4
 - U_4 = never
 - I = {}
 Parameters
 - descriptor: ComponentPropertyDescriptorExtends<C_4, T_4, U_4, I>
 Returns PropertyDecorator
- Type parameters
 - C_5: Component<C_5>
 - T_5
 - U_5 = never
 Parameters
 - descriptor: ComponentPropertyDescriptor<C_5, T_5, U_5, {}>
 Returns PropertyDecorator
InheritedFlag: number
MountedFlag: number
OverrideFlag: number
UpdatedFlag: number
prototype: ComponentProperty<any, any, never>
define: function
- define<C_7, T_7, U_7, I_1>(descriptor: ComponentPropertyDescriptorExtends<C_7, T_7, U_7, I_1>): ComponentPropertyConstructor<C_7, T_7, U_7, I_1>
- define<C_8, T_8, U_8>(descriptor: ComponentPropertyDescriptor<C_8, T_8, U_8, {}>): ComponentPropertyConstructor<C_8, T_8, U_8, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:109
 Type parameters
 - C_7: Component<C_7>
 - T_7
 - U_7 = never
 - I_1 = {}
 Parameters
 - descriptor: ComponentPropertyDescriptorExtends<C_7, T_7, U_7, I_1>
 Returns ComponentPropertyConstructor<C_7, T_7, U_7, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:110
 Type parameters
 - C_8: Component<C_8>
 - T_8
 - U_8 = never
 Parameters
 - descriptor: ComponentPropertyDescriptor<C_8, T_8, U_8, {}>
 Returns ComponentPropertyConstructor<C_8, T_8, U_8, {}>
getConstructor: function
- getConstructor(type: unknown): null | ComponentPropertyClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/property/ComponentProperty.d.ts:108
  Parameters
  - type: unknown
  Returns null | ComponentPropertyClass

ComponentService

ComponentService: { InheritedFlag: number; prototype: ComponentService<any, any>; define: any; getClass: any }

Type declaration

- <C, T>(descriptor: { type: typeof ExecuteManager } & ComponentServiceInit<T> & ThisType<ComponentService<C, T> & ComponentManagerObserverType<T>> & Partial<ComponentManagerObserverType<T>>): PropertyDecorator
- <C_1, T_1>(descriptor: { type: typeof HistoryManager } & ComponentServiceInit<T_1> & ThisType<ComponentService<C_1, T_1> & ComponentManagerObserverType<T_1>> & Partial<ComponentManagerObserverType<T_1>>): PropertyDecorator
- <C_2, T_2>(descriptor: { type: typeof StorageManager } & ComponentServiceInit<T_2> & ThisType<ComponentService<C_2, T_2> & ComponentManagerObserverType<T_2>> & Partial<ComponentManagerObserverType<T_2>>): PropertyDecorator
- <C_3, T_3>(descriptor: { type: typeof ComponentManager } & ComponentServiceInit<T_3> & ThisType<ComponentService<C_3, T_3> & ComponentManagerObserverType<T_3>> & Partial<ComponentManagerObserverType<T_3>>): PropertyDecorator
- <C_4, T_4, I>(descriptor: ComponentServiceDescriptorExtends<C_4, T_4, I>): PropertyDecorator
- <C_5, T_5>(descriptor: ComponentServiceDescriptor<C_5, T_5, {}>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - T: ExecuteManager<Component, T> = ExecuteManager<Component>
 Parameters
 - descriptor: { type: typeof ExecuteManager } & ComponentServiceInit<T> & ThisType<ComponentService<C, T> & ComponentManagerObserverType<T>> & Partial<ComponentManagerObserverType<T>>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - T_1: HistoryManager<Component, T_1> = HistoryManager<Component>
 Parameters
 - descriptor: { type: typeof HistoryManager } & ComponentServiceInit<T_1> & ThisType<ComponentService<C_1, T_1> & ComponentManagerObserverType<T_1>> & Partial<ComponentManagerObserverType<T_1>>
 Returns PropertyDecorator
- Type parameters
 - C_2: Component<C_2>
 - T_2: StorageManager<Component, T_2> = StorageManager<Component>
 Parameters
 - descriptor: { type: typeof StorageManager } & ComponentServiceInit<T_2> & ThisType<ComponentService<C_2, T_2> & ComponentManagerObserverType<T_2>> & Partial<ComponentManagerObserverType<T_2>>
 Returns PropertyDecorator
- Type parameters
 - C_3: Component<C_3>
 - T_3: ComponentManager<Component, T_3> = ComponentManager<Component>
 Parameters
 - descriptor: { type: typeof ComponentManager } & ComponentServiceInit<T_3> & ThisType<ComponentService<C_3, T_3> & ComponentManagerObserverType<T_3>> & Partial<ComponentManagerObserverType<T_3>>
 Returns PropertyDecorator
- Type parameters
 - C_4: Component<C_4>
 - T_4
 - I = {}
 Parameters
 - descriptor: ComponentServiceDescriptorExtends<C_4, T_4, I>
 Returns PropertyDecorator
- Type parameters
 - C_5: Component<C_5>
 - T_5
 Parameters
 - descriptor: ComponentServiceDescriptor<C_5, T_5, {}>
 Returns PropertyDecorator
InheritedFlag: number
prototype: ComponentService<any, any>
define: function
- define<C_7, T_7, I_1>(descriptor: ComponentServiceDescriptorExtends<C_7, T_7, I_1>): ComponentServiceConstructor<C_7, T_7, I_1>
- define<C_8, T_8>(descriptor: ComponentServiceDescriptor<C_8, T_8, {}>): ComponentServiceConstructor<C_8, T_8, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:70
 Type parameters
 - C_7: Component<C_7>
 - T_7
 - I_1 = {}
 Parameters
 - descriptor: ComponentServiceDescriptorExtends<C_7, T_7, I_1>
 Returns ComponentServiceConstructor<C_7, T_7, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:71
 Type parameters
 - C_8: Component<C_8>
 - T_8
 Parameters
 - descriptor: ComponentServiceDescriptor<C_8, T_8, {}>
 Returns ComponentServiceConstructor<C_8, T_8, {}>
getClass: function
- getClass(type: unknown): null | ComponentServiceClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/service/ComponentService.d.ts:69
  Parameters
  - type: unknown
  Returns null | ComponentServiceClass

ComponentTrait

ComponentTrait: { MountedFlag: number; prototype: ComponentTrait<any, any, never>; define: any }

Type declaration

- <C, R, U, I>(descriptor: { observe: boolean } & ComponentTraitInit<R, U> & ThisType<ComponentTrait<C, R, U> & I & TraitObserverType<R>> & Partial>): PropertyDecorator
- <C_1, R_1, U_1, I_1>(descriptor: ComponentTraitDescriptor<C_1, R_1, U_1, I_1>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - R: Trait<R> = Trait
 - U = never
 - I = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentTraitInit<R, U> & ThisType<ComponentTrait<C, R, U> & I & TraitObserverType<R>> & Partial>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - R_1: Trait<R_1> = Trait
 - U_1 = never
 - I_1 = {}
 Parameters
 - descriptor: ComponentTraitDescriptor<C_1, R_1, U_1, I_1>
 Returns PropertyDecorator
MountedFlag: number
prototype: ComponentTrait<any, any, never>
define: function
- define<C_3, R_3, U_3, I_2>(descriptor: { observe: boolean } & ComponentTraitInit<R_3, U_3> & ThisType<ComponentTrait<C_3, R_3, U_3> & I_2 & TraitObserverType<R_3>> & Partial<I_2 & TraitObserverType<R_3>>): ComponentTraitConstructor<C_3, R_3, U_3, I_2>
- define<C_4, R_4, U_4, I_3>(descriptor: ComponentTraitDescriptor<C_4, R_4, U_4, I_3>): ComponentTraitConstructor<C_4, R_4, U_4, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentTrait.d.ts:70
 Type parameters
 - C_3: Component<C_3>
 - R_3: Trait<R_3> = Trait
 - U_3 = never
 - I_2 = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentTraitInit<R_3, U_3> & ThisType<ComponentTrait<C_3, R_3, U_3> & I_2 & TraitObserverType<R_3>> & Partial<I_2 & TraitObserverType<R_3>>
 Returns ComponentTraitConstructor<C_3, R_3, U_3, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentTrait.d.ts:73
 Type parameters
 - C_4: Component<C_4>
 - R_4: Trait<R_4> = Trait
 - U_4 = never
 - I_3 = {}
 Parameters
 - descriptor: ComponentTraitDescriptor<C_4, R_4, U_4, I_3>
 Returns ComponentTraitConstructor<C_4, R_4, U_4, I_3>

ComponentView

ComponentView: { MountedFlag: number; prototype: ComponentView<any, any, never>; define: any }

Type declaration

- <C, V, U, I>(descriptor: { observe: boolean } & ComponentViewInit<V, U> & ThisType<ComponentView<C, V, U> & I & ViewObserverType<V>> & Partial>): PropertyDecorator
- <C_1, V_1, U_1, I_1>(descriptor: ComponentViewDescriptor<C_1, V_1, U_1, I_1>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - V: View<V> = View
 - U = never
 - I = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentViewInit<V, U> & ThisType<ComponentView<C, V, U> & I & ViewObserverType<V>> & Partial>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - V_1: View<V_1> = View
 - U_1 = never
 - I_1 = {}
 Parameters
 - descriptor: ComponentViewDescriptor<C_1, V_1, U_1, I_1>
 Returns PropertyDecorator
MountedFlag: number
prototype: ComponentView<any, any, never>
define: function
- define<C_3, V_3, U_3, I_2>(descriptor: { observe: boolean } & ComponentViewInit<V_3, U_3> & ThisType<ComponentView<C_3, V_3, U_3> & I_2 & ViewObserverType<V_3>> & Partial<I_2 & ViewObserverType<V_3>>): ComponentViewConstructor<C_3, V_3, U_3, I_2>
- define<C_4, V_4, U_4, I_3>(descriptor: ComponentViewDescriptor<C_4, V_4, U_4, I_3>): ComponentViewConstructor<C_4, V_4, U_4, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentView.d.ts:70
 Type parameters
 - C_3: Component<C_3>
 - V_3: View<V_3> = View
 - U_3 = never
 - I_2 = {}
 Parameters
 - descriptor: { observe: boolean } & ComponentViewInit<V_3, U_3> & ThisType<ComponentView<C_3, V_3, U_3> & I_2 & ViewObserverType<V_3>> & Partial<I_2 & ViewObserverType<V_3>>
 Returns ComponentViewConstructor<C_3, V_3, U_3, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentView.d.ts:73
 Type parameters
 - C_4: Component<C_4>
 - V_4: View<V_4> = View
 - U_4 = never
 - I_3 = {}
 Parameters
 - descriptor: ComponentViewDescriptor<C_4, V_4, U_4, I_3>
 Returns ComponentViewConstructor<C_4, V_4, U_4, I_3>

ComponentViewTrait

ComponentViewTrait: { MountedFlag: number; prototype: ComponentViewTrait<any, any, any, any, never>; define: any }

Type declaration

- <C, V, R, VU, RU, I>(descriptor: { observeTrait: boolean; observeView: boolean } & ComponentViewTraitInit<V, R, VU, RU> & ThisType<ComponentViewTrait<C, V, R, VU, RU> & I & ViewObserverType<V> & TraitObserverType<R>> & Partial & TraitObserverType<R>>): PropertyDecorator
- <C_1, V_1, R_1, VU_1, RU_1, I_1>(descriptor: { observeView: boolean } & ComponentViewTraitInit<V_1, R_1, VU_1, RU_1> & ThisType<ComponentViewTrait<C_1, V_1, R_1, VU_1, RU_1> & I_1 & ViewObserverType<V_1>> & Partial<I_1 & ViewObserverType<V_1>>): PropertyDecorator
- <C_2, V_2, R_2, VU_2, RU_2, I_2>(descriptor: { observeTrait: boolean } & ComponentViewTraitInit<V_2, R_2, VU_2, RU_2> & ThisType<ComponentViewTrait<C_2, V_2, R_2, VU_2, RU_2> & I_2 & TraitObserverType<R_2>> & Partial<I_2 & TraitObserverType<R_2>>): PropertyDecorator
- <C_3, V_3, R_3, VU_3, RU_3, I_3>(descriptor: ComponentViewTraitDescriptor<C_3, V_3, R_3, VU_3, RU_3, I_3>): PropertyDecorator
- Type parameters
 - C: Component<C>
 - V: View<V> = View
 - R: Trait<R> = Trait
 - VU = never
 - RU = never
 - I = {}
 Parameters
 - descriptor: { observeTrait: boolean; observeView: boolean } & ComponentViewTraitInit<V, R, VU, RU> & ThisType<ComponentViewTrait<C, V, R, VU, RU> & I & ViewObserverType<V> & TraitObserverType<R>> & Partial & TraitObserverType<R>>
 Returns PropertyDecorator
- Type parameters
 - C_1: Component<C_1>
 - V_1: View<V_1> = View
 - R_1: Trait<R_1> = Trait
 - VU_1 = never
 - RU_1 = never
 - I_1 = {}
 Parameters
 - descriptor: { observeView: boolean } & ComponentViewTraitInit<V_1, R_1, VU_1, RU_1> & ThisType<ComponentViewTrait<C_1, V_1, R_1, VU_1, RU_1> & I_1 & ViewObserverType<V_1>> & Partial<I_1 & ViewObserverType<V_1>>
 Returns PropertyDecorator
- Type parameters
 - C_2: Component<C_2>
 - V_2: View<V_2> = View
 - R_2: Trait<R_2> = Trait
 - VU_2 = never
 - RU_2 = never
 - I_2 = {}
 Parameters
 - descriptor: { observeTrait: boolean } & ComponentViewTraitInit<V_2, R_2, VU_2, RU_2> & ThisType<ComponentViewTrait<C_2, V_2, R_2, VU_2, RU_2> & I_2 & TraitObserverType<R_2>> & Partial<I_2 & TraitObserverType<R_2>>
 Returns PropertyDecorator
- Type parameters
 - C_3: Component<C_3>
 - V_3: View<V_3> = View
 - R_3: Trait<R_3> = Trait
 - VU_3 = never
 - RU_3 = never
 - I_3 = {}
 Parameters
 - descriptor: ComponentViewTraitDescriptor<C_3, V_3, R_3, VU_3, RU_3, I_3>
 Returns PropertyDecorator
MountedFlag: number
prototype: ComponentViewTrait<any, any, any, any, never>
define: function
- define<C_5, V_5, R_5, VU_5, RU_5, I_4>(descriptor: { observeTrait: boolean; observeView: boolean } & ComponentViewTraitInit<V_5, R_5, VU_5, RU_5> & ThisType<ComponentViewTrait<C_5, V_5, R_5, VU_5, RU_5> & I_4 & ViewObserverType<V_5> & TraitObserverType<R_5>> & Partial<I_4 & ViewObserverType<V_5> & TraitObserverType<R_5>>): ComponentViewTraitConstructor<C_5, V_5, R_5, VU_5, RU_5, I_4>
- define<C_6, V_6, R_6, VU_6, RU_6, I_5>(descriptor: { observeView: boolean } & ComponentViewTraitInit<V_6, R_6, VU_6, RU_6> & ThisType<ComponentViewTrait<C_6, V_6, R_6, VU_6, RU_6> & I_5 & ViewObserverType<V_6>> & Partial<I_5 & ViewObserverType<V_6>>): ComponentViewTraitConstructor<C_6, V_6, R_6, VU_6, RU_6, I_5>
- define<C_7, V_7, R_7, VU_7, RU_7, I_6>(descriptor: { observeTrait: boolean } & ComponentViewTraitInit<V_7, R_7, VU_7, RU_7> & ThisType<ComponentViewTrait<C_7, V_7, R_7, VU_7, RU_7> & I_6 & TraitObserverType<R_7>> & Partial<I_6 & TraitObserverType<R_7>>): ComponentViewTraitConstructor<C_7, V_7, R_7, VU_7, RU_7, I_6>
- define<C_8, V_8, R_8, VU_8, RU_8, I_7>(descriptor: ComponentViewTraitDescriptor<C_8, V_8, R_8, VU_8, RU_8, I_7>): ComponentViewTraitConstructor<C_8, V_8, R_8, VU_8, RU_8, I_7>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentViewTrait.d.ts:100
 Type parameters
 - C_5: Component<C_5>
 - V_5: View<V_5> = View
 - R_5: Trait<R_5> = Trait
 - VU_5 = never
 - RU_5 = never
 - I_4 = {}
 Parameters
 - descriptor: { observeTrait: boolean; observeView: boolean } & ComponentViewTraitInit<V_5, R_5, VU_5, RU_5> & ThisType<ComponentViewTrait<C_5, V_5, R_5, VU_5, RU_5> & I_4 & ViewObserverType<V_5> & TraitObserverType<R_5>> & Partial<I_4 & ViewObserverType<V_5> & TraitObserverType<R_5>>
 Returns ComponentViewTraitConstructor<C_5, V_5, R_5, VU_5, RU_5, I_4>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentViewTrait.d.ts:104
 Type parameters
 - C_6: Component<C_6>
 - V_6: View<V_6> = View
 - R_6: Trait<R_6> = Trait
 - VU_6 = never
 - RU_6 = never
 - I_5 = {}
 Parameters
 - descriptor: { observeView: boolean } & ComponentViewTraitInit<V_6, R_6, VU_6, RU_6> & ThisType<ComponentViewTrait<C_6, V_6, R_6, VU_6, RU_6> & I_5 & ViewObserverType<V_6>> & Partial<I_5 & ViewObserverType<V_6>>
 Returns ComponentViewTraitConstructor<C_6, V_6, R_6, VU_6, RU_6, I_5>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentViewTrait.d.ts:107
 Type parameters
 - C_7: Component<C_7>
 - V_7: View<V_7> = View
 - R_7: Trait<R_7> = Trait
 - VU_7 = never
 - RU_7 = never
 - I_6 = {}
 Parameters
 - descriptor: { observeTrait: boolean } & ComponentViewTraitInit<V_7, R_7, VU_7, RU_7> & ThisType<ComponentViewTrait<C_7, V_7, R_7, VU_7, RU_7> & I_6 & TraitObserverType<R_7>> & Partial<I_6 & TraitObserverType<R_7>>
 Returns ComponentViewTraitConstructor<C_7, V_7, R_7, VU_7, RU_7, I_6>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/fastener/ComponentViewTrait.d.ts:110
 Type parameters
 - C_8: Component<C_8>
 - V_8: View<V_8> = View
 - R_8: Trait<R_8> = Trait
 - VU_8 = never
 - RU_8 = never
 - I_7 = {}
 Parameters
 - descriptor: ComponentViewTraitDescriptor<C_8, V_8, R_8, VU_8, RU_8, I_7>
 Returns ComponentViewTraitConstructor<C_8, V_8, R_8, VU_8, RU_8, I_7>

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/component/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/component/lib/main/history/HistoryState.d.ts:31
  Returns MutableHistoryState
empty: function
- empty(): HistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/lib/main/history/HistoryState.d.ts:30
  Returns HistoryState
fromUri: function
- fromUri(uri: AnyUri): HistoryState
- - Defined in swim-toolkit-js/swim-ui-js/@swim/component/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/component/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/component/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/component/lib/main/history/HistoryState.d.ts:32
  Parameters
  - delta: HistoryStateInit
  - Optional state: MutableHistoryState
  Returns MutableHistoryState

@swim/component

Installation

npm

Browser

Usage

ES6/TypeScript

CommonJS/Node.js

Browser

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

ComponentContextType

Type parameters

C: Component

ComponentFastenerDescriptor

Type parameters

C: Component

S: Component

U = never

I = {}

ComponentFastenerFlags

ComponentFastenerMemberInit

Type parameters

C

K: keyof C

ComponentFastenerMemberType

Type parameters

C

K: keyof C

ComponentFlags

ComponentManagerObserverType

Type parameters

CM: ComponentManager

ComponentModelDescriptor

Type parameters

C: Component

M: Model

U = never

I = {}

ComponentModelFlags

ComponentModelMemberInit

Type parameters

C

K: keyof C

ComponentModelMemberType

Type parameters

C

K: keyof C

ComponentObserverType

Type parameters

C: Component

ComponentPrecedence

ComponentPropertyDescriptor

Type parameters

C: Component

T

U = never

I = {}

ComponentPropertyDescriptorExtends

Type parameters

C: Component

T

U = never

I = {}

ComponentPropertyDescriptorFromAny

Type parameters

C: Component

T

U = never

I = {}

ComponentPropertyFlags

ComponentPropertyMemberInit

Type parameters

C

K: keyof C

ComponentPropertyMemberKey

Type parameters