Interface: ShimConfiguration

twind/shim.ShimConfiguration

Options for setup.

Hierarchy

Properties

darkMode

Optional darkMode: false | media | class

Determines the dark mode strategy (default: "media").

Inherited from: Configuration.darkMode

Defined in: src/types/twind.ts:88


hash

Optional hash: boolean | Hasher

Inherited from: Configuration.hash

Defined in: src/types/twind.ts:119


important

Optional important: boolean

Control whether or not utilities should be marked with !important

Inherited from: Configuration.important

Defined in: src/types/twind.ts:126


mode

Optional mode: Mode | strict | warn | silent

Inherited from: Configuration.mode

Defined in: src/types/twind.ts:121


nonce

Optional nonce: string

Sets a cryptographic nonce (number used once) on the enclosing <style> tag when generating a page on demand.

Useful for enforcing a Content Security Policy (CSP).

Inherited from: Configuration.nonce

Defined in: src/types/twind.ts:108


plugins

Optional plugins: Record<string, undefined | string | CSSRules | DirectiveHandler>

Inherited from: Configuration.plugins

Defined in: src/types/twind.ts:92


prefix

Optional prefix: boolean | Prefixer

Auto-prefixer method for CSS property–value pairs.

Inherited from: Configuration.prefix

Defined in: src/types/twind.ts:117


preflight

Optional preflight: boolean | CSSRules | Preflight

Called right before the first rule is injected.

Inherited from: Configuration.preflight

Defined in: src/types/twind.ts:114


sheet

Optional sheet: Sheet<unknown>

Style insertion methodology to be used.

Inherited from: Configuration.sheet

Defined in: src/types/twind.ts:111


target

Optional target: HTMLElement

The root element to shim (default: document.documentElement).

Defined in: src/shim/index.ts:21


theme

Optional theme: ThemeConfiguration

Inherited from: Configuration.theme

Defined in: src/types/twind.ts:90


variants

Optional variants: Record<string, string>

{
  ':new-variant': '& .selector',
}

Inherited from: Configuration.variants

Defined in: src/types/twind.ts:101