@swim/dom

@swim/dom implements HTML and SVG views, with procedural attribute and style animators. @swim/dom is part of the @swim/ui framework.

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

Browser

Browser applications can load swim-ui.js—which bundles the @swim/dom 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/dom 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/dom can be imported as an ES6 module from TypeScript and other ES6-compatible environments.

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

CommonJS/Node.js

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

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

Browser

When loaded by a web browser, the swim-ui.js script adds all @swim/dom 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/dom library exports to the global swim namespace, making it a drop-in replacement for swim-ui.js and swim-dom.js when additional @swim/toolkit frameworks are needed.

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AlignContent

AlignItems

AlignSelf

AlignmentBaseline

Appearance

Appearance: "button" | "checkbox" | "none" | "scrollbarbutton-up"

AttributeAnimatorDescriptor

AttributeAnimatorDescriptor<V, T, U, I>: AttributeAnimatorInit<T, U> & ThisType<AttributeAnimator<V, T, U> & I> & Partial

Type parameters

V: ElementView
T
U = never
I = {}

AttributeAnimatorDescriptorExtends

AttributeAnimatorDescriptorExtends<V, T, U, I>: { extends: AttributeAnimatorClass | undefined } & AttributeAnimatorDescriptor<V, T, U, I>

Type parameters

V: ElementView
T
U = never
I = {}

AttributeAnimatorDescriptorFromAny

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

Type parameters

V: ElementView
T
U = never
I = {}

AttributeAnimatorMemberInit

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

Type parameters

V
K: keyof V

AttributeAnimatorMemberKey

AttributeAnimatorMemberKey<V, K>: V[K] extends AttributeAnimator<any, any> ? K : never

Type parameters

V
K: keyof V

AttributeAnimatorMemberMap

AttributeAnimatorMemberMap<V>: {-readonly [ K in keyof V as AttributeAnimatorMemberKey<V, K>]-?: AttributeAnimatorMemberInit<V, K> }

Type parameters

AttributeAnimatorMemberType

AttributeAnimatorMemberType<V, K>: V[K] extends AttributeAnimator<any, infer T, any> ? T : never

Type parameters

V
K: keyof V

BackgroundClip

BackgroundClip: "border-box" | "padding-box" | "content-box" | "text"

BorderCollapse

BorderCollapse: "collapse" | "separate"

BorderStyle

BorderWidth

BorderWidth: Length | "medium" | "thick" | "thin"

BoxSizing

BoxSizing: "border-box" | "content-box"

CssCursor

CssDisplay

CssRuleDescriptor

CssRuleDescriptor<V, I>: CssRuleInit & ThisType<CssRule<V> & I> & Partial

Type parameters

V: CssContext
I = {}

CssRuleDescriptorExtends

CssRuleDescriptorExtends<V, I>: { extends: CssRuleClass | undefined } & CssRuleDescriptor<V, I>

Type parameters

V: CssContext
I = {}

CssRuleType

CssRuleType: "style" | "media"

ElementViewMemberInit

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

Type parameters

V
K: keyof V

ElementViewMemberKey

ElementViewMemberKey<V, K>: V[K] extends ViewProperty<any, any> ? K : V[K] extends ViewAnimator<any, any> ? K : V[K] extends StyleAnimator<any, any> ? K : V[K] extends AttributeAnimator<any, any> ? K : never

Type parameters

V
K: keyof V

ElementViewMemberMap

ElementViewMemberMap<V>: {-readonly [ K in keyof V as ElementViewMemberKey<V, K>]-?: ElementViewMemberInit<V, K> }

Type parameters

ElementViewMemberType

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

Type parameters

V
K: keyof V

FillRule

FillRule: "nonzero" | "evenodd" | "inherit"

FlexBasis

FlexDirection

FlexDirection: "column" | "column-reverse" | "row" | "row-reverse"

FlexWrap

FlexWrap: "nowrap" | "wrap" | "wrap-reverse"

Height

Height: Length | string | "auto"

JustifyContent

MaxHeight

MaxWidth

MediaRuleDescriptor

MediaRuleDescriptor<V, I>: MediaRuleInit & ThisType<MediaRule<V> & I> & Partial

Type parameters

V: CssContext
I = {}

MediaRuleDescriptorExtends

MediaRuleDescriptorExtends<V, I>: { extends: MediaRuleClass | undefined } & MediaRuleDescriptor<V, I>

Type parameters

V: CssContext
I = {}

MinHeight

MinWidth

Overflow

Overflow: "auto" | "hidden" | "scroll" | "visible"

OverscrollBehavior

OverscrollBehavior: "auto" | "contain" | "none"

Paint

Paint: Color | "none" | "context-fill" | "context-stroke" | "currentColor"

PointerEvents

Position

Position: "absolute" | "fixed" | "relative" | "static" | "sticky"

StrokeLinecap

StrokeLinecap: "butt" | "round" | "square"

StyleAnimatorConstraintDescriptor

StyleAnimatorConstraintDescriptor<V, T, U, I>: StyleAnimatorConstraintInit<T, U> & ThisType<StyleAnimatorConstraint<V, T, U> & I> & Partial

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorConstraintDescriptorExtends

StyleAnimatorConstraintDescriptorExtends<V, T, U, I>: { extends: StyleAnimatorConstraintClass | undefined } & StyleAnimatorConstraintDescriptor<V, T, U, I>

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorConstraintDescriptorFromAny

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

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorDescriptor

StyleAnimatorDescriptor<V, T, U, I>: StyleAnimatorInit<T, U> & ThisType<StyleAnimator<V, T, U> & I> & Partial

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorDescriptorExtends

StyleAnimatorDescriptorExtends<V, T, U, I>: { extends: StyleAnimatorClass | undefined } & StyleAnimatorDescriptor<V, T, U, I>

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorDescriptorFromAny

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

Type parameters

V: StyleContext
T
U = never
I = {}

StyleAnimatorMemberInit

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

Type parameters

V
K: keyof V

StyleAnimatorMemberKey

StyleAnimatorMemberKey<V, K>: V[K] extends StyleAnimator<any, any> ? K : never

Type parameters

V
K: keyof V

StyleAnimatorMemberMap

StyleAnimatorMemberMap<V>: {-readonly [ K in keyof V as StyleAnimatorMemberKey<V, K>]-?: StyleAnimatorMemberInit<V, K> }

Type parameters

StyleAnimatorMemberType

StyleAnimatorMemberType<V, K>: V[K] extends StyleAnimator<any, infer T, any> ? T : never

Type parameters

V
K: keyof V

StyleRuleDescriptor

StyleRuleDescriptor<V, I>: StyleRuleInit & ThisType<StyleRule<V> & I> & Partial

Type parameters

V: CssContext
I = {}

StyleRuleDescriptorExtends

StyleRuleDescriptorExtends<V, I>: { extends: StyleRuleClass | undefined } & StyleRuleDescriptor<V, I>

Type parameters

V: CssContext
I = {}

SvgPointerEvents

TextAlign

TextAnchor

TextAnchor: "end" | "inherit" | "middle" | "start"

TextDecorationStyle

TextDecorationStyle: "dashed" | "dotted" | "double" | "solid" | "wavy"

TextTransform

TextTransform: "capitalize" | "full-width" | "lowercase" | "none" | "uppercase"

TouchAction

UserSelect

UserSelect: "all" | "auto" | "contain" | "none" | "text"

VerticalAlign

ViewNodeType

ViewNodeType<V>: V extends { node: infer N } ? N : never

Type parameters

V: NodeView

Visibility

Visibility: "collapse" | "hidden" | "visible"

WhiteSpace

WhiteSpace: "normal" | "nowrap" | "pre" | "pre-line" | "pre-wrap"

Width

Variables

AttributeAnimator

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

Type declaration

- <V, T, U>(descriptor: { type: typeof Length } & AttributeAnimatorInit<T, U> & ThisType<AttributeAnimator<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: typeof Color } & AttributeAnimatorInit<T_1, U_1> & ThisType<AttributeAnimator<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: { type: typeof Transform } & AttributeAnimatorInit<T_2, U_2> & ThisType<AttributeAnimator<V_2, T_2, U_2>> & Partial<{}>): PropertyDecorator
- <V_3, T_3, U_3>(descriptor: { type: StringConstructor } & AttributeAnimatorInit<T_3, U_3> & ThisType<AttributeAnimator<V_3, T_3, U_3>> & Partial<{}>): PropertyDecorator
- <V_4, T_4, U_4>(descriptor: { type: BooleanConstructor } & AttributeAnimatorInit<T_4, U_4> & ThisType<AttributeAnimator<V_4, T_4, U_4>> & Partial<{}>): PropertyDecorator
- <V_5, T_5, U_5>(descriptor: { type: NumberConstructor } & AttributeAnimatorInit<T_5, U_5> & ThisType<AttributeAnimator<V_5, T_5, U_5>> & Partial<{}>): PropertyDecorator
- <V_6, T_6, U_6>(descriptor: AttributeAnimatorDescriptorFromAny<V_6, T_6, U_6, {}>): PropertyDecorator
- <V_7, T_7, U_7, I>(descriptor: AttributeAnimatorDescriptorExtends<V_7, T_7, U_7, I>): PropertyDecorator
- <V_8, T_8, U_8>(descriptor: AttributeAnimatorDescriptor<V_8, T_8, U_8, {}>): PropertyDecorator
- Type parameters
 - V: ElementView<V>
 - T: undefined | Length = undefined | Length
 - U: undefined | AnyLength = undefined | AnyLength
 Parameters
 - descriptor: { type: typeof Length } & AttributeAnimatorInit<T, U> & ThisType<AttributeAnimator<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: ElementView<V_1>
 - T_1: undefined | Color = undefined | Color
 - U_1: undefined | AnyColor = undefined | AnyColor
 Parameters
 - descriptor: { type: typeof Color } & AttributeAnimatorInit<T_1, U_1> & ThisType<AttributeAnimator<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: ElementView<V_2>
 - T_2: undefined | Transform = undefined | Transform
 - U_2: undefined | AnyTransform = undefined | AnyTransform
 Parameters
 - descriptor: { type: typeof Transform } & AttributeAnimatorInit<T_2, U_2> & ThisType<AttributeAnimator<V_2, T_2, U_2>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_3: ElementView<V_3>
 - T_3: undefined | string = undefined | string
 - U_3: undefined | string = undefined | string
 Parameters
 - descriptor: { type: StringConstructor } & AttributeAnimatorInit<T_3, U_3> & ThisType<AttributeAnimator<V_3, T_3, U_3>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_4: ElementView<V_4>
 - T_4: undefined | boolean = undefined | boolean
 - U_4: undefined | string | boolean = undefined | string | boolean
 Parameters
 - descriptor: { type: BooleanConstructor } & AttributeAnimatorInit<T_4, U_4> & ThisType<AttributeAnimator<V_4, T_4, U_4>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_5: ElementView<V_5>
 - T_5: undefined | number = undefined | number
 - U_5: undefined | string | number = undefined | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & AttributeAnimatorInit<T_5, U_5> & ThisType<AttributeAnimator<V_5, T_5, U_5>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_6: ElementView<V_6>
 - T_6
 - U_6 = never
 Parameters
 - descriptor: AttributeAnimatorDescriptorFromAny<V_6, T_6, U_6, {}>
 Returns PropertyDecorator
- Type parameters
 - V_7: ElementView<V_7>
 - T_7
 - U_7 = never
 - I = {}
 Parameters
 - descriptor: AttributeAnimatorDescriptorExtends<V_7, T_7, U_7, I>
 Returns PropertyDecorator
- Type parameters
 - V_8: ElementView<V_8>
 - T_8
 - U_8 = never
 Parameters
 - descriptor: AttributeAnimatorDescriptor<V_8, T_8, U_8, {}>
 Returns PropertyDecorator
prototype: AttributeAnimator<any, any, never>
define: function
- define<V_10, T_10, U_10, I_2>(descriptor: AttributeAnimatorDescriptorExtends<V_10, T_10, U_10, I_2>): AttributeAnimatorConstructor<V_10, T_10, U_10, I_2>
- define<V_11, T_11, U_11>(descriptor: AttributeAnimatorDescriptor<V_11, T_11, U_11, {}>): AttributeAnimatorConstructor<V_11, T_11, U_11, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:111
 Type parameters
 - V_10: ElementView<V_10>
 - T_10
 - U_10 = never
 - I_2 = {}
 Parameters
 - descriptor: AttributeAnimatorDescriptorExtends<V_10, T_10, U_10, I_2>
 Returns AttributeAnimatorConstructor<V_10, T_10, U_10, I_2>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:112
 Type parameters
 - V_11: ElementView<V_11>
 - T_11
 - U_11 = never
 Parameters
 - descriptor: AttributeAnimatorDescriptor<V_11, T_11, U_11, {}>
 Returns AttributeAnimatorConstructor<V_11, T_11, U_11, {}>
getClass: function
- getClass(type: unknown): null | AttributeAnimatorClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/attribute/AttributeAnimator.d.ts:110
  Parameters
  - type: unknown
  Returns null | AttributeAnimatorClass

CssContext

CssContext: { decorateCssRule: any; getCssRuleConstructor: any }

Type declaration

decorateCssRule: function
- decorateCssRule(constructor: CssRuleConstructor<CssContext, {}>, target: Object, propertyKey: string | symbol): void
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssContext.d.ts:23
 Parameters
 - constructor: CssRuleConstructor<CssContext, {}>
 - target: Object
 - propertyKey: string | symbol
 Returns void
getCssRuleConstructor: function
- getCssRuleConstructor(ruleName: string, contextPrototype: null | CssContextPrototype): null | CssRuleConstructor<any, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssContext.d.ts:22
 Parameters
 - ruleName: string
 - contextPrototype: null | CssContextPrototype
 Returns null | CssRuleConstructor<any, {}>

CssRule

CssRule: { prototype: CssRule<any>; define: any }

Type declaration

- <V, I>(descriptor: { type: "style" } & { extends: undefined | StyleRuleClass } & StyleRuleInit & ThisType<StyleRule<V> & I> & Partial): PropertyDecorator
- <V_1>(descriptor: { type: "style" } & StyleRuleInit & ThisType<StyleRule<V_1>> & Partial<{}>): PropertyDecorator
- <V_2, I_1>(descriptor: { type: "media" } & { extends: undefined | MediaRuleClass } & MediaRuleInit & ThisType<MediaRule<V_2> & I_1> & Partial<I_1>): PropertyDecorator
- <V_3>(descriptor: { type: "media" } & MediaRuleInit & ThisType<MediaRule<V_3>> & Partial<{}>): PropertyDecorator
- <V_4, I_2>(descriptor: CssRuleDescriptorExtends<V_4, I_2>): PropertyDecorator
- <V_5>(descriptor: CssRuleDescriptor<V_5, {}>): PropertyDecorator
- Type parameters
 - V: CssContext<V>
 - I = {}
 Parameters
 - descriptor: { type: "style" } & { extends: undefined | StyleRuleClass } & StyleRuleInit & ThisType<StyleRule<V> & I> & Partial
 Returns PropertyDecorator
- Type parameters
 - V_1: CssContext<V_1>
 Parameters
 - descriptor: { type: "style" } & StyleRuleInit & ThisType<StyleRule<V_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: CssContext<V_2>
 - I_1 = {}
 Parameters
 - descriptor: { type: "media" } & { extends: undefined | MediaRuleClass } & MediaRuleInit & ThisType<MediaRule<V_2> & I_1> & Partial<I_1>
 Returns PropertyDecorator
- Type parameters
 - V_3: CssContext<V_3>
 Parameters
 - descriptor: { type: "media" } & MediaRuleInit & ThisType<MediaRule<V_3>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_4: CssContext<V_4>
 - I_2 = {}
 Parameters
 - descriptor: CssRuleDescriptorExtends<V_4, I_2>
 Returns PropertyDecorator
- Type parameters
 - V_5: CssContext<V_5>
 Parameters
 - descriptor: CssRuleDescriptor<V_5, {}>
 Returns PropertyDecorator
prototype: CssRule<any>
define: function
- define<V_7, I_3>(descriptor: { type: "style" } & { extends: undefined | StyleRuleClass } & StyleRuleInit & ThisType<StyleRule<V_7> & I_3> & Partial<I_3>): StyleRuleConstructor<V_7, I_3>
- define<V_8>(descriptor: { type: "style" } & StyleRuleInit & ThisType<StyleRule<V_8>> & Partial<{}>): StyleRuleConstructor<V_8, {}>
- define<V_9, I_4>(descriptor: { type: "media" } & { extends: undefined | MediaRuleClass } & MediaRuleInit & ThisType<MediaRule<V_9> & I_4> & Partial<I_4>): MediaRuleConstructor<V_9, I_4>
- define<V_10>(descriptor: { type: "media" } & MediaRuleInit & ThisType<MediaRule<V_10>> & Partial<{}>): MediaRuleConstructor<V_10, {}>
- define<V_11, I_5>(descriptor: CssRuleDescriptorExtends<V_11, I_5>): CssRuleConstructor<V_11, I_5>
- define<V_12>(descriptor: CssRuleDescriptor<V_12, {}>): CssRuleConstructor<V_12, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:77
 Type parameters
 - V_7: CssContext<V_7>
 - I_3 = {}
 Parameters
 - descriptor: { type: "style" } & { extends: undefined | StyleRuleClass } & StyleRuleInit & ThisType<StyleRule<V_7> & I_3> & Partial<I_3>
 Returns StyleRuleConstructor<V_7, I_3>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:82
 Type parameters
 - V_8: CssContext<V_8>
 Parameters
 - descriptor: { type: "style" } & StyleRuleInit & ThisType<StyleRule<V_8>> & Partial<{}>
 Returns StyleRuleConstructor<V_8, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:85
 Type parameters
 - V_9: CssContext<V_9>
 - I_4 = {}
 Parameters
 - descriptor: { type: "media" } & { extends: undefined | MediaRuleClass } & MediaRuleInit & ThisType<MediaRule<V_9> & I_4> & Partial<I_4>
 Returns MediaRuleConstructor<V_9, I_4>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:90
 Type parameters
 - V_10: CssContext<V_10>
 Parameters
 - descriptor: { type: "media" } & MediaRuleInit & ThisType<MediaRule<V_10>> & Partial<{}>
 Returns MediaRuleConstructor<V_10, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:93
 Type parameters
 - V_11: CssContext<V_11>
 - I_5 = {}
 Parameters
 - descriptor: CssRuleDescriptorExtends<V_11, I_5>
 Returns CssRuleConstructor<V_11, I_5>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/CssRule.d.ts:94
 Type parameters
 - V_12: CssContext<V_12>
 Parameters
 - descriptor: CssRuleDescriptor<V_12, {}>
 Returns CssRuleConstructor<V_12, {}>

MediaRule

MediaRule: { prototype: MediaRule<any>; define: any }

Type declaration

- <V, I>(descriptor: MediaRuleDescriptorExtends<V, I>): PropertyDecorator
- <V_1>(descriptor: MediaRuleDescriptor<V_1, {}>): PropertyDecorator
- Type parameters
 - V: CssContext<V>
 - I = {}
 Parameters
 - descriptor: MediaRuleDescriptorExtends<V, I>
 Returns PropertyDecorator
- Type parameters
 - V_1: CssContext<V_1>
 Parameters
 - descriptor: MediaRuleDescriptor<V_1, {}>
 Returns PropertyDecorator
prototype: MediaRule<any>
define: function
- define<V_3, I_1>(descriptor: MediaRuleDescriptorExtends<V_3, I_1>): MediaRuleConstructor<V_3, I_1>
- define<V_4>(descriptor: MediaRuleDescriptor<V_4, {}>): MediaRuleConstructor<V_4, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/MediaRule.d.ts:45
 Type parameters
 - V_3: CssContext<V_3>
 - I_1 = {}
 Parameters
 - descriptor: MediaRuleDescriptorExtends<V_3, I_1>
 Returns MediaRuleConstructor<V_3, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/MediaRule.d.ts:46
 Type parameters
 - V_4: CssContext<V_4>
 Parameters
 - descriptor: MediaRuleDescriptor<V_4, {}>
 Returns MediaRuleConstructor<V_4, {}>

StyleAnimator

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

Type declaration

- <V, T, U>(descriptor: { type: typeof Length } & StyleAnimatorInit<T, U> & ThisType<StyleAnimator<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: typeof Color } & StyleAnimatorInit<T_1, U_1> & ThisType<StyleAnimator<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: { type: typeof BoxShadow } & StyleAnimatorInit<T_2, U_2> & ThisType<StyleAnimator<V_2, T_2, U_2>> & Partial<{}>): PropertyDecorator
- <V_3, T_3, U_3>(descriptor: { type: typeof Transform } & StyleAnimatorInit<T_3, U_3> & ThisType<StyleAnimator<V_3, T_3, U_3>> & Partial<{}>): PropertyDecorator
- <V_4, T_4, U_4>(descriptor: { type: { format: any; fromValue: any } } & StyleAnimatorInit<T_4, U_4> & ThisType<StyleAnimator<V_4, T_4, U_4>> & Partial<{}>): PropertyDecorator
- <V_5, T_5, U_5>(descriptor: { type: StringConstructor } & StyleAnimatorInit<T_5, U_5> & ThisType<StyleAnimator<V_5, T_5, U_5>> & Partial<{}>): PropertyDecorator
- <V_6, T_6, U_6>(descriptor: { type: NumberConstructor } & StyleAnimatorInit<T_6, U_6> & ThisType<StyleAnimator<V_6, T_6, U_6>> & Partial<{}>): PropertyDecorator
- <V_7, T_7, U_7>(descriptor: StyleAnimatorDescriptorFromAny<V_7, T_7, U_7, {}>): PropertyDecorator
- <V_8, T_8, U_8, I>(descriptor: StyleAnimatorDescriptorExtends<V_8, T_8, U_8, I>): PropertyDecorator
- <V_9, T_9, U_9>(descriptor: StyleAnimatorDescriptor<V_9, T_9, U_9, {}>): PropertyDecorator
- Type parameters
 - V: StyleContext<V>
 - T: undefined | null | Length = undefined | null | Length
 - U: undefined | null | AnyLength = undefined | null | AnyLength
 Parameters
 - descriptor: { type: typeof Length } & StyleAnimatorInit<T, U> & ThisType<StyleAnimator<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: StyleContext<V_1>
 - T_1: undefined | null | Color = undefined | null | Color
 - U_1: undefined | null | AnyColor = undefined | null | AnyColor
 Parameters
 - descriptor: { type: typeof Color } & StyleAnimatorInit<T_1, U_1> & ThisType<StyleAnimator<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: StyleContext<V_2>
 - T_2: undefined | null | BoxShadow = undefined | null | BoxShadow
 - U_2: undefined | null | AnyBoxShadow = undefined | null | AnyBoxShadow
 Parameters
 - descriptor: { type: typeof BoxShadow } & StyleAnimatorInit<T_2, U_2> & ThisType<StyleAnimator<V_2, T_2, U_2>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_3: StyleContext<V_3>
 - T_3: undefined | null | Transform = undefined | null | Transform
 - U_3: undefined | null | AnyTransform = undefined | null | AnyTransform
 Parameters
 - descriptor: { type: typeof Transform } & StyleAnimatorInit<T_3, U_3> & ThisType<StyleAnimator<V_3, T_3, U_3>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_4: StyleContext<V_4>
 - T_4: undefined | null | string | readonly string[] = undefined | null | string | readonly string[]
 - U_4: undefined | null | string | readonly string[] = undefined | null | string | readonly string[]
 Parameters
 - descriptor: { type: { format: any; fromValue: any } } & StyleAnimatorInit<T_4, U_4> & ThisType<StyleAnimator<V_4, T_4, U_4>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_5: StyleContext<V_5>
 - T_5: undefined | null | string = undefined | null | string
 - U_5: undefined | null | string = undefined | null | string
 Parameters
 - descriptor: { type: StringConstructor } & StyleAnimatorInit<T_5, U_5> & ThisType<StyleAnimator<V_5, T_5, U_5>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_6: StyleContext<V_6>
 - T_6: undefined | null | number = undefined | null | number
 - U_6: undefined | null | string | number = undefined | null | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & StyleAnimatorInit<T_6, U_6> & ThisType<StyleAnimator<V_6, T_6, U_6>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_7: StyleContext<V_7>
 - T_7
 - U_7 = never
 Parameters
 - descriptor: StyleAnimatorDescriptorFromAny<V_7, T_7, U_7, {}>
 Returns PropertyDecorator
- Type parameters
 - V_8: StyleContext<V_8>
 - T_8
 - U_8 = never
 - I = {}
 Parameters
 - descriptor: StyleAnimatorDescriptorExtends<V_8, T_8, U_8, I>
 Returns PropertyDecorator
- Type parameters
 - V_9: StyleContext<V_9>
 - T_9
 - U_9 = never
 Parameters
 - descriptor: StyleAnimatorDescriptor<V_9, T_9, U_9, {}>
 Returns PropertyDecorator
prototype: StyleAnimator<any, any, never>
define: function
- define<V_11, T_11, U_11, I_1>(descriptor: StyleAnimatorDescriptorExtends<V_11, T_11, U_11, I_1>): StyleAnimatorConstructor<V_11, T_11, U_11, I_1>
- define<V_12, T_12, U_12>(descriptor: StyleAnimatorDescriptor<V_12, T_12, U_12, {}>): StyleAnimatorConstructor<V_12, T_12, U_12, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimator.d.ts:118
 Type parameters
 - V_11: StyleContext<V_11>
 - T_11
 - U_11 = never
 - I_1 = {}
 Parameters
 - descriptor: StyleAnimatorDescriptorExtends<V_11, T_11, U_11, I_1>
 Returns StyleAnimatorConstructor<V_11, T_11, U_11, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimator.d.ts:119
 Type parameters
 - V_12: StyleContext<V_12>
 - T_12
 - U_12 = never
 Parameters
 - descriptor: StyleAnimatorDescriptor<V_12, T_12, U_12, {}>
 Returns StyleAnimatorConstructor<V_12, T_12, U_12, {}>
getClass: function
- getClass(type: unknown): null | StyleAnimatorClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimator.d.ts:117
  Parameters
  - type: unknown
  Returns null | StyleAnimatorClass

StyleAnimatorConstraint

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

Type declaration

- <V, T, U>(descriptor: { type: typeof Length } & StyleAnimatorConstraintInit<T, U> & ThisType<StyleAnimatorConstraint<V, T, U>> & Partial<{}>): PropertyDecorator
- <V_1, T_1, U_1>(descriptor: { type: NumberConstructor } & StyleAnimatorConstraintInit<T_1, U_1> & ThisType<StyleAnimatorConstraint<V_1, T_1, U_1>> & Partial<{}>): PropertyDecorator
- <V_2, T_2, U_2>(descriptor: StyleAnimatorConstraintDescriptorFromAny<V_2, T_2, U_2, {}>): PropertyDecorator
- <V_3, T_3, U_3, I>(descriptor: StyleAnimatorConstraintDescriptorExtends<V_3, T_3, U_3, I>): PropertyDecorator
- <V_4, T_4, U_4>(descriptor: StyleAnimatorConstraintDescriptor<V_4, T_4, U_4, {}>): PropertyDecorator
- Type parameters
 - V: StyleContext<V>
 - T: undefined | null | Length = undefined | null | Length
 - U: undefined | null | AnyLength = undefined | null | AnyLength
 Parameters
 - descriptor: { type: typeof Length } & StyleAnimatorConstraintInit<T, U> & ThisType<StyleAnimatorConstraint<V, T, U>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_1: StyleContext<V_1>
 - T_1: undefined | null | number = undefined | null | number
 - U_1: undefined | null | string | number = undefined | null | string | number
 Parameters
 - descriptor: { type: NumberConstructor } & StyleAnimatorConstraintInit<T_1, U_1> & ThisType<StyleAnimatorConstraint<V_1, T_1, U_1>> & Partial<{}>
 Returns PropertyDecorator
- Type parameters
 - V_2: StyleContext<V_2>
 - T_2
 - U_2 = never
 Parameters
 - descriptor: StyleAnimatorConstraintDescriptorFromAny<V_2, T_2, U_2, {}>
 Returns PropertyDecorator
- Type parameters
 - V_3: StyleContext<V_3>
 - T_3
 - U_3 = never
 - I = {}
 Parameters
 - descriptor: StyleAnimatorConstraintDescriptorExtends<V_3, T_3, U_3, I>
 Returns PropertyDecorator
- Type parameters
 - V_4: StyleContext<V_4>
 - T_4
 - U_4 = never
 Parameters
 - descriptor: StyleAnimatorConstraintDescriptor<V_4, T_4, U_4, {}>
 Returns PropertyDecorator
prototype: StyleAnimatorConstraint<any, any, never>
define: function
- define<V_6, T_6, U_6, I_1>(descriptor: StyleAnimatorConstraintDescriptorExtends<V_6, T_6, U_6, I_1>): StyleAnimatorConstraintConstructor<V_6, T_6, U_6, I_1>
- define<V_7, T_7, U_7>(descriptor: StyleAnimatorConstraintDescriptor<V_7, T_7, U_7, {}>): StyleAnimatorConstraintConstructor<V_7, T_7, U_7, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimatorConstraint.d.ts:81
 Type parameters
 - V_6: StyleContext<V_6>
 - T_6
 - U_6 = never
 - I_1 = {}
 Parameters
 - descriptor: StyleAnimatorConstraintDescriptorExtends<V_6, T_6, U_6, I_1>
 Returns StyleAnimatorConstraintConstructor<V_6, T_6, U_6, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimatorConstraint.d.ts:82
 Type parameters
 - V_7: StyleContext<V_7>
 - T_7
 - U_7 = never
 Parameters
 - descriptor: StyleAnimatorConstraintDescriptor<V_7, T_7, U_7, {}>
 Returns StyleAnimatorConstraintConstructor<V_7, T_7, U_7, {}>
getClass: function
- getClass(type: unknown): null | StyleAnimatorConstraintClass
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleAnimatorConstraint.d.ts:80
  Parameters
  - type: unknown
  Returns null | StyleAnimatorConstraintClass

StyleContext

StyleContext: { decorateStyleAnimator: any; getStyleAnimatorConstructor: any }

Type declaration

decorateStyleAnimator: function
- decorateStyleAnimator(constructor: StyleAnimatorConstructor<StyleContext, unknown, never, {}>, target: Object, propertyKey: string | symbol): void
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleContext.d.ts:27
 Parameters
 - constructor: StyleAnimatorConstructor<StyleContext, unknown, never, {}>
 - target: Object
 - propertyKey: string | symbol
 Returns void
getStyleAnimatorConstructor: function
- getStyleAnimatorConstructor(animatorName: string, styleContextPrototype: StyleContextPrototype): null | StyleAnimatorConstructor<any, unknown, never, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleContext.d.ts:26
 Parameters
 - animatorName: string
 - styleContextPrototype: StyleContextPrototype
 Returns null | StyleAnimatorConstructor<any, unknown, never, {}>

StyleMap

StyleMap: { define: any; init: any }

Type declaration

define: function
- define(prototype: StyleMap): void
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleMap.d.ts:217
  Parameters
  - prototype: StyleMap
  Returns void
init: function
- init(map: StyleMap, init: StyleMapInit): void
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/style/StyleMap.d.ts:216
  Parameters
  - map: StyleMap
  - init: StyleMapInit
  Returns void

StyleRule

StyleRule: { prototype: StyleRule<any>; define: any }

Type declaration

- <V, I>(descriptor: StyleRuleDescriptorExtends<V, I>): PropertyDecorator
- <V_1>(descriptor: StyleRuleDescriptor<V_1, {}>): PropertyDecorator
- Type parameters
 - V: CssContext<V>
 - I = {}
 Parameters
 - descriptor: StyleRuleDescriptorExtends<V, I>
 Returns PropertyDecorator
- Type parameters
 - V_1: CssContext<V_1>
 Parameters
 - descriptor: StyleRuleDescriptor<V_1, {}>
 Returns PropertyDecorator
prototype: StyleRule<any>
define: function
- define<V_3, I_1>(descriptor: StyleRuleDescriptorExtends<V_3, I_1>): StyleRuleConstructor<V_3, I_1>
- define<V_4>(descriptor: StyleRuleDescriptor<V_4, {}>): StyleRuleConstructor<V_4, {}>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/StyleRule.d.ts:57
 Type parameters
 - V_3: CssContext<V_3>
 - I_1 = {}
 Parameters
 - descriptor: StyleRuleDescriptorExtends<V_3, I_1>
 Returns StyleRuleConstructor<V_3, I_1>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/dom/lib/main/css/StyleRule.d.ts:58
 Type parameters
 - V_4: CssContext<V_4>
 Parameters
 - descriptor: StyleRuleDescriptor<V_4, {}>
 Returns StyleRuleConstructor<V_4, {}>

@swim/dom

Installation

npm

Browser

Usage

ES6/TypeScript

CommonJS/Node.js

Browser

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AlignContent

AlignItems

AlignSelf

AlignmentBaseline

Appearance

AttributeAnimatorDescriptor

Type parameters

V: ElementView

T

U = never

I = {}

AttributeAnimatorDescriptorExtends

Type parameters

V: ElementView

T

U = never

I = {}

AttributeAnimatorDescriptorFromAny

Type parameters

V: ElementView

T

U = never

I = {}

AttributeAnimatorMemberInit

Type parameters

V

K: keyof V

AttributeAnimatorMemberKey

Type parameters

V

K: keyof V

AttributeAnimatorMemberMap

Type parameters

V

AttributeAnimatorMemberType

Type parameters

V

K: keyof V

BackgroundClip

BorderCollapse

BorderStyle

BorderWidth

BoxSizing

CssCursor

CssDisplay

CssRuleDescriptor

Type parameters

V: CssContext

I = {}

CssRuleDescriptorExtends

Type parameters

V: CssContext

I = {}

CssRuleType

ElementViewMemberInit

Type parameters

V

K: keyof V

ElementViewMemberKey

Type parameters

V

K: keyof V

ElementViewMemberMap

Type parameters

V

ElementViewMemberType