API Reference

useAccessKit

1 min read

useAccessKit

React hook that provides access to the current accessibility settings and updater functions from AccessKitProvider. It can only be used inside the provider; otherwise it throws an error.

PropTypeDefaultRequiredDescription
settingsAccessKitSettings-YesCurrent accessibility preferences (reducedMotion, highContrast, enhancedFocus, spacing, font size, dyslexiaFont, colorVision).
setSetting(key: AccessKitSettingKey, value: boolean | number | string) => void-YesSet a single setting by key. The value type depends on the chosen setting.
toggleSetting(key: AccessKitSettingKey) => void-YesToggle a boolean setting (e.g. reducedMotion, highContrast, enhancedFocus, dyslexiaFont).
setFontSize(value: number) => void-YesSet font size (percentage; typically 80–200).
setLetterSpacing (value: number) => void-Yes Set letter spacing (0–100).
setWordSpacing(value: number) => void-YesSet word spacing (0–100).
setLineHeight(value: number) => void-Yes Set line height (0–100).
resetSettings() => void-YesReset all settings back to defaults.