Flutter Accessibility Helper #

A comprehensive Flutter package providing screen reader optimization, focus management, and accessibility testing tools to help developers create more accessible Flutter applications.

Features #

• Screen Reader Optimization: Tools to optimize content for screen readers
• Focus Management: Comprehensive focus management utilities for keyboard navigation
• Accessibility Testing: Built-in testing tools for accessibility compliance
• Widget Extensions: Pre-built accessible widgets and extensions
• Semantic Support: ARIA-like semantics for Flutter widgets
• Testing Utilities: Comprehensive testing framework for accessibility features
• Native Platform Support: Android native API integration for accurate accessibility detection
• Comprehensive Feature Detection: Detect bold text, high contrast, invert colors, reduce motion, and more

Getting Started #

Installation #

Add this to your package's pubspec.yaml file:

dependencies:
  flutter_accessibility_helper: ^0.1.0

Usage #

import 'package:flutter_accessibility_helper/flutter_accessibility_helper.dart';

// Announce to screen reader
AccessibilityHelper.announceToScreenReader('Form submitted successfully');

// Create accessible button
AccessibilityWidgets.accessibleButton(
  label: 'Submit Form',
  onPressed: () => submitForm(),
  hint: 'Double tap to submit the form',
);

// Manage focus
final focusNode = AccessibilityFocusManager.createFocusNode();
AccessibilityFocusManager.requestFocus(context, focusNode);

// Get detailed accessibility information
final details = await AccessibilityHelper.getAccessibilityDetails(context);
if (details['boldText'] == true) {
  // Adjust UI for bold text preference
}

Core Components #

AccessibilityHelper #

The main utility class providing core accessibility functions:

// Announce messages to screen readers
AccessibilityHelper.announceToScreenReader('New content loaded');

// Check accessibility status
if (AccessibilityHelper.isAccessibilityEnabled) {
  // Provide enhanced features
}

// Get detailed accessibility information
final details = await AccessibilityHelper.getAccessibilityDetails(context);
print('Bold text enabled: ${details['boldText']}');
print('High contrast: ${details['highContrast']}');
print('Has screen reader: ${details['hasScreenReader']}');
print('Text scale factor: ${details['textScaleFactor']}');

// Validate accessibility compliance
final issues = AccessibilityHelper.validateAccessibility(context);

AccessibilityFocusManager #

Comprehensive focus management utilities:

// Create and manage focus nodes
final focusNode = AccessibilityFocusManager.createFocusNode();

// Navigate focus
AccessibilityFocusManager.nextFocus(context);
AccessibilityFocusManager.previousFocus(context);

// Check focus status
if (AccessibilityFocusManager.hasFocus(focusNode)) {
  // Handle focused state
}

ScreenReaderOptimizer #

Optimize content for screen readers:

// Optimize text for speech
final optimizedText = ScreenReaderOptimizer.optimizeForScreenReader(
  'Hello, World!'
);

// Create semantic labels
final label = ScreenReaderOptimizer.createSemanticLabel('Press', 'button');

AccessibilityWidgets #

Pre-built accessible widgets:

// Accessible button with proper semantics
AccessibilityWidgets.accessibleButton(
  label: 'Save',
  onPressed: saveData,
  hint: 'Double tap to save your changes',
);

// Accessible text with semantic labels
AccessibilityWidgets.accessibleText(
  'Submit',
  semanticsLabel: 'Submit button for the contact form',
);

Platform Support #

This package provides native platform support for accurate accessibility detection:

• Android: Uses native AccessibilityManager API for precise detection of:
  • Bold text (Android 12+)
  • Invert colors
  • High contrast mode
  • Reduce motion / disable animations
  • Font scale and text size
  • TalkBack and screen reader detection
• iOS: Falls back to Flutter's AccessibilityFeatures API (native support coming soon)
• Other platforms: Uses Flutter's AccessibilityFeatures API

The package automatically uses the most accurate detection method available for each platform.

Testing #

The package includes comprehensive testing utilities:

// Test accessibility compliance
final issues = AccessibilityHelper.validateAccessibility(context);

// Test semantics
final isValid = SemanticsTester.testSemantics('Label', 'Hint');

// Test focus order
final focusValid = AccessibilityTesting.validateFocusOrder(widgets);

// Test contrast ratio (WCAG AA standard)
final hasGoodContrast = AccessibilityTesting.checkContrastRatio(
  Colors.black,
  Colors.white,
);

Accessibility Best Practices #

This package helps implement several accessibility best practices:

1. Semantic Labels: Provide meaningful labels for all interactive elements
2. Focus Management: Ensure logical tab order and proper focus indicators
3. Screen Reader Support: Optimize content for screen reader announcements
4. Testing: Comprehensive testing for accessibility compliance
5. Documentation: Clear documentation and examples for all features

Contributing #

We welcome contributions! Please see our Contributing Guide for details.

License #

This project is licensed under the MIT License - see the LICENSE file for details.

Support #

If you encounter any issues or have questions, please:

1. Check the documentation
2. Search existing issues
3. Create a new issue

Version #

Current version: 0.1.0

See CHANGELOG.md for complete version history and migration guides.

Note: This package achieves a full Pana score of 160/160 and follows Flutter and Dart best practices for accessibility.