ThemeInput
type exported by @mwillbanks/tuil-theme.
type
Public type exported by @mwillbanks/tuil-theme.
export type ThemeInput = DeepPartial<Theme>;Members
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
id | string | undefined | No | The id member uses the string | undefined contract. | — |
colorScheme | ColorScheme | undefined | No | The colorScheme member uses the ColorScheme | undefined contract. | ColorScheme |
colors | { readonly background?: string | undefined; readonly foreground?: string | undefined; readonly muted?: string | undefined; readonly subtle?: string | undefined; readonly border?: string | undefined; readonly primary?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly secondary?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly success?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly warning?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly danger?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly info?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; } | undefined | No | The colors member uses the { readonly background?: string | undefined; readonly foreground?: string | undefined; readonly muted?: string | undefined; readonly subtle?: string | undefined; readonly border?: string | undefined; readonly primary?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly secondary?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly success?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly warning?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly danger?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; readonly info?: { readonly foreground?: string | undefined; readonly background?: string | undefined; readonly border?: string | undefined; } | undefined; } | undefined contract. | — |
spacing | { readonly sm?: number | undefined; readonly md?: number | undefined; readonly lg?: number | undefined; readonly none?: number | undefined; readonly xs?: number | undefined; readonly xl?: number | undefined; } | undefined | No | The spacing member uses the { readonly sm?: number | undefined; readonly md?: number | undefined; readonly lg?: number | undefined; readonly none?: number | undefined; readonly xs?: number | undefined; readonly xl?: number | undefined; } | undefined contract. | — |
borders | { readonly none?: readonly [string, string, string, string, string, string] | undefined; readonly single?: readonly [string, string, string, string, string, string] | undefined; readonly round?: readonly [string, string, string, string, string, string] | undefined; readonly double?: readonly [string, string, string, string, string, string] | undefined; } | undefined | No | The borders member uses the { readonly none?: readonly [string, string, string, string, string, string] | undefined; readonly single?: readonly [string, string, string, string, string, string] | undefined; readonly round?: readonly [string, string, string, string, string, string] | undefined; readonly double?: readonly [string, string, string, string, string, string] | undefined; } | undefined contract. | — |
typography | { readonly headingBold?: boolean | undefined; readonly codeColor?: string | undefined; } | undefined | No | The typography member uses the { readonly headingBold?: boolean | undefined; readonly codeColor?: string | undefined; } | undefined contract. | — |
icons | { readonly success?: string | undefined; readonly warning?: string | undefined; readonly error?: string | undefined; readonly pending?: string | undefined; } | undefined | No | The icons member uses the { readonly success?: string | undefined; readonly warning?: string | undefined; readonly error?: string | undefined; readonly pending?: string | undefined; } | undefined contract. | — |
motion | { readonly enabled?: boolean | undefined; readonly spinnerFrames?: readonly string[] | undefined; readonly interval?: number | undefined; } | undefined | No | The motion member uses the { readonly enabled?: boolean | undefined; readonly spinnerFrames?: readonly string[] | undefined; readonly interval?: number | undefined; } | undefined contract. | — |
components | { readonly [x: string]: { readonly defaultProps?: { readonly [x: string]: unknown; } | undefined; readonly variants?: { readonly [x: string]: { readonly [x: string]: unknown; } | undefined; } | undefined; readonly sizes?: { readonly [x: string]: { readonly [x: string]: unknown; } | undefined; } | undefined; } | undefined; } | undefined | No | The components member uses the { readonly [x: string]: { readonly defaultProps?: { readonly [x: string]: unknown; } | undefined; readonly variants?: { readonly [x: string]: { readonly [x: string]: unknown; } | undefined; } | undefined; readonly sizes?: { readonly [x: string]: { readonly [x: string]: unknown; } | undefined; } | undefined; } | undefined; } | undefined contract. | — |
Parameters
This declaration has no public members.
Returns
This declaration does not return a value.
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference