Swim View Library

The Swim View library implements a unified HTML, SVG, and Canvas view hierarchy, with procedurally animated styling, and constraint-based layouts.

Index

Classes

Interfaces

Type aliases

AnyView

AnyView<V>: V | ViewFactory<V> | InitType<V>

Type parameters

V: View = View

GestureDescriptor

GestureDescriptor<O, V, I>: ThisType<Gesture<O, V> & I> & GestureInit<V> & Partial

Type parameters

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

GestureInputType

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

GestureMethod

GestureMethod: "auto" | "pointer" | "touch" | "mouse"

GestureView

GestureView<G>: G extends Gesture<any, infer V> ? V : never

Type parameters

G: Gesture<any, any>

MemberGestureView

MemberGestureView<O, K>: O[K] extends Gesture<any, infer V> ? V : never

Type parameters

O
K: keyof O

ModalState

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

MomentumGestureDescriptor

MomentumGestureDescriptor<O, V, I>: ThisType<MomentumGesture<O, V> & I> & MomentumGestureInit<V> & Partial

Type parameters

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

PositionGestureDescriptor

PositionGestureDescriptor<O, V, I>: ThisType<PositionGesture<O, V> & I> & PositionGestureInit<V> & Partial

Type parameters

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

ScaleGestureDescriptor

ScaleGestureDescriptor<O, V, X, Y, I>: ThisType<ScaleGesture<O, V, X, Y> & I> & ScaleGestureInit<V, X, Y> & Partial

Type parameters

O = unknown
V: View = View
X = unknown
Y = unknown
I = {}

ViewColorScheme

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

ViewContextType

ViewContextType<V>: V extends { contextType?: Class<infer T> } ? T : never

Type parameters

V: View

ViewCreator

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

Type parameters

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

ViewFlags

ViewFlags: HierarchyFlags

ViewIdiom

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

ViewRefDescriptor

ViewRefDescriptor<O, V, I>: ThisType<ViewRef<O, V> & I> & ViewRefInit<V> & Partial

Type parameters

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

ViewRefType

ViewRefType<F>: F extends ViewRef<any, infer V> ? V : never

Type parameters

F: ViewRef<any, any>

ViewRelationDescriptor

ViewRelationDescriptor<O, V, I>: ThisType<ViewRelation<O, V> & I> & ViewRelationInit<V> & Partial

Type parameters

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

ViewRelationType

ViewRelationType<F>: F extends ViewRelation<any, infer V> ? V : never

Type parameters

F: ViewRelation<any, any>

ViewSetDescriptor

ViewSetDescriptor<O, V, I>: ThisType<ViewSet<O, V> & I> & ViewSetInit<V> & Partial

Type parameters

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

ViewSetType

ViewSetType<F>: F extends ViewSet<any, infer V> ? V : never

Type parameters

F: ViewSet<any, any>

Variables

DisplayProvider

DisplayProvider: ProviderClass<DisplayProvider<any, any>>

Gesture

Gesture: GestureFactory<Gesture<any, any>>

LayoutProvider

LayoutProvider: ProviderClass<LayoutProvider<any, any>>

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

ModalProvider

ModalProvider: ProviderClass<ModalProvider<any, any>>

MouseScaleGesture

MouseScaleGesture: ScaleGestureFactory<MouseScaleGesture<any, any, any, any>>

PointerMomentumGesture

PointerMomentumGesture: MomentumGestureFactory<PointerMomentumGesture<any, any>>

PointerPositionGesture

PointerPositionGesture: PositionGestureFactory<PointerPositionGesture<any, any>>

PointerScaleGesture

PointerScaleGesture: ScaleGestureFactory<PointerScaleGesture<any, any, any, any>>

PositionGesture

PositionGesture: PositionGestureFactory<PositionGesture<any, any>>

ScaleGesture

ScaleGesture: ScaleGestureFactory<ScaleGesture<any, any, any, any>>

ThemeProvider

ThemeProvider: ProviderClass<ThemeProvider<any, any>>

TouchMomentumGesture

TouchMomentumGesture: MomentumGestureFactory<TouchMomentumGesture<any, any>>

TouchPositionGesture

TouchPositionGesture: PositionGestureFactory<TouchPositionGesture<any, any>>

TouchScaleGesture

TouchScaleGesture: ScaleGestureFactory<TouchScaleGesture<any, any, any, any>>

ViewContext

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

Type declaration

current: null | ViewContext
create: function
- create(): ViewContext
- - Defined in swim-toolkit-js/swim-ui-js/@swim/view/lib/main/view/ViewContext.d.ts:12
  Returns ViewContext

ViewRef

ViewRef: ViewRefFactory<ViewRef<any, any>>

ViewRelation

ViewRelation: ViewRelationFactory<ViewRelation<any, any>>

ViewSet

ViewSet: ViewSetFactory<ViewSet<any, any>>

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

ViewportProvider

ViewportProvider: ProviderClass<ViewportProvider<any, any>>

Swim View Library

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AnyView

Type parameters

V: View = View

GestureDescriptor

Type parameters

O = unknown

V: View = View

I = {}

GestureInputType

GestureMethod

GestureView

Type parameters

G: Gesture<any, any>

MemberGestureView

Type parameters

O

K: keyof O

ModalState

MomentumGestureDescriptor

Type parameters

O = unknown

V: View = View

I = {}

PositionGestureDescriptor

Type parameters

O = unknown

V: View = View

I = {}

ScaleGestureDescriptor

Type parameters

O = unknown

V: View = View

X = unknown

Y = unknown

I = {}

ViewColorScheme

ViewContextType

Type parameters

V: View

ViewCreator

Type parameters

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

V: View = View

ViewFlags

ViewIdiom

ViewRefDescriptor

Type parameters

O = unknown

V: View = View

I = {}

ViewRefType

Type parameters

F: ViewRef<any, any>

ViewRelationDescriptor

Type parameters

O = unknown

V: View = View

I = {}

ViewRelationType

Type parameters

F: ViewRelation<any, any>

ViewSetDescriptor

Type parameters

O = unknown

V: View = View

I = {}

ViewSetType

Type parameters

F: ViewSet<any, any>

Variables

DisplayProvider

Gesture

LayoutProvider