Swim Style Library

The Swim Style library implements font, color, gradient, shadow and related types and parsers.

Index

Interfaces

Variables

Functions

Type aliases

AnyBoxShadow

AnyBoxShadow: BoxShadow | BoxShadowInit | string | ReadonlyArray<AnyBoxShadow>

AnyColor

AnyColor: Color | ColorInit | string

AnyFont

AnyFont: Font | FontInit | string

AnyFontSize

AnyFontSize: AnyLength | FontSize

AnyHslColor

AnyHslColor: HslColor | HslColorInit | string

AnyLineHeight

AnyLineHeight: AnyLength | LineHeight

AnyLinearGradient

AnyLinearGradient: LinearGradient | LinearGradientInit | string

AnyLinearGradientAngle

AnyLinearGradientAngle: LinearGradientAngle | number

AnyPresence

AnyPresence: Presence | PresenceInit

AnyRgbColor

AnyRgbColor: RgbColor | RgbColorInit | string

AnyStyleValue

ColorInit

ColorInit: RgbColorInit | HslColorInit

ColorStopTuple

ColorStopTuple: [AnyColor, AnyLength | null]

FontFamily

FontFamily: string | GenericFamily

FontStretch

FontStyle

FontStyle: "normal" | "italic" | "oblique"

FontVariant

FontVariant: "normal" | "small-caps"

FontWeight

FontWeight: "normal" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900" | "bold" | "bolder" | "lighter"

GenericFamily

LineHeight

LineHeight: Length | "normal"

LinearGradientAngle

LinearGradientAngle: Angle | LinearGradientSide | LinearGradientCorner

LinearGradientCorner

LinearGradientCorner: [LinearGradientSide, LinearGradientSide]

LinearGradientSide

LinearGradientSide: "left" | "right" | "top" | "bottom"

StyleValue

Variables

BoxShadowInterpolator

BoxShadowInterpolator: { prototype: BoxShadowInterpolator }

Type declaration

- (b0: BoxShadow, b1: BoxShadow): BoxShadowInterpolator
- Parameters
  - b0: BoxShadow
  - b1: BoxShadow
  Returns BoxShadowInterpolator
prototype: BoxShadowInterpolator

ColorStopInterpolator

ColorStopInterpolator: { prototype: ColorStopInterpolator }

Type declaration

- (y0: ColorStop, y1: ColorStop): ColorStopInterpolator
- Parameters
  - y0: ColorStop
  - y1: ColorStop
  Returns ColorStopInterpolator
prototype: ColorStopInterpolator

Const ExpansionInterpolator

ExpansionInterpolator: { prototype: Interpolator<Expansion> }

Type declaration

- (e0: Expansion, e1: Expansion): Interpolator<Expansion>
- Parameters
  - e0: Expansion
  - e1: Expansion
  Returns Interpolator<Expansion>
prototype: Interpolator<Expansion>

Const FocusInterpolator

FocusInterpolator: { prototype: Interpolator<Focus> }

Type declaration

- (f0: Focus, f1: Focus): Interpolator<Focus>
- Parameters
  - f0: Focus
  - f1: Focus
  Returns Interpolator<Focus>
prototype: Interpolator<Focus>

FontFamily

FontFamily: { format: any; fromValue: any }

Type declaration

format: function
- format(family: string): string
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/FontFamily.d.ts:6
  Parameters
  - family: string
  Returns string
fromValue: function
- fromValue(value: Value): null | string | string[]
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/FontFamily.d.ts:5
  Parameters
  - value: Value
  Returns null | string | string[]

FontInterpolator

FontInterpolator: { prototype: FontInterpolator }

Type declaration

- (f0: Font, f1: Font): FontInterpolator
- Parameters
  - f0: Font
  - f1: Font
  Returns FontInterpolator
prototype: FontInterpolator

fromAny: function
- fromAny(size: AnyFontSize): FontSize
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/FontSize.d.ts:6
  Parameters
  - size: AnyFontSize
  Returns FontSize
fromValue: function
- fromValue(value: Value): null | FontSize
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/FontSize.d.ts:7
  Parameters
  - value: Value
  Returns null | FontSize

Const HslColorInterpolator

HslColorInterpolator: { prototype: Interpolator<HslColor> }

Type declaration

- (c0: HslColor, c1: HslColor): Interpolator<HslColor>
- Parameters
  - c0: HslColor
  - c1: HslColor
  Returns Interpolator<HslColor>
prototype: Interpolator<HslColor>

LineHeight

LineHeight: { fromAny: any; fromValue: any }

Type declaration

fromAny: function
- fromAny(height: AnyLineHeight): LineHeight
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/LineHeight.d.ts:6
  Parameters
  - height: AnyLineHeight
  Returns LineHeight
fromValue: function
- fromValue(value: Value): null | LineHeight
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/font/LineHeight.d.ts:7
  Parameters
  - value: Value
  Returns null | LineHeight

LinearGradientInterpolator

LinearGradientInterpolator: { prototype: LinearGradientInterpolator }

Type declaration

- (g0: LinearGradient, g1: LinearGradient): LinearGradientInterpolator
- Parameters
  - g0: LinearGradient
  - g1: LinearGradient
  Returns LinearGradientInterpolator
prototype: LinearGradientInterpolator

Const PresenceInterpolator

PresenceInterpolator: { prototype: Interpolator<Presence> }

Type declaration

- (p0: Presence, p1: Presence): Interpolator<Presence>
- Parameters
  - p0: Presence
  - p1: Presence
  Returns Interpolator<Presence>
prototype: Interpolator<Presence>

Const RgbColorInterpolator

RgbColorInterpolator: { prototype: Interpolator<RgbColor> }

Type declaration

- (c0: RgbColor, c1: RgbColor): Interpolator<RgbColor>
- Parameters
  - c0: RgbColor
  - c1: RgbColor
  Returns Interpolator<RgbColor>
prototype: Interpolator<RgbColor>

StyleValue

StyleValue: { form: any; fromAny: any; parse: any }

Type declaration

form: function
- form(): Form<StyleValue, AnyStyleValue>
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/StyleValue.d.ts:17
  Returns Form<StyleValue, AnyStyleValue>
fromAny: function
- fromAny(value: AnyStyleValue): StyleValue
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/StyleValue.d.ts:15
  Parameters
  - value: AnyStyleValue
  Returns StyleValue
parse: function
- parse(input: string | Input): StyleValue
- - Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/StyleValue.d.ts:16
  Parameters
  - input: string | Input
  Returns StyleValue

Functions

ToAttributeString

ToAttributeString(value: unknown): string

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/ToAttributeString.d.ts:4
Parameters
- value: unknown
Returns string

Let ToCssValue

ToCssValue(value: unknown): null | CSSStyleValue

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/ToCssValue.d.ts:4
Parameters
- value: unknown
Returns null | CSSStyleValue

ToStyleString

ToStyleString(value: unknown): string

- Defined in swim-toolkit-js/swim-ui-js/@swim/style/lib/main/value/ToStyleString.d.ts:4
Parameters
- value: unknown
Returns string

Swim Style Library

Index

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AnyBoxShadow

AnyColor

AnyColorStop

AnyExpansion

AnyFocus

AnyFont

AnyFontSize

AnyHslColor

AnyLineHeight

AnyLinearGradient

AnyLinearGradientAngle

AnyPresence

AnyRgbColor

AnyStyleValue

ColorInit

ColorStopTuple

FontFamily

FontSize

FontStretch

FontStyle

FontVariant

FontWeight

GenericFamily

LineHeight

LinearGradientAngle

LinearGradientCorner

LinearGradientSide

StyleValue

Variables

BoxShadowInterpolator

Type declaration

Parameters

b0: BoxShadow

b1: BoxShadow

Returns BoxShadowInterpolator

prototype: BoxShadowInterpolator

ColorStopInterpolator

Type declaration

Parameters

y0: ColorStop

y1: ColorStop

Returns ColorStopInterpolator

prototype: ColorStopInterpolator

Const ExpansionInterpolator

Type declaration

Parameters

e0: Expansion

e1: Expansion

Returns Interpolator<Expansion>

prototype: Interpolator<Expansion>

Const FocusInterpolator

Type declaration

Parameters

f0: Focus

f1: Focus

Returns Interpolator<Focus>

prototype: Interpolator<Focus>

FontFamily

Type declaration

format: function

Parameters

family: string

Returns string

fromValue: function

Parameters

value: Value

Returns null | string | string[]

FontInterpolator

Type declaration

Parameters

f0: Font

f1: Font