Options
All
  • Public
  • Public/Protected
  • All
Menu

Library @swim/dom

Swim DOM Library

The Swim DOM library implements HTML and SVG views, with procedural attribute and style animators.

Index

Classes

Interfaces

Type aliases

Variables

Type aliases

AlignContent

AlignContent: "baseline" | "center" | "end" | "first baseline" | "flex-end" | "flex-start" | "last baseline" | "left" | "right" | "safe center" | "space-around" | "space-between" | "space-evenly" | "start" | "stretch" | "unsafe center"

AlignItems

AlignItems: "baseline" | "center" | "end" | "first baseline" | "flex-end" | "flex-start" | "last baseline" | "left" | "normal" | "right" | "safe center" | "self-end" | "self-start" | "start" | "stretch" | "unsafe center"

AlignSelf

AlignSelf: "auto" | "baseline" | "center" | "end" | "first baseline" | "flex-end" | "flex-start" | "last baseline" | "left" | "normal" | "right" | "safe center" | "self-end" | "self-start" | "start" | "stretch" | "unsafe center"

AlignmentBaseline

AlignmentBaseline: "after-edge" | "alphabetic" | "auto" | "baseline" | "before-edge" | "central" | "hanging" | "ideographic" | "inherit" | "mathematical" | "middle" | "text-after-edge" | "text-before-edge"

AnyElementView

AnyElementView<V>: AnyNodeView<V>

Type parameters

AnyHtmlView

AnyHtmlView<V>: AnyElementView<V> | keyof HtmlViewTagMap

Type parameters

AnyNodeView

AnyNodeView<V>: AnyView<V> | ViewNodeType<V>

Type parameters

AnySvgView

AnySvgView<V>: AnyElementView<V> | keyof SvgViewTagMap

Type parameters

AnyTextView

AnyTextView<V>: AnyNodeView<V> | string

Type parameters

Appearance

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

AttributeAnimatorDescriptor

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

Type parameters

  • O = unknown

  • T = unknown

  • U = never

  • I = {}

BackgroundClip

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

BorderCollapse

BorderCollapse: "collapse" | "separate"

BorderStyle

BorderStyle: "dashed" | "dotted" | "double" | "groove" | "hidden" | "inset" | "none" | "outset" | "ridge" | "solid"

BorderWidth

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

BoxSizing

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

CssCursor

CssCursor: "alias" | "all-scroll" | "auto" | "cell" | "col-resize" | "context-menu" | "copy" | "crosshair" | "default" | "e-resize" | "ew-resize" | "grab" | "grabbing" | "help" | "move" | "n-resize" | "ne-resize" | "nesw-resize" | "no-drop" | "none" | "not-allowed" | "ns-resize" | "nw-resize" | "nwse-resize" | "pointer" | "progress" | "row-resize" | "s-resize" | "se-resize" | "sw-resize" | "text" | "vertical-text" | "w-resize" | "wait" | "zoom-in" | "zoom-out"

CssDisplay

CssDisplay: "block" | "contents" | "flex" | "flow" | "flow-root" | "grid" | "inline" | "inline-block" | "inline-flex" | "inline-grid" | "inline-table" | "list-item" | "none" | "ruby" | "ruby-base" | "ruby-base-container" | "ruby-text" | "ruby-text-container" | "run-in" | "table" | "table-caption" | "table-cell" | "table-column" | "table-column-group" | "table-footer-group" | "table-header-group" | "table-row" | "table-row-group"

CssRuleDescriptor

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

Type parameters

  • O = unknown

  • I = {}

FillRule

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

FlexBasis

FlexBasis: Length | "auto" | "content" | "fill" | "fit-content" | "max-content" | "min-content"

FlexDirection

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

FlexWrap

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

Height

Height: Length | string | "auto"

JustifyContent

JustifyContent: "baseline" | "center" | "end" | "first baseline" | "flex-end" | "flex-start" | "last baseline" | "left" | "right" | "safe center" | "space-around" | "space-between" | "space-evenly" | "start" | "stretch" | "unsafe center"

MaxHeight

MaxHeight: Length | string | "fill-available" | "fit-content" | "max-content" | "min-content" | "none"

MaxWidth

MaxWidth: Length | string | "fill-available" | "fit-content" | "max-content" | "min-content" | "none"

MediaRuleDescriptor

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

Type parameters

  • O = unknown

  • I = {}

MinHeight

MinHeight: Length | string | "fill-available" | "fit-content" | "max-content" | "min-content"

MinWidth

MinWidth: Length | string | "fill-available" | "fit-content" | "max-content" | "min-content"

Overflow

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

OverscrollBehavior

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

Paint

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

PointerEvents

PointerEvents: "all" | "auto" | "fill" | "none" | "painted" | "stroke" | "visible" | "visibleFill" | "visiblePainted" | "visibleStroke"

Position

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

StrokeLinecap

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

StrokeLinejoin

StrokeLinejoin: "arcs" | "bevel" | "miter" | "miter-clip" | "round"

StyleAnimatorDescriptor

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

Type parameters

  • O = unknown

  • T = unknown

  • U = never

  • I = {}

StyleConstraintAnimatorDescriptor

StyleConstraintAnimatorDescriptor<O, T, U, I>: ThisType<StyleConstraintAnimator<O, T, U> & I> & StyleConstraintAnimatorInit<T, U> & Partial<I>

Type parameters

  • O = unknown

  • T = unknown

  • U = never

  • I = {}

StyleRuleDescriptor

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

Type parameters

  • O = unknown

  • I = {}

StyleSheetDescriptor

StyleSheetDescriptor<O, I>: ThisType<StyleSheet<O> & I> & StyleSheetInit & Partial<I>

Type parameters

  • O = unknown

  • I = {}

SvgPointerEvents

SvgPointerEvents: "all" | "auto" | "bounding-box" | "fill" | "none" | "painted" | "stroke" | "visible" | "visibleFill" | "visiblePainted" | "visibleStroke"

TextAlign

TextAlign: "center" | "end" | "justify" | "justify-all" | "left" | "match-parent" | "right" | "start"

TextAnchor

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

TextDecorationStyle

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

TextTransform

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

TouchAction

TouchAction: "auto" | "manipulation" | "none" | "pan-down" | "pan-down pinch-zoom" | "pan-left" | "pan-left pan-down" | "pan-left pan-down pinch-zoom" | "pan-left pan-up" | "pan-left pan-up pinch-zoom" | "pan-left pan-y" | "pan-left pan-y pinch-zoom" | "pan-left pinch-zoom" | "pan-right" | "pan-right pan-down" | "pan-right pan-down pinch-zoom" | "pan-right pan-up" | "pan-right pan-up pinch-zoom" | "pan-right pan-y" | "pan-right pan-y pinch-zoom" | "pan-right pinch-zoom" | "pan-up" | "pan-up pinch-zoom" | "pan-x" | "pan-x pan-down" | "pan-x pan-down pinch-zoom" | "pan-x pan-up" | "pan-x pan-up pinch-zoom" | "pan-x pan-y" | "pan-x pan-y pinch-zoom" | "pan-x pinch-zoom" | "pan-y" | "pan-y pinch-zoom" | "pinch-zoom"

UserSelect

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

VerticalAlign

VerticalAlign: Length | "baseline" | "sub" | "super" | "text-top" | "text-bottom" | "middle" | "top" | "bottom"

ViewNodeType

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

Type parameters

Visibility

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

WhiteSpace

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

Width

Width: Length | string | "auto" | "available" | "fit-content" | "max-content" | "min-content"

Variables

AttributeAnimator

AttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, any, any>>

Const BooleanAttributeAnimator

BooleanAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, boolean | undefined, string>>

Const BoxShadowStyleAnimator

BoxShadowStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, BoxShadow | null, AnyBoxShadow | null>>

Const ColorAttributeAnimator

ColorAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, Color | null, AnyColor | null>>

Const ColorStyleAnimator

ColorStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, Color | null, AnyColor | null>>

CssContext

CssContext: { is: any }

Type declaration

  • is: function

    • Parameters

      • object: unknown

      Returns object is CssContext

CssRule

CssRule: CssRuleFactory<CssRule<any>>

DomProvider

DomProvider: ProviderClass<DomProvider<any, any>>

Const FontFamilyStyleAnimator

FontFamilyStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, string | readonly string[] | undefined, string | readonly string[] | undefined>>

Const LengthAttributeAnimator

LengthAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, Length | null, AnyLength | null>>

Const LengthStyleAnimator

LengthStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, Length | null, AnyLength | null>>

Const LengthStyleConstraintAnimator

LengthStyleConstraintAnimator: StyleConstraintAnimatorFactory<StyleConstraintAnimator<any, Length | null, AnyLength | null>>

MediaRule

MediaRule: MediaRuleFactory<MediaRule<any>>

Const NumberAttributeAnimator

NumberAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, number | undefined, string>>

Const NumberStyleAnimator

NumberStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, number | undefined, string>>

Const NumberStyleConstraintAnimator

NumberStyleConstraintAnimator: StyleConstraintAnimatorFactory<StyleConstraintAnimator<any, number | undefined, string>>

Const StringAttributeAnimator

StringAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, string | undefined, string | undefined>>

Const StringStyleAnimator

StringStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, string | undefined, string | undefined>>

StyleAnimator

StyleAnimator: StyleAnimatorFactory<StyleAnimator<any, any, any>>

StyleConstraintAnimator

StyleConstraintAnimator: StyleConstraintAnimatorFactory<StyleConstraintAnimator<any, any, any>>

StyleContext

StyleContext: { is: any }

Type declaration

  • is: function

    • Parameters

      • object: unknown

      Returns object is StyleContext

StyleMap

StyleMap: { define: any; init: any }

Type declaration

  • define: function

    • Parameters

      Returns void

  • init: function

    • Parameters

      Returns void

StyleRule

StyleRule: StyleRuleFactory<StyleRule<any>>

StyleSheet

StyleSheet: StyleSheetFactory<StyleSheet<any>>

Const TransformAttributeAnimator

TransformAttributeAnimator: AttributeAnimatorFactory<AttributeAnimator<any, Transform | null, AnyTransform | null>>

Const TransformStyleAnimator

TransformStyleAnimator: StyleAnimatorFactory<StyleAnimator<any, Transform | null, AnyTransform | null>>

Generated using TypeDoc