IContrastOptions

interface
Accessibility

Runtime text-contrast guard configuration consumed by the v-contrast directive. enabled toggles the feature; threshold sets the minimum WCAG contrast ratio (default 4.5 — AA for normal text).

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

API

Properties

Every property declared by this interface, with its type, optionality and default.

enabled
boolean
Whether the contrast guard is active. Defaults to true.
threshold
number
Minimum acceptable WCAG contrast ratio. Defaults to 4.5 (AA for normal text).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Configuring the contrast guard at plugin install

typescript