claritykit-svelte
Version:
A comprehensive Svelte component library focused on accessibility, ADHD-optimized design, developer experience, and full SSR compatibility
130 lines • 3.96 kB
TypeScript
/**
* Therapeutic Component Accessibility Utilities
*
* Specialized accessibility functions for therapeutic and ADHD-focused components
* that go beyond standard accessibility to support neurodivergent users.
*/
export interface TherapeuticAccessibilityConfig {
enableContextualHelp: boolean;
enableProgressAnnouncements: boolean;
enableEmotionalSupport: boolean;
enableCrisisDetection: boolean;
announceEveryNthAction: number;
emotionalSupportMessages: boolean;
}
/**
* Initialize therapeutic accessibility system
*/
export declare function initTherapeuticAccessibility(userConfig?: Partial<TherapeuticAccessibilityConfig>): void;
/**
* Create comprehensive ARIA descriptions for therapeutic components
*/
export declare function createTherapeuticAriaDescription(component: {
type: string;
purpose: string;
usage: string;
benefits: string[];
currentState?: string;
interactions?: string[];
helpAvailable?: boolean;
}): string;
/**
* Generate contextual help for therapeutic components
*/
export declare function generateContextualHelp(component: {
type: string;
currentMode?: string;
availableActions?: string[];
keyboardShortcuts?: Record<string, string>;
tips?: string[];
}): string;
/**
* Announce mood or energy state changes with emotional support
*/
export declare function announceMoodChange(change: {
component: string;
previousValue: number | string;
newValue: number | string;
label: string;
description: string;
context?: string;
}): void;
/**
* Announce energy level changes with adaptive guidance
*/
export declare function announceEnergyChange(change: {
component: string;
previousLevel: string;
newLevel: string;
description: string;
suggestions?: string[];
}): void;
/**
* Announce breathing exercise progress with calming guidance
*/
export declare function announceBreathingProgress(progress: {
component: string;
phase: 'inhale' | 'hold' | 'exhale';
cycleCount: number;
duration: number;
paused?: boolean;
}): void;
/**
* Announce crisis mode changes with clear guidance
*/
export declare function announceCrisisModeChange(change: {
component: string;
activated: boolean;
severity?: 'mild' | 'moderate' | 'severe';
adaptations?: string[];
}): void;
/**
* Provide progress announcements for multi-step therapeutic processes
*/
export declare function announceTherapeuticProgress(progress: {
component: string;
currentStep: number;
totalSteps: number;
stepName?: string;
completed?: boolean;
encouragement?: boolean;
}): void;
/**
* Handle therapeutic component errors with supportive messaging
*/
export declare function announceTherapeuticError(error: {
component: string;
type: 'validation' | 'connection' | 'timeout' | 'unknown';
message: string;
suggestion?: string;
reassurance?: boolean;
}): void;
/**
* Generate ADHD-friendly keyboard shortcut descriptions
*/
export declare function createKeyboardShortcutDescription(shortcuts: Record<string, string>): string;
/**
* Create accessible state announcements for complex therapeutic components
*/
export declare function announceComplexState(state: {
component: string;
mainState: string;
details: Record<string, any>;
userActions?: string[];
context?: string;
}): void;
/**
* Smart help system that adapts to user behavior patterns
*/
export declare function provideAdaptiveHelp(component: string, context: {
userStruggles?: string[];
repeatAttempts?: number;
timeSpent?: number;
lastAction?: string;
}): string;
/**
* Export configuration getter/setter
*/
export declare function getTherapeuticAccessibilityConfig(): TherapeuticAccessibilityConfig;
export declare function updateTherapeuticAccessibilityConfig(updates: Partial<TherapeuticAccessibilityConfig>): void;
//# sourceMappingURL=therapeutic-accessibility.d.ts.map