Style-related Types

The library also provides a set of variables and types for use with TypeScript. They can help you use the styles correctly and in a type-safe manner. They are primarily intended for use with SolidJS and my @spuxx/solid library.

Type Aliases

BaseColor

BaseColor = typeof BaseColor[keyof typeof BaseColor]

Defined in: index.ts:4

The base color of an element.

---

ContentColor

ContentColor = typeof ContentColor[keyof typeof ContentColor]

Defined in: index.ts:25

The content color of an element.

---

ControlSize

ControlSize = typeof ControlSize[keyof typeof ControlSize]

Defined in: index.ts:54

The size of a control element.

---

HoverEffect

HoverEffect = typeof HoverEffect[keyof typeof HoverEffect]

Defined in: index.ts:69

---

ModalSize

ModalSize = typeof ModalSize[keyof typeof ModalSize]

Defined in: index.ts:39

The size of a modal dialog.

Variables

BaseColor

const BaseColor: object

Defined in: index.ts:4

The base color of an element.

Type declaration

accent

readonly accent: "accent" = 'accent'

background

readonly background: "background" = 'background'

error

readonly error: "error" = 'error'

gradient

readonly gradient: "gradient" = 'gradient'

info

readonly info: "info" = 'info'

primary

readonly primary: "primary" = 'primary'

secondary

readonly secondary: "secondary" = 'secondary'

success

readonly success: "success" = 'success'

surface

readonly surface: "surface" = 'surface'

warning

readonly warning: "warning" = 'warning'

---

ContentColor

const ContentColor: object

Defined in: index.ts:25

The content color of an element.

Type declaration

default

readonly default: "text-default" = 'text-default'

highlighted

readonly highlighted: "text-highlighted" = 'text-highlighted'

subtle

readonly subtle: "text-subtle" = 'text-subtle'

---

ControlSize

const ControlSize: object

Defined in: index.ts:54

The size of a control element.

Type declaration

auto

readonly auto: "auto" = 'auto'

full

readonly full: "full" = 'full'

large

readonly large: "large" = 'large'

medium

readonly medium: "medium" = 'medium'

small

readonly small: "small" = 'small'

---

HoverEffect

const HoverEffect: object

Defined in: index.ts:69

The hover effect applied to an element.

Type declaration

none

readonly none: "none" = 'none'

scale

readonly scale: "scale" = 'scale'

stylizedShadow

readonly stylizedShadow: "stylized-shadow" = 'stylized-shadow'

---

ModalSize

const ModalSize: object

Defined in: index.ts:39

The size of a modal dialog.

Type declaration

auto

readonly auto: "auto" = 'auto'

full

readonly full: "full" = 'full'

large

readonly large: "large" = 'large'

medium

readonly medium: "medium" = 'medium'

small

readonly small: "small" = 'small'