accessibility-plugin-react 2.6.0 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -21
- package/dist/index.d.mts +20 -2
- package/dist/index.d.ts +20 -2
- package/dist/index.js +471 -218
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +458 -211
- package/dist/index.mjs.map +1 -1
- package/docs/API.md +3 -3
- package/docs/BUILD_AND_RELEASE_PLAN.md +1 -1
- package/docs/CONTRAST.md +73 -0
- package/docs/FEATURES.md +21 -20
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -88,27 +88,27 @@ export function App() {
|
|
|
88
88
|
Every controller is opt-in. Add only the controls that make sense for your
|
|
89
89
|
site, and choose their order in JSX.
|
|
90
90
|
|
|
91
|
-
| Controller
|
|
92
|
-
|
|
|
93
|
-
| `TextScaleController`
|
|
94
|
-
| `FontSizeController`
|
|
95
|
-
| `LineHeightController`
|
|
96
|
-
| `LetterSpacingController`
|
|
97
|
-
| `WordSpacingController`
|
|
98
|
-
| `
|
|
99
|
-
| `
|
|
100
|
-
| `SaturationController`
|
|
101
|
-
| `InvertColorsController`
|
|
102
|
-
| `GrayscaleController`
|
|
103
|
-
| `LinkHighlightController`
|
|
104
|
-
| `TextAlignController`
|
|
105
|
-
| `FontFamilyController`
|
|
106
|
-
| `HideImagesController`
|
|
107
|
-
| `HideVideosController`
|
|
108
|
-
| `BigCursorController`
|
|
109
|
-
| `ReadingMaskController`
|
|
110
|
-
| `ReadingGuideController`
|
|
111
|
-
| `ResetController`
|
|
91
|
+
| Controller | Effect |
|
|
92
|
+
| ------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
93
|
+
| `TextScaleController` | Stepwise reflow-safe text enlargement (1.0x, 1.125x, 1.25x, 1.5x, 2.0x) protecting forms, code, and icons. |
|
|
94
|
+
| `FontSizeController` | Scales eligible HTML text from 50% to 200%; supports continuous 10% steps or `stepScale` mode. |
|
|
95
|
+
| `LineHeightController` | Scales computed line height (50%–200%, step 10); supports `stepPresets` (100%, 150%, 175%, 200%). |
|
|
96
|
+
| `LetterSpacingController` | Applies 0–10px letter spacing with automatic cursive (Arabic/RTL) and Indic (Sinhala/Tamil) protection. |
|
|
97
|
+
| `WordSpacingController` | Applies 0–10px word spacing while protecting tables, code, forms, and widget internals. |
|
|
98
|
+
| `ContrastController` | Adjusts contrast levels, palettes, or semantic modes while preserving images, video, charts, and validation. |
|
|
99
|
+
| `ContrastModeController` | Applies light, dark, high contrast, or media-safe invert tokens with native forced-colors protection. |
|
|
100
|
+
| `SaturationController` | Reduces or increases saturation. |
|
|
101
|
+
| `InvertColorsController` | Inverts eligible page content. |
|
|
102
|
+
| `GrayscaleController` | Removes color while preserving the selected saturation value for later. |
|
|
103
|
+
| `LinkHighlightController` | Highlights links or selects a link palette. |
|
|
104
|
+
| `TextAlignController` | Scopes left, center, right, or justified alignment to text blocks; warns about justification. |
|
|
105
|
+
| `FontFamilyController` | Applies clean system-ui or OpenDyslexic with Sinhala/Tamil fallbacks while protecting code and icons. |
|
|
106
|
+
| `HideImagesController` | Hides images and CSS background images while retaining layout. |
|
|
107
|
+
| `HideVideosController` | Hides video elements and recognized YouTube/Vimeo embeds visually. |
|
|
108
|
+
| `BigCursorController` | Applies a larger high-contrast cursor where supported. |
|
|
109
|
+
| `ReadingMaskController` | Dims the page around a transparent reading window. |
|
|
110
|
+
| `ReadingGuideController` | Follows pointer/focus with a reading guide line. |
|
|
111
|
+
| `ResetController` | Resets display features and custom registered features without moving the widget. |
|
|
112
112
|
|
|
113
113
|
Effects compose where appropriate. For example, contrast, saturation, invert,
|
|
114
114
|
and grayscale are applied in a deterministic order. Defaults leave host styles
|
package/dist/index.d.mts
CHANGED
|
@@ -374,7 +374,23 @@ declare const LINE_HEIGHT_RATIOS: readonly [1, 1.5, 1.75, 2];
|
|
|
374
374
|
*/
|
|
375
375
|
declare const FONT_FAMILY_PRESETS: readonly ["default", "legible", "dyslexia-option"];
|
|
376
376
|
type FontFamilyPreset = (typeof FONT_FAMILY_PRESETS)[number];
|
|
377
|
-
|
|
377
|
+
/**
|
|
378
|
+
* Semantic contrast modes: off/original (standard colors), light (crisp light), dark (deep dark), high (AAA high contrast), invert (luminance inversion).
|
|
379
|
+
*/
|
|
380
|
+
declare const CONTRAST_MODES: readonly ["off", "original", "light", "dark", "high", "invert"];
|
|
381
|
+
type ContrastModeValue = (typeof CONTRAST_MODES)[number];
|
|
382
|
+
|
|
383
|
+
/** Detects whether the user's operating system has forced colors / high contrast active. */
|
|
384
|
+
declare function isForcedColorsActive(): boolean;
|
|
385
|
+
interface ContrastPalette {
|
|
386
|
+
text: string;
|
|
387
|
+
background: string;
|
|
388
|
+
border?: string;
|
|
389
|
+
link?: string;
|
|
390
|
+
}
|
|
391
|
+
declare const CONTRAST_PALETTES: Record<string, ContrastPalette>;
|
|
392
|
+
declare const CONTRAST_PROTECTED_SELECTOR: string;
|
|
393
|
+
declare function isProtectedFromContrast(element: HTMLElement): boolean;
|
|
378
394
|
declare const TEXT_SCALE_PROTECTED_SELECTOR: string;
|
|
379
395
|
declare function isProtectedFromTextScale(element: HTMLElement): boolean;
|
|
380
396
|
declare const TEXT_SPACING_EXCLUDED_SELECTOR: string;
|
|
@@ -439,6 +455,8 @@ declare function ParagraphSpacingController({ min, max, step, steps, }?: Paragra
|
|
|
439
455
|
|
|
440
456
|
declare function ContrastController(): react.JSX.Element;
|
|
441
457
|
|
|
458
|
+
declare function ContrastModeController(): react.JSX.Element;
|
|
459
|
+
|
|
442
460
|
declare function SaturationController(): react.JSX.Element;
|
|
443
461
|
|
|
444
462
|
declare function InvertColorsController(): react.JSX.Element;
|
|
@@ -463,4 +481,4 @@ declare function ReadingGuideController(): react.JSX.Element;
|
|
|
463
481
|
|
|
464
482
|
declare function ResetController(): react.JSX.Element;
|
|
465
483
|
|
|
466
|
-
export { AccessibilityButton, type AccessibilityButtonProps, AccessibilityContext, type AccessibilityContextValue, AccessibilityList, type AccessibilityListProps, AccessibilityPlugin, type AccessibilityPluginProps, type AccessibilityPreferences, type AccessibilityState, BigCursorController, ChoiceControl, type ChoiceControlProps, type ChoiceGroup, type ChoiceOption, ContrastController, type ContrastMode, type CursorSizePreference, DEFAULT_PREFERENCES, DYSLEXIA_FONT_STACK, EmptyState, type EmptyStateProps, ErrorState, type ErrorStateProps, FONT_FAMILY_PRESETS, FONT_FAMILY_PROTECTED_SELECTOR, FeatureCard, type FeatureCardProps, type FeatureOptions, type FeatureRegistration, type FeatureStatus, FontFamilyController, type FontFamilyPreference, type FontFamilyPreset, FontSizeController, type FontSizeControllerProps, GrayscaleController, HideImagesController, HideVideosController, InvertColorsController, LEGIBLE_FONT_STACK, LINE_HEIGHT_RATIOS, LINE_HEIGHT_STEPS, LetterSpacingController, type LetterSpacingControllerProps, LineHeightController, type LineHeightControllerProps, LinkHighlightController, type LocaleStrings, PROFILE_DEFINITIONS, ParagraphSpacingController, type ParagraphSpacingControllerProps, type PluginPosition, type ProfileDefinition, type ProfilePresetId, ProfilePreviewCard, type ProfilePreviewCardProps, type ReaderMode, ReadingGuideController, ReadingMaskController, ResetController, SaturationController, type SaturationPreference, type ScriptSpacingConstraints, SearchCount, type SearchCountProps, StepperControl, type StepperControlProps, type StorageMode, type SupportedLocale, TEXT_ALIGN_BLOCK_SELECTOR, TEXT_SCALE_PROTECTED_SELECTOR, TEXT_SCALE_STEPS, TEXT_SPACING_EXCLUDED_SELECTOR, TextAlignController, type TextAlignPreference, TextScaleController, type TextScaleControllerProps, type TextScaleStep, ToggleControl, type ToggleControlProps, type WidgetPlacement, WordSpacingController, type WordSpacingControllerProps, createInitialPreferencesState, enLocale, getScriptSpacingConstraints, isProtectedFromFontFamily, isProtectedFromTextAlign, isProtectedFromTextScale, isProtectedFromTextSpacing, isRtlLocale, normalizePreferenceValue, normalizePreferences, preferencesReducer, registerLocale, resolveEffectivePreferences, resolveLocaleStrings, useAccessibility };
|
|
484
|
+
export { AccessibilityButton, type AccessibilityButtonProps, AccessibilityContext, type AccessibilityContextValue, AccessibilityList, type AccessibilityListProps, AccessibilityPlugin, type AccessibilityPluginProps, type AccessibilityPreferences, type AccessibilityState, BigCursorController, CONTRAST_MODES, CONTRAST_PALETTES, CONTRAST_PROTECTED_SELECTOR, ChoiceControl, type ChoiceControlProps, type ChoiceGroup, type ChoiceOption, ContrastController, type ContrastMode, ContrastModeController, type ContrastModeValue, type ContrastPalette, type CursorSizePreference, DEFAULT_PREFERENCES, DYSLEXIA_FONT_STACK, EmptyState, type EmptyStateProps, ErrorState, type ErrorStateProps, FONT_FAMILY_PRESETS, FONT_FAMILY_PROTECTED_SELECTOR, FeatureCard, type FeatureCardProps, type FeatureOptions, type FeatureRegistration, type FeatureStatus, FontFamilyController, type FontFamilyPreference, type FontFamilyPreset, FontSizeController, type FontSizeControllerProps, GrayscaleController, HideImagesController, HideVideosController, InvertColorsController, LEGIBLE_FONT_STACK, LINE_HEIGHT_RATIOS, LINE_HEIGHT_STEPS, LetterSpacingController, type LetterSpacingControllerProps, LineHeightController, type LineHeightControllerProps, LinkHighlightController, type LocaleStrings, PROFILE_DEFINITIONS, ParagraphSpacingController, type ParagraphSpacingControllerProps, type PluginPosition, type ProfileDefinition, type ProfilePresetId, ProfilePreviewCard, type ProfilePreviewCardProps, type ReaderMode, ReadingGuideController, ReadingMaskController, ResetController, SaturationController, type SaturationPreference, type ScriptSpacingConstraints, SearchCount, type SearchCountProps, StepperControl, type StepperControlProps, type StorageMode, type SupportedLocale, TEXT_ALIGN_BLOCK_SELECTOR, TEXT_SCALE_PROTECTED_SELECTOR, TEXT_SCALE_STEPS, TEXT_SPACING_EXCLUDED_SELECTOR, TextAlignController, type TextAlignPreference, TextScaleController, type TextScaleControllerProps, type TextScaleStep, ToggleControl, type ToggleControlProps, type WidgetPlacement, WordSpacingController, type WordSpacingControllerProps, createInitialPreferencesState, enLocale, getScriptSpacingConstraints, isForcedColorsActive, isProtectedFromContrast, isProtectedFromFontFamily, isProtectedFromTextAlign, isProtectedFromTextScale, isProtectedFromTextSpacing, isRtlLocale, normalizePreferenceValue, normalizePreferences, preferencesReducer, registerLocale, resolveEffectivePreferences, resolveLocaleStrings, useAccessibility };
|
package/dist/index.d.ts
CHANGED
|
@@ -374,7 +374,23 @@ declare const LINE_HEIGHT_RATIOS: readonly [1, 1.5, 1.75, 2];
|
|
|
374
374
|
*/
|
|
375
375
|
declare const FONT_FAMILY_PRESETS: readonly ["default", "legible", "dyslexia-option"];
|
|
376
376
|
type FontFamilyPreset = (typeof FONT_FAMILY_PRESETS)[number];
|
|
377
|
-
|
|
377
|
+
/**
|
|
378
|
+
* Semantic contrast modes: off/original (standard colors), light (crisp light), dark (deep dark), high (AAA high contrast), invert (luminance inversion).
|
|
379
|
+
*/
|
|
380
|
+
declare const CONTRAST_MODES: readonly ["off", "original", "light", "dark", "high", "invert"];
|
|
381
|
+
type ContrastModeValue = (typeof CONTRAST_MODES)[number];
|
|
382
|
+
|
|
383
|
+
/** Detects whether the user's operating system has forced colors / high contrast active. */
|
|
384
|
+
declare function isForcedColorsActive(): boolean;
|
|
385
|
+
interface ContrastPalette {
|
|
386
|
+
text: string;
|
|
387
|
+
background: string;
|
|
388
|
+
border?: string;
|
|
389
|
+
link?: string;
|
|
390
|
+
}
|
|
391
|
+
declare const CONTRAST_PALETTES: Record<string, ContrastPalette>;
|
|
392
|
+
declare const CONTRAST_PROTECTED_SELECTOR: string;
|
|
393
|
+
declare function isProtectedFromContrast(element: HTMLElement): boolean;
|
|
378
394
|
declare const TEXT_SCALE_PROTECTED_SELECTOR: string;
|
|
379
395
|
declare function isProtectedFromTextScale(element: HTMLElement): boolean;
|
|
380
396
|
declare const TEXT_SPACING_EXCLUDED_SELECTOR: string;
|
|
@@ -439,6 +455,8 @@ declare function ParagraphSpacingController({ min, max, step, steps, }?: Paragra
|
|
|
439
455
|
|
|
440
456
|
declare function ContrastController(): react.JSX.Element;
|
|
441
457
|
|
|
458
|
+
declare function ContrastModeController(): react.JSX.Element;
|
|
459
|
+
|
|
442
460
|
declare function SaturationController(): react.JSX.Element;
|
|
443
461
|
|
|
444
462
|
declare function InvertColorsController(): react.JSX.Element;
|
|
@@ -463,4 +481,4 @@ declare function ReadingGuideController(): react.JSX.Element;
|
|
|
463
481
|
|
|
464
482
|
declare function ResetController(): react.JSX.Element;
|
|
465
483
|
|
|
466
|
-
export { AccessibilityButton, type AccessibilityButtonProps, AccessibilityContext, type AccessibilityContextValue, AccessibilityList, type AccessibilityListProps, AccessibilityPlugin, type AccessibilityPluginProps, type AccessibilityPreferences, type AccessibilityState, BigCursorController, ChoiceControl, type ChoiceControlProps, type ChoiceGroup, type ChoiceOption, ContrastController, type ContrastMode, type CursorSizePreference, DEFAULT_PREFERENCES, DYSLEXIA_FONT_STACK, EmptyState, type EmptyStateProps, ErrorState, type ErrorStateProps, FONT_FAMILY_PRESETS, FONT_FAMILY_PROTECTED_SELECTOR, FeatureCard, type FeatureCardProps, type FeatureOptions, type FeatureRegistration, type FeatureStatus, FontFamilyController, type FontFamilyPreference, type FontFamilyPreset, FontSizeController, type FontSizeControllerProps, GrayscaleController, HideImagesController, HideVideosController, InvertColorsController, LEGIBLE_FONT_STACK, LINE_HEIGHT_RATIOS, LINE_HEIGHT_STEPS, LetterSpacingController, type LetterSpacingControllerProps, LineHeightController, type LineHeightControllerProps, LinkHighlightController, type LocaleStrings, PROFILE_DEFINITIONS, ParagraphSpacingController, type ParagraphSpacingControllerProps, type PluginPosition, type ProfileDefinition, type ProfilePresetId, ProfilePreviewCard, type ProfilePreviewCardProps, type ReaderMode, ReadingGuideController, ReadingMaskController, ResetController, SaturationController, type SaturationPreference, type ScriptSpacingConstraints, SearchCount, type SearchCountProps, StepperControl, type StepperControlProps, type StorageMode, type SupportedLocale, TEXT_ALIGN_BLOCK_SELECTOR, TEXT_SCALE_PROTECTED_SELECTOR, TEXT_SCALE_STEPS, TEXT_SPACING_EXCLUDED_SELECTOR, TextAlignController, type TextAlignPreference, TextScaleController, type TextScaleControllerProps, type TextScaleStep, ToggleControl, type ToggleControlProps, type WidgetPlacement, WordSpacingController, type WordSpacingControllerProps, createInitialPreferencesState, enLocale, getScriptSpacingConstraints, isProtectedFromFontFamily, isProtectedFromTextAlign, isProtectedFromTextScale, isProtectedFromTextSpacing, isRtlLocale, normalizePreferenceValue, normalizePreferences, preferencesReducer, registerLocale, resolveEffectivePreferences, resolveLocaleStrings, useAccessibility };
|
|
484
|
+
export { AccessibilityButton, type AccessibilityButtonProps, AccessibilityContext, type AccessibilityContextValue, AccessibilityList, type AccessibilityListProps, AccessibilityPlugin, type AccessibilityPluginProps, type AccessibilityPreferences, type AccessibilityState, BigCursorController, CONTRAST_MODES, CONTRAST_PALETTES, CONTRAST_PROTECTED_SELECTOR, ChoiceControl, type ChoiceControlProps, type ChoiceGroup, type ChoiceOption, ContrastController, type ContrastMode, ContrastModeController, type ContrastModeValue, type ContrastPalette, type CursorSizePreference, DEFAULT_PREFERENCES, DYSLEXIA_FONT_STACK, EmptyState, type EmptyStateProps, ErrorState, type ErrorStateProps, FONT_FAMILY_PRESETS, FONT_FAMILY_PROTECTED_SELECTOR, FeatureCard, type FeatureCardProps, type FeatureOptions, type FeatureRegistration, type FeatureStatus, FontFamilyController, type FontFamilyPreference, type FontFamilyPreset, FontSizeController, type FontSizeControllerProps, GrayscaleController, HideImagesController, HideVideosController, InvertColorsController, LEGIBLE_FONT_STACK, LINE_HEIGHT_RATIOS, LINE_HEIGHT_STEPS, LetterSpacingController, type LetterSpacingControllerProps, LineHeightController, type LineHeightControllerProps, LinkHighlightController, type LocaleStrings, PROFILE_DEFINITIONS, ParagraphSpacingController, type ParagraphSpacingControllerProps, type PluginPosition, type ProfileDefinition, type ProfilePresetId, ProfilePreviewCard, type ProfilePreviewCardProps, type ReaderMode, ReadingGuideController, ReadingMaskController, ResetController, SaturationController, type SaturationPreference, type ScriptSpacingConstraints, SearchCount, type SearchCountProps, StepperControl, type StepperControlProps, type StorageMode, type SupportedLocale, TEXT_ALIGN_BLOCK_SELECTOR, TEXT_SCALE_PROTECTED_SELECTOR, TEXT_SCALE_STEPS, TEXT_SPACING_EXCLUDED_SELECTOR, TextAlignController, type TextAlignPreference, TextScaleController, type TextScaleControllerProps, type TextScaleStep, ToggleControl, type ToggleControlProps, type WidgetPlacement, WordSpacingController, type WordSpacingControllerProps, createInitialPreferencesState, enLocale, getScriptSpacingConstraints, isForcedColorsActive, isProtectedFromContrast, isProtectedFromFontFamily, isProtectedFromTextAlign, isProtectedFromTextScale, isProtectedFromTextSpacing, isRtlLocale, normalizePreferenceValue, normalizePreferences, preferencesReducer, registerLocale, resolveEffectivePreferences, resolveLocaleStrings, useAccessibility };
|