@swim/view

@swim/view provides a unified HTML, SVG, and Canvas view hierarchy, with integrated controller architecture, animated procedural styling, and constraint-based layouts. @swim/view is part of the @swim/ui framework.

Installation

npm

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/view library—along with its swim-core.js dependency, 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-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-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/view 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/view can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

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

CommonJS/Node.js

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

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

Browser

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

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

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnimatorFlags

AnimatorFlags: number

GestureInputType

GestureInputType: "mouse" | "wheel" | "touch" | "pen" | "unknown"

ModalState

ModalState: "hidden" | "showing" | "shown" | "hiding"

ScaleGesture

ScaleGesture<X, Y, V>: AbstractScaleGesture<X, Y, V>

Type parameters

X
Y
V: View = View

ViewAnimatorConstraintDescriptor

ViewAnimatorConstraintDescriptor<V, T, U, I>: ViewAnimatorConstraintInit<T, U> & ThisType<ViewAnimatorConstraint<V, T, U> & I> & Partial

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorConstraintDescriptorExtends

ViewAnimatorConstraintDescriptorExtends<V, T, U, I>: { extends: ViewAnimatorConstraintClass | undefined } & ViewAnimatorConstraintDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorConstraintDescriptorFromAny

ViewAnimatorConstraintDescriptorFromAny<V, T, U, I>: { type: FromAny<T, U> } | { fromAny: any } & ViewAnimatorConstraintDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorDescriptor

ViewAnimatorDescriptor<V, T, U, I>: ViewAnimatorInit<T, U> & ThisType<ViewAnimator<V, T, U> & I> & Partial

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorDescriptorExtends

ViewAnimatorDescriptorExtends<V, T, U, I>: { extends: ViewAnimatorClass | undefined } & ViewAnimatorDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorDescriptorFromAny

ViewAnimatorDescriptorFromAny<V, T, U, I>: { type: FromAny<T, U> } | { fromAny: any } & ViewAnimatorDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewAnimatorMemberInit

ViewAnimatorMemberInit<V, K>: V[K] extends ViewAnimator<any, infer T, infer U> ? T | U : never

Type parameters

V
K: keyof V

ViewAnimatorMemberKey

ViewAnimatorMemberKey<V, K>: V[K] extends ViewAnimator<any, any> ? K : never

Type parameters

V
K: keyof V

ViewAnimatorMemberMap

ViewAnimatorMemberMap<V>: {-readonly [ K in keyof V as ViewAnimatorMemberKey<V, K>]-?: ViewAnimatorMemberInit<V, K> }

Type parameters

ViewAnimatorMemberType

ViewAnimatorMemberType<V, K>: V[K] extends ViewAnimator<any, infer T, any> ? T : never

Type parameters

V
K: keyof V

ViewColorScheme

ViewColorScheme: "dark" | "light" | "no-preference"

ViewContextType

ViewContextType<V>: V extends { viewContext: infer VC } ? VC : unknown

Type parameters

V: View

ViewControllerType

ViewControllerType<V>: V extends { viewController: infer VC | null } ? VC : never

Type parameters

V: View

ViewFastenerDescriptor

ViewFastenerDescriptor<V, S, U, I>: ViewFastenerInit<S, U> & ThisType<ViewFastener<V, S, U> & I> & Partial

Type parameters

V: View
S: View
U = never
I = {}

ViewFastenerFlags

ViewFastenerFlags: number

ViewFastenerMemberInit

ViewFastenerMemberInit<V, K>: V[K] extends ViewFastener<any, infer S, infer U> ? S | U : never

Type parameters

V
K: keyof V

ViewFastenerMemberType

ViewFastenerMemberType<V, K>: V[K] extends ViewFastener<any, infer S, any> ? S : never

Type parameters

V
K: keyof V

ViewFlags

ViewFlags: number

ViewIdiom

ViewIdiom: "unspecified" | "mobile" | "tablet" | "desktop"

ViewManagerObserverType

ViewManagerObserverType<VM>: VM extends { viewManagerObservers: ReadonlyArray<infer VMO> } ? VMO : never

Type parameters

VM: ViewManager

ViewMemberInit

ViewMemberInit<V, K>: V[K] extends ViewProperty<any, infer T, infer U> ? T | U : V[K] extends ViewAnimator<any, infer T, infer U> ? T | U : never

Type parameters

V
K: keyof V

ViewMemberKey

ViewMemberKey<V, K>: V[K] extends ViewProperty<any, any> ? K : V[K] extends ViewAnimator<any, any> ? K : never

Type parameters

V
K: keyof V

ViewMemberMap

ViewMemberMap<V>: {-readonly [ K in keyof V as ViewMemberKey<V, K>]-?: ViewMemberInit<V, K> }

Type parameters

ViewMemberType

ViewMemberType<V, K>: V[K] extends ViewProperty<any, infer T, any> ? T : V[K] extends ViewAnimator<any, infer T, any> ? T : never

Type parameters

V
K: keyof V

ViewObserverType

ViewObserverType<V>: V extends { viewObservers: ReadonlyArray<infer VO> } ? VO : never

Type parameters

V: View

ViewPrecedence

ViewPrecedence: number

ViewPropertyConstraintDescriptor

ViewPropertyConstraintDescriptor<V, T, U, I>: ViewPropertyConstraintInit<T, U> & ThisType<ViewPropertyConstraint<V, T, U> & I> & Partial

Type parameters

V: View
T
U = never
I = {}

ViewPropertyConstraintDescriptorExtends

ViewPropertyConstraintDescriptorExtends<V, T, U, I>: { extends: ViewPropertyConstraintClass | undefined } & ViewPropertyConstraintDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewPropertyConstraintDescriptorFromAny

ViewPropertyConstraintDescriptorFromAny<V, T, U, I>: { type: FromAny<T, U> } | { fromAny: any } & ViewPropertyConstraintDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewPropertyDescriptor

ViewPropertyDescriptor<V, T, U, I>: ViewPropertyInit<T, U> & ThisType<ViewProperty<V, T, U> & I> & Partial

Type parameters

V: View
T
U = never
I = {}

ViewPropertyDescriptorExtends

ViewPropertyDescriptorExtends<V, T, U, I>: { extends: ViewPropertyClass | undefined } & ViewPropertyDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewPropertyDescriptorFromAny

ViewPropertyDescriptorFromAny<V, T, U, I>: { type: FromAny<T, U> } | { fromAny: any } & ViewPropertyDescriptor<V, T, U, I>

Type parameters

V: View
T
U = never
I = {}

ViewPropertyFlags

ViewPropertyFlags: number

ViewPropertyMemberInit

ViewPropertyMemberInit<V, K>: V[K] extends ViewProperty<any, infer T, infer U> ? T | U : never

Type parameters

V
K: keyof V

ViewPropertyMemberKey

ViewPropertyMemberKey<V, K>: V[K] extends ViewProperty<any, any> ? K : never

Type parameters

V
K: keyof V

ViewPropertyMemberMap

ViewPropertyMemberMap<V>: {-readonly [ K in keyof V as ViewPropertyMemberKey<V, K>]-?: ViewPropertyMemberInit<V, K> }

Type parameters

ViewPropertyMemberType

ViewPropertyMemberType<V, K>: V[K] extends ViewProperty<any, infer T, any> ? T : never

Type parameters

V
K: keyof V

ViewServiceDescriptor

ViewServiceDescriptor<V, T, I>: ViewServiceInit<T> & ThisType<ViewService<V, T> & I> & Partial

Type parameters

V: View
T
I = {}

ViewServiceDescriptorExtends

ViewServiceDescriptorExtends<V, T, I>: { extends: ViewServiceClass | undefined } & ViewServiceDescriptor<V, T, I>

Type parameters

V: View
T
I = {}

ViewServiceFlags

ViewServiceFlags: number

ViewServiceMemberType

ViewServiceMemberType<V, K>: V[K] extends ViewService<any, infer T> ? T : never

Type parameters

V
K: keyof V

Variables

Modal

Modal: { is: any }

Type declaration

is: function
- is(object: unknown): object is Modal
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/modal/Modal.d.ts:16
  Parameters
  - object: unknown
  Returns object is Modal

MomentumGesture

MomentumGesture: typeof AbstractMomentumGesture

PositionGesture

PositionGesture: typeof AbstractPositionGesture

ScaleGesture

ScaleGesture: typeof AbstractScaleGesture

ViewAnimator

ViewAnimator: { prototype: ViewAnimator<any, any, never>; define: any; getClass: any }

Type declaration

- <V, T, U>(descriptor: { type: typeof Angle } & ViewAnimatorInit<T, U> & ThisType<ViewAnimator<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: typeof Length } & ViewAnimatorInit<T_1, U_1> & ThisType<ViewAnimator<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: { type: typeof Color } & ViewAnimatorInit<T_2, U_2> & ThisType<ViewAnimator<V_2, T_2, U_2>> & Partial<{}>): PropertyDecorator
- <V_3, T_3, U_3>(descriptor: { type: typeof Font } & ViewAnimatorInit<T_3, U_3> & ThisType<ViewAnimator<V_3, T_3, U_3>> & Partial<{}>): PropertyDecorator
- <V_4, T_4, U_4>(descriptor: { type: typeof Transform } & ViewAnimatorInit<T_4, U_4> & ThisType<ViewAnimator<V_4, T_4, U_4>> & Partial<{}>): PropertyDecorator
- <V_5, T_5, U_5>(descriptor: { type: StringConstructor } & ViewAnimatorInit<T_5, U_5> & ThisType<ViewAnimator<V_5, T_5, U_5>> & Partial<{}>): PropertyDecorator
- <V_6, T_6, U_6>(descriptor: { type: BooleanConstructor } & ViewAnimatorInit<T_6, U_6> & ThisType<ViewAnimator<V_6, T_6, U_6>> & Partial<{}>): PropertyDecorator
- <V_7, T_7, U_7>(descriptor: { type: NumberConstructor } & ViewAnimatorInit<T_7, U_7> & ThisType<ViewAnimator<V_7, T_7, U_7>> & Partial<{}>): PropertyDecorator
- <V_8, T_8, U_8>(descriptor: ViewAnimatorDescriptorFromAny<V_8, T_8, U_8, {}>): PropertyDecorator
- <V_9, T_9, U_9, I>(descriptor: ViewAnimatorDescriptorExtends<V_9, T_9, U_9, I>): PropertyDecorator
- <V_10, T_10, U_10>(descriptor: ViewAnimatorDescriptor<V_10, T_10, U_10, {}>): PropertyDecorator
- Type parameters
 - V: View<V>
 - T: undefined | null | Angle = undefined | null | Angle
 - U: undefined | null | AnyAngle = undefined | null | AnyAngle
 Parameters
 - descriptor: { type: typeof Angle } & ViewAnimatorInit<T, U> & ThisType<ViewAnimator<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - T_1: undefined | null | Length = undefined | null | Length
 - U_1: undefined | null | AnyLength = undefined | null | AnyLength
 Parameters
 - descriptor: { type: typeof Length } & ViewAnimatorInit<T_1, U_1> & ThisType<ViewAnimator<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: View<V_2>
 - T_2: undefined | null | Color = undefined | null | Color
 - U_2: undefined | null | AnyColor = undefined | null | AnyColor
 Parameters
 - descriptor: { type: typeof Color } & ViewAnimatorInit<T_2, U_2> & ThisType<ViewAnimator<V_2, T_2, U_2>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_3: View<V_3>
 - T_3: undefined | null | Font = undefined | null | Font
 - U_3: undefined | null | AnyFont = undefined | null | AnyFont
 Parameters
 - descriptor: { type: typeof Font } & ViewAnimatorInit<T_3, U_3> & ThisType<ViewAnimator<V_3, T_3, U_3>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_4: View<V_4>
 - T_4: undefined | null | Transform = undefined | null | Transform
 - U_4: undefined | null | AnyTransform = undefined | null | AnyTransform
 Parameters
 - descriptor: { type: typeof Transform } & ViewAnimatorInit<T_4, U_4> & ThisType<ViewAnimator<V_4, T_4, U_4>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_5: View<V_5>
 - T_5: undefined | null | string = undefined | null | string
 - U_5: undefined | null | string = undefined | null | string
 Parameters
 - descriptor: { type: StringConstructor } & ViewAnimatorInit<T_5, U_5> & ThisType<ViewAnimator<V_5, T_5, U_5>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_6: View<V_6>
 - T_6: undefined | null | boolean = undefined | null | boolean
 - U_6: undefined | null | string | boolean = undefined | null | string | boolean
 Parameters
 - descriptor: { type: BooleanConstructor } & ViewAnimatorInit<T_6, U_6> & ThisType<ViewAnimator<V_6, T_6, U_6>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_7: View<V_7>
 - T_7: undefined | null | number = undefined | null | number
 - U_7: undefined | null | string | number = undefined | null | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & ViewAnimatorInit<T_7, U_7> & ThisType<ViewAnimator<V_7, T_7, U_7>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_8: View<V_8>
 - T_8
 - U_8 = never
 Parameters
 - descriptor: ViewAnimatorDescriptorFromAny<V_8, T_8, U_8, {}>
 Returns PropertyDecorator
- Type parameters
 - V_9: View<V_9>
 - T_9
 - U_9 = never
 - I = {}
 Parameters
 - descriptor: ViewAnimatorDescriptorExtends<V_9, T_9, U_9, I>
 Returns PropertyDecorator
- Type parameters
 - V_10: View<V_10>
 - T_10
 - U_10 = never
 Parameters
 - descriptor: ViewAnimatorDescriptor<V_10, T_10, U_10, {}>
 Returns PropertyDecorator
prototype: ViewAnimator<any, any, never>
define: function
- define<V_12, T_12, U_12, I_1>(descriptor: ViewAnimatorDescriptorExtends<V_12, T_12, U_12, I_1>): ViewAnimatorConstructor<V_12, T_12, U_12, I_1>
- define<V_13, T_13, U_13>(descriptor: ViewAnimatorDescriptor<V_13, T_13, U_13, {}>): ViewAnimatorConstructor<V_13, T_13, U_13, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimator.d.ts:130
 Type parameters
 - V_12: View<V_12>
 - T_12
 - U_12 = never
 - I_1 = {}
 Parameters
 - descriptor: ViewAnimatorDescriptorExtends<V_12, T_12, U_12, I_1>
 Returns ViewAnimatorConstructor<V_12, T_12, U_12, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimator.d.ts:131
 Type parameters
 - V_13: View<V_13>
 - T_13
 - U_13 = never
 Parameters
 - descriptor: ViewAnimatorDescriptor<V_13, T_13, U_13, {}>
 Returns ViewAnimatorConstructor<V_13, T_13, U_13, {}>
getClass: function
- getClass(type: unknown): null | ViewAnimatorClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimator.d.ts:129
  Parameters
  - type: unknown
  Returns null | ViewAnimatorClass

ViewAnimatorConstraint

ViewAnimatorConstraint: { prototype: ViewAnimatorConstraint<any, any, never>; define: any; getClass: any }

Type declaration

- <V, T, U>(descriptor: { type: typeof Length } & ViewAnimatorConstraintInit<T, U> & ThisType<ViewAnimatorConstraint<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: NumberConstructor } & ViewAnimatorConstraintInit<T_1, U_1> & ThisType<ViewAnimatorConstraint<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: ViewAnimatorConstraintDescriptorFromAny<V_2, T_2, U_2, {}>): PropertyDecorator
- <V_3, T_3, U_3, I>(descriptor: ViewAnimatorConstraintDescriptorExtends<V_3, T_3, U_3, I>): PropertyDecorator
- <V_4, T_4, U_4>(descriptor: ViewAnimatorConstraintDescriptor<V_4, T_4, U_4, {}>): PropertyDecorator
- Type parameters
 - V: View<V>
 - T: undefined | null | Length = undefined | null | Length
 - U: undefined | null | AnyLength = undefined | null | AnyLength
 Parameters
 - descriptor: { type: typeof Length } & ViewAnimatorConstraintInit<T, U> & ThisType<ViewAnimatorConstraint<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - T_1: undefined | null | number = undefined | null | number
 - U_1: undefined | null | string | number = undefined | null | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & ViewAnimatorConstraintInit<T_1, U_1> & ThisType<ViewAnimatorConstraint<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: View<V_2>
 - T_2
 - U_2 = never
 Parameters
 - descriptor: ViewAnimatorConstraintDescriptorFromAny<V_2, T_2, U_2, {}>
 Returns PropertyDecorator
- Type parameters
 - V_3: View<V_3>
 - T_3
 - U_3 = never
 - I = {}
 Parameters
 - descriptor: ViewAnimatorConstraintDescriptorExtends<V_3, T_3, U_3, I>
 Returns PropertyDecorator
- Type parameters
 - V_4: View<V_4>
 - T_4
 - U_4 = never
 Parameters
 - descriptor: ViewAnimatorConstraintDescriptor<V_4, T_4, U_4, {}>
 Returns PropertyDecorator
prototype: ViewAnimatorConstraint<any, any, never>
define: function
- define<V_6, T_6, U_6, I_1>(descriptor: ViewAnimatorConstraintDescriptorExtends<V_6, T_6, U_6, I_1>): ViewAnimatorConstraintConstructor<V_6, T_6, U_6, I_1>
- define<V_7, T_7, U_7>(descriptor: ViewAnimatorConstraintDescriptor<V_7, T_7, U_7, {}>): ViewAnimatorConstraintConstructor<V_7, T_7, U_7, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimatorConstraint.d.ts:79
 Type parameters
 - V_6: View<V_6>
 - T_6
 - U_6 = never
 - I_1 = {}
 Parameters
 - descriptor: ViewAnimatorConstraintDescriptorExtends<V_6, T_6, U_6, I_1>
 Returns ViewAnimatorConstraintConstructor<V_6, T_6, U_6, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimatorConstraint.d.ts:80
 Type parameters
 - V_7: View<V_7>
 - T_7
 - U_7 = never
 Parameters
 - descriptor: ViewAnimatorConstraintDescriptor<V_7, T_7, U_7, {}>
 Returns ViewAnimatorConstraintConstructor<V_7, T_7, U_7, {}>
getClass: function
- getClass(type: unknown): null | ViewAnimatorConstraintClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/animator/ViewAnimatorConstraint.d.ts:78
  Parameters
  - type: unknown
  Returns null | ViewAnimatorConstraintClass

ViewContext

ViewContext: { default: any }

Type declaration

default: function
- default(): ViewContext
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/ViewContext.d.ts:13
  Returns ViewContext

ViewFastener

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

Type declaration

- <V, S, U, I>(descriptor: { observe: boolean } & ViewFastenerInit<S, U> & ThisType<ViewFastener<V, S, U> & I & ViewObserverType<S>> & Partial>): PropertyDecorator
- <V_1, S_1, U_1, I_1>(descriptor: ViewFastenerDescriptor<V_1, S_1, U_1, I_1>): PropertyDecorator
- Type parameters
 - V: View<V>
 - S: View<S> = View
 - U = never
 - I = {}
 Parameters
 - descriptor: { observe: boolean } & ViewFastenerInit<S, U> & ThisType<ViewFastener<V, S, U> & I & ViewObserverType<S>> & Partial>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - S_1: View<S_1> = View
 - U_1 = never
 - I_1 = {}
 Parameters
 - descriptor: ViewFastenerDescriptor<V_1, S_1, U_1, I_1>
 Returns PropertyDecorator
MountedFlag: number
prototype: ViewFastener<any, any, never>
define: function
- define<V_3, S_3, U_3, I_2>(descriptor: { observe: boolean } & ViewFastenerInit<S_3, U_3> & ThisType<ViewFastener<V_3, S_3, U_3> & I_2 & ViewObserverType<S_3>> & Partial<I_2 & ViewObserverType<S_3>>): ViewFastenerConstructor<V_3, S_3, U_3, I_2>
- define<V_4, S_4, U_4, I_3>(descriptor: ViewFastenerDescriptor<V_4, S_4, U_4, I_3>): ViewFastenerConstructor<V_4, S_4, U_4, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/fastener/ViewFastener.d.ts:93
 Type parameters
 - V_3: View<V_3>
 - S_3: View<S_3> = View
 - U_3 = never
 - I_2 = {}
 Parameters
 - descriptor: { observe: boolean } & ViewFastenerInit<S_3, U_3> & ThisType<ViewFastener<V_3, S_3, U_3> & I_2 & ViewObserverType<S_3>> & Partial<I_2 & ViewObserverType<S_3>>
 Returns ViewFastenerConstructor<V_3, S_3, U_3, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/fastener/ViewFastener.d.ts:96
 Type parameters
 - V_4: View<V_4>
 - S_4: View<S_4> = View
 - U_4 = never
 - I_3 = {}
 Parameters
 - descriptor: ViewFastenerDescriptor<V_4, S_4, U_4, I_3>
 Returns ViewFastenerConstructor<V_4, S_4, U_4, I_3>

ViewProperty

ViewProperty: { ConstrainedFlag: number; ConstrainingFlag: number; InheritedFlag: number; MountedFlag: number; OverrideFlag: number; UpdatedFlag: number; prototype: ViewProperty<any, any, never>; define: any; getClass: any }

Type declaration

- <V, T, U>(descriptor: { type: StringConstructor } & ViewPropertyInit<T, U> & ThisType<ViewProperty<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: BooleanConstructor } & ViewPropertyInit<T_1, U_1> & ThisType<ViewProperty<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: { type: NumberConstructor } & ViewPropertyInit<T_2, U_2> & ThisType<ViewProperty<V_2, T_2, U_2>> & Partial<{}>): PropertyDecorator
- <V_3, T_3, U_3>(descriptor: ViewPropertyDescriptorFromAny<V_3, T_3, U_3, {}>): PropertyDecorator
- <V_4, T_4, U_4, I>(descriptor: ViewPropertyDescriptorExtends<V_4, T_4, U_4, I>): PropertyDecorator
- <V_5, T_5, U_5>(descriptor: ViewPropertyDescriptor<V_5, T_5, U_5, {}>): PropertyDecorator
- Type parameters
 - V: View<V>
 - T: undefined | string = undefined | string
 - U: undefined | string = undefined | string
 Parameters
 - descriptor: { type: StringConstructor } & ViewPropertyInit<T, U> & ThisType<ViewProperty<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - T_1: undefined | boolean = undefined | boolean
 - U_1: undefined | string | boolean = undefined | string | boolean
 Parameters
 - descriptor: { type: BooleanConstructor } & ViewPropertyInit<T_1, U_1> & ThisType<ViewProperty<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: View<V_2>
 - T_2: undefined | number = undefined | number
 - U_2: undefined | string | number = undefined | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & ViewPropertyInit<T_2, U_2> & ThisType<ViewProperty<V_2, T_2, U_2>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_3: View<V_3>
 - T_3
 - U_3 = never
 Parameters
 - descriptor: ViewPropertyDescriptorFromAny<V_3, T_3, U_3, {}>
 Returns PropertyDecorator
- Type parameters
 - V_4: View<V_4>
 - T_4
 - U_4 = never
 - I = {}
 Parameters
 - descriptor: ViewPropertyDescriptorExtends<V_4, T_4, U_4, I>
 Returns PropertyDecorator
- Type parameters
 - V_5: View<V_5>
 - T_5
 - U_5 = never
 Parameters
 - descriptor: ViewPropertyDescriptor<V_5, T_5, U_5, {}>
 Returns PropertyDecorator
ConstrainedFlag: number
ConstrainingFlag: number
InheritedFlag: number
MountedFlag: number
OverrideFlag: number
UpdatedFlag: number
prototype: ViewProperty<any, any, never>
define: function
- define<V_7, T_7, U_7, I_1>(descriptor: ViewPropertyDescriptorExtends<V_7, T_7, U_7, I_1>): ViewPropertyConstructor<V_7, T_7, U_7, I_1>
- define<V_8, T_8, U_8>(descriptor: ViewPropertyDescriptor<V_8, T_8, U_8, {}>): ViewPropertyConstructor<V_8, T_8, U_8, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewProperty.d.ts:109
 Type parameters
 - V_7: View<V_7>
 - T_7
 - U_7 = never
 - I_1 = {}
 Parameters
 - descriptor: ViewPropertyDescriptorExtends<V_7, T_7, U_7, I_1>
 Returns ViewPropertyConstructor<V_7, T_7, U_7, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewProperty.d.ts:110
 Type parameters
 - V_8: View<V_8>
 - T_8
 - U_8 = never
 Parameters
 - descriptor: ViewPropertyDescriptor<V_8, T_8, U_8, {}>
 Returns ViewPropertyConstructor<V_8, T_8, U_8, {}>
getClass: function
- getClass(type: unknown): null | ViewPropertyClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewProperty.d.ts:108
  Parameters
  - type: unknown
  Returns null | ViewPropertyClass

ViewPropertyConstraint

ViewPropertyConstraint: { prototype: ViewPropertyConstraint<any, any, never>; define: any; getClass: any }

Type declaration

- <V, T, U>(descriptor: { type: NumberConstructor } & ViewPropertyConstraintInit<T, U> & ThisType<ViewPropertyConstraint<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: ViewPropertyConstraintDescriptorFromAny<V_1, T_1, U_1, {}>): PropertyDecorator
- <V_2, T_2, U_2, I>(descriptor: ViewPropertyConstraintDescriptorExtends<V_2, T_2, U_2, I>): PropertyDecorator
- <V_3, T_3, U_3>(descriptor: ViewPropertyConstraintDescriptor<V_3, T_3, U_3, {}>): PropertyDecorator
- Type parameters
 - V: View<V>
 - T: undefined | null | number = undefined | null | number
 - U: undefined | null | string | number = undefined | null | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & ViewPropertyConstraintInit<T, U> & ThisType<ViewPropertyConstraint<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - T_1
 - U_1 = never
 Parameters
 - descriptor: ViewPropertyConstraintDescriptorFromAny<V_1, T_1, U_1, {}>
 Returns PropertyDecorator
- Type parameters
 - V_2: View<V_2>
 - T_2
 - U_2 = never
 - I = {}
 Parameters
 - descriptor: ViewPropertyConstraintDescriptorExtends<V_2, T_2, U_2, I>
 Returns PropertyDecorator
- Type parameters
 - V_3: View<V_3>
 - T_3
 - U_3 = never
 Parameters
 - descriptor: ViewPropertyConstraintDescriptor<V_3, T_3, U_3, {}>
 Returns PropertyDecorator
prototype: ViewPropertyConstraint<any, any, never>
define: function
- define<V_5, T_5, U_5, I_1>(descriptor: ViewPropertyConstraintDescriptorExtends<V_5, T_5, U_5, I_1>): ViewPropertyConstraintConstructor<V_5, T_5, U_5, I_1>
- define<V_6, T_6, U_6>(descriptor: ViewPropertyConstraintDescriptor<V_6, T_6, U_6, {}>): ViewPropertyConstraintConstructor<V_6, T_6, U_6, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewPropertyConstraint.d.ts:75
 Type parameters
 - V_5: View<V_5>
 - T_5
 - U_5 = never
 - I_1 = {}
 Parameters
 - descriptor: ViewPropertyConstraintDescriptorExtends<V_5, T_5, U_5, I_1>
 Returns ViewPropertyConstraintConstructor<V_5, T_5, U_5, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewPropertyConstraint.d.ts:76
 Type parameters
 - V_6: View<V_6>
 - T_6
 - U_6 = never
 Parameters
 - descriptor: ViewPropertyConstraintDescriptor<V_6, T_6, U_6, {}>
 Returns ViewPropertyConstraintConstructor<V_6, T_6, U_6, {}>
getClass: function
- getClass(type: unknown): null | ViewPropertyConstraintClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/property/ViewPropertyConstraint.d.ts:74
  Parameters
  - type: unknown
  Returns null | ViewPropertyConstraintClass

ViewService

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

Type declaration

- <V, T>(descriptor: { type: typeof ViewportManager } & ViewServiceInit<T> & ThisType<ViewService<V, T> & ViewManagerObserverType<T>> & Partial<ViewManagerObserverType<T>>): PropertyDecorator
- <V_1, T_1>(descriptor: { type: typeof DisplayManager } & ViewServiceInit<T_1> & ThisType<ViewService<V_1, T_1> & ViewManagerObserverType<T_1>> & Partial<ViewManagerObserverType<T_1>>): PropertyDecorator
- <V_2, T_2>(descriptor: { type: typeof LayoutManager } & ViewServiceInit<T_2> & ThisType<ViewService<V_2, T_2> & ViewManagerObserverType<T_2>> & Partial<ViewManagerObserverType<T_2>>): PropertyDecorator
- <V_3, T_3>(descriptor: { type: typeof ThemeManager } & ViewServiceInit<T_3> & ThisType<ViewService<V_3, T_3> & ViewManagerObserverType<T_3>> & Partial<ViewManagerObserverType<T_3>>): PropertyDecorator
- <V_4, T_4>(descriptor: { type: typeof ModalManager } & ViewServiceInit<T_4> & ThisType<ViewService<V_4, T_4> & ViewManagerObserverType<T_4>> & Partial<ViewManagerObserverType<T_4>>): PropertyDecorator
- <V_5, T_5>(descriptor: { type: typeof ViewManager } & ViewServiceInit<T_5> & ThisType<ViewService<V_5, T_5> & ViewManagerObserverType<T_5>> & Partial<ViewManagerObserverType<T_5>>): PropertyDecorator
- <V_6, T_6, I>(descriptor: ViewServiceDescriptorExtends<V_6, T_6, I>): PropertyDecorator
- <V_7, T_7>(descriptor: ViewServiceDescriptor<V_7, T_7, {}>): PropertyDecorator
- Type parameters
 - V: View<V>
 - T: ViewportManager<View, T> = ViewportManager<View>
 Parameters
 - descriptor: { type: typeof ViewportManager } & ViewServiceInit<T> & ThisType<ViewService<V, T> & ViewManagerObserverType<T>> & Partial<ViewManagerObserverType<T>>
 Returns PropertyDecorator
- Type parameters
 - V_1: View<V_1>
 - T_1: DisplayManager<View, T_1> = DisplayManager<View>
 Parameters
 - descriptor: { type: typeof DisplayManager } & ViewServiceInit<T_1> & ThisType<ViewService<V_1, T_1> & ViewManagerObserverType<T_1>> & Partial<ViewManagerObserverType<T_1>>
 Returns PropertyDecorator
- Type parameters
 - V_2: View<V_2>
 - T_2: LayoutManager<View, T_2> = LayoutManager<View>
 Parameters
 - descriptor: { type: typeof LayoutManager } & ViewServiceInit<T_2> & ThisType<ViewService<V_2, T_2> & ViewManagerObserverType<T_2>> & Partial<ViewManagerObserverType<T_2>>
 Returns PropertyDecorator
- Type parameters
 - V_3: View<V_3>
 - T_3: ThemeManager<View, T_3> = ThemeManager<View>
 Parameters
 - descriptor: { type: typeof ThemeManager } & ViewServiceInit<T_3> & ThisType<ViewService<V_3, T_3> & ViewManagerObserverType<T_3>> & Partial<ViewManagerObserverType<T_3>>
 Returns PropertyDecorator
- Type parameters
 - V_4: View<V_4>
 - T_4: ModalManager<View, T_4> = ModalManager<View>
 Parameters
 - descriptor: { type: typeof ModalManager } & ViewServiceInit<T_4> & ThisType<ViewService<V_4, T_4> & ViewManagerObserverType<T_4>> & Partial<ViewManagerObserverType<T_4>>
 Returns PropertyDecorator
- Type parameters
 - V_5: View<V_5>
 - T_5: ViewManager<View, T_5> = ViewManager<View>
 Parameters
 - descriptor: { type: typeof ViewManager } & ViewServiceInit<T_5> & ThisType<ViewService<V_5, T_5> & ViewManagerObserverType<T_5>> & Partial<ViewManagerObserverType<T_5>>
 Returns PropertyDecorator
- Type parameters
 - V_6: View<V_6>
 - T_6
 - I = {}
 Parameters
 - descriptor: ViewServiceDescriptorExtends<V_6, T_6, I>
 Returns PropertyDecorator
- Type parameters
 - V_7: View<V_7>
 - T_7
 Parameters
 - descriptor: ViewServiceDescriptor<V_7, T_7, {}>
 Returns PropertyDecorator
InheritedFlag: number
prototype: ViewService<any, any>
define: function
- define<V_9, T_9, I_1>(descriptor: ViewServiceDescriptorExtends<V_9, T_9, I_1>): ViewServiceConstructor<V_9, T_9, I_1>
- define<V_10, T_10>(descriptor: ViewServiceDescriptor<V_10, T_10, {}>): ViewServiceConstructor<V_10, T_10, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/service/ViewService.d.ts:78
 Type parameters
 - V_9: View<V_9>
 - T_9
 - I_1 = {}
 Parameters
 - descriptor: ViewServiceDescriptorExtends<V_9, T_9, I_1>
 Returns ViewServiceConstructor<V_9, T_9, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/service/ViewService.d.ts:79
 Type parameters
 - V_10: View<V_10>
 - T_10
 Parameters
 - descriptor: ViewServiceDescriptor<V_10, T_10, {}>
 Returns ViewServiceConstructor<V_10, T_10, {}>
getClass: function
- getClass(type: unknown): null | ViewServiceClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/service/ViewService.d.ts:77
  Parameters
  - type: unknown
  Returns null | ViewServiceClass

Viewport

Viewport: { detect: any }

Type declaration

detect: function
- detect(): Viewport
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/viewport/Viewport.d.ts:13
  Returns Viewport

@swim/view

Installation

npm

Browser

Usage

ES6/TypeScript

CommonJS/Node.js

Browser

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnimatorFlags

GestureInputType

ModalState

MomentumGesture

Type parameters

V: View = View

PositionGesture

Type parameters

V: View = View

ScaleGesture

Type parameters

X

Y

V: View = View

ViewAnimatorConstraintDescriptor

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorConstraintDescriptorExtends

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorConstraintDescriptorFromAny

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorDescriptor

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorDescriptorExtends

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorDescriptorFromAny

Type parameters

V: View

T

U = never

I = {}

ViewAnimatorMemberInit

Type parameters

V

K: keyof V

ViewAnimatorMemberKey

Type parameters

V

K: keyof V

ViewAnimatorMemberMap

Type parameters

V

ViewAnimatorMemberType

Type parameters

V

K: keyof V

ViewColorScheme