Options
All
  • Public
  • Public/Protected
  • All
Menu

Project @beamwind/types - v2.2.0

Index

Type aliases

Declarations

Declarations: Record<string, string | string[] | Falsy>

Falsy

Falsy: "" | 0 | 0 | false | null | undefined

Hasher

Hasher: (value: string) => string

Type declaration

    • (value: string): string
    • Parameters

      • value: string

      Returns string

InjectKeyframes

InjectKeyframes: (name: string, waypoints?: Record<string, Declarations>) => string

Type declaration

    • (name: string, waypoints?: Record<string, Declarations>): string
    • Parameters

      • name: string
      • Optional waypoints: Record<string, Declarations>

      Returns string

InlinePlugin

InlinePlugin: (theme: ThemeValueResolver, context: PluginContext) => PluginResult | PluginTokenResult

Type declaration

OnInit

OnInit: (insert: OnInitCallback, theme: ThemeResolver) => void

Type declaration

OnInitCallback

OnInitCallback: (rule: string) => void

Type declaration

    • (rule: string): void
    • Parameters

      • rule: string

      Returns void

Plugin

Plugin: PluginResult | ((parts: string[], theme: ThemeValueResolver, context: PluginContext) => PluginResult | PluginTokenResult)

PluginResult

PluginResult: string | Declarations | [suffix: string, declarations: Declarations | Falsy] | [selectorDecorator: SelectorDecorator, declarations: Declarations | Falsy] | Falsy

PluginTokenResult

PluginTokenResult: (parse: TokenParser) => void

Type declaration

Prefixer

Prefixer: (property: string, value: string) => string

Type declaration

    • (property: string, value: string): string
    • Parameters

      • property: string
      • value: string

      Returns string

SelectorDecorator

SelectorDecorator: (selector: string) => string

Type declaration

    • (selector: string): string
    • Parameters

      • selector: string

      Returns string

ThemeAnimation

ThemeAnimation: string | [shorthand: string] | [shorthand: string, name: string]

ThemeConfiguration

ThemeConfiguration: PartialTheme | ((theme: ThemeResolver) => PartialTheme)

ThemeExtend

ThemeExtend: {[ K in keyof Theme]: ThemeSectionRecord<ThemeSectionValueType<Theme[K]>> }

ThemeFontSize

ThemeFontSize: string | [size: string, lineHeight: string] | [size: string, options: { letterSpacing?: string; lineHeight?: string }]

ThemeKeyframes

ThemeKeyframes: Record<string, Declarations>

ThemeOutline

ThemeOutline: [outline: string, offset: string]

ThemeSection

ThemeSection<T>: ThemeSectionRecord<T> | ThemeSectionResolver<T>

Type parameters

  • T = string

ThemeSectionRecord

ThemeSectionRecord<T>: Record<string, T | undefined | ThemeSectionRecordValueResolver<T>>

Type parameters

  • T = string

ThemeSectionRecordValueResolver

ThemeSectionRecordValueResolver<T>: (theme: ThemeResolver, context: ThemeSectionResolverContext) => T | undefined

Type parameters

  • T = string

Type declaration

ThemeSectionResolver

ThemeSectionResolver<T>: (theme: ThemeResolver, context: ThemeSectionResolverContext) => ThemeSection<T>

Type parameters

  • T = string

Type declaration

ThemeSectionValueType

ThemeSectionValueType<T>: T extends ThemeSection<infer R> ? R : never

Type parameters

  • T

Token

Token: string | InlinePlugin | TokenGrouping | Token[] | Falsy | TypescriptCompat

TokenParser

TokenParser: (token: Token) => void

Type declaration

    • Parameters

      Returns void

Generated using TypeDoc