API Reference

// Available feature names for enable/disable/toggle:
'highContrast'      // High contrast mode
'keyboardNav'       // Enhanced keyboard navigation
'highlightLinks'    // Highlight all links
'readingGuide'      // Reading guide line
'readingMask'       // Focus mask overlay
'reduceMotion'      // Reduce animations
'accessibleFont'    // Accessible font family
'darkMode'          // Dark mode
'largeCursor'       // Large cursor
'highlightHeadings' // Highlight headings
'hitTargets'        // Larger click targets
'landmarks'         // Show landmarks/skip nav
'toc'               // Table of contents overlay
'breadcrumbs'       // Breadcrumb navigation
'altSuggest'        // Alt text suggestions
'contrastAdjust'    // Adjust contrast levels
'hoverDisable'      // Disable hover effects
'captions'          // Enable captions
'formAssist'        // Form assistance
'simplifyText'      // Simplify text
'focusAssist'       // Focus assistance
'muteMedia'         // Mute all media

// Special methods:
A11yCore.features.colorFilter('protanopia'); // 'none' | 'protanopia' | 'deuteranopia' | 'tritanopia' | 'monochrome'
A11yCore.features.spacing('comfortable');    // 'compact' | 'default' | 'comfortable' | 'spacious'
A11yCore.features.transcript();              // Show media transcript

// Load a preset profile
A11yCore.profiles.load('low-vision');    // Enables high contrast, 150% text, monochrome
A11yCore.profiles.load('cognitive');     // Enables 120% text, reading guide, reduced motion
A11yCore.profiles.load('motor');         // Enables keyboard navigation
A11yCore.profiles.load('seizure-safe');  // Enables reduced motion, monochrome

// Save current settings as a custom profile
A11yCore.profiles.save('my-profile');

// List all saved custom profiles
const profiles = A11yCore.profiles.list(); // Returns: ['my-profile', ...]

// Delete a custom profile
A11yCore.profiles.delete('my-profile');

// Subscribe to feature events
const handler = (featureName: string) => {
  console.info('[A11yCore] Feature changed:', featureName);
};

A11yCore.on('featureEnabled', handler);
A11yCore.on('featureDisabled', handler);

// Listen for state changes on window
window.addEventListener('a11ycore:statechange', (event) => {
  const { key, value } = (event as CustomEvent<{ key: string; value: unknown }>).detail;
  console.info('A11yCore state update:', key, value);
});

// Unsubscribe when cleaning up (SPA route changes)
A11yCore.off('featureEnabled', handler);
A11yCore.off('featureDisabled', handler);

// Get current state snapshot
const state = A11yCore.getSettings();
console.log(state.features);  // { highContrast: true, ... }
console.log(state.settings);  // { language: 'en', ... }

// Get compliance score (0-100)
const score = A11yCore.getComplianceScore();
console.log('Compliance score:', score); // e.g., 85

// Grant analytics consent
const success = A11yCore.analytics.consent(true);

// Revoke analytics consent
A11yCore.analytics.consent(false);

if (!success) {
  console.warn('[A11yCore] Analytics consent failed to persist');
}