accessibility 1.0.0

An all-in-one solution to enhance your project with accessibility features.

example/lib/main.dart

import 'package:accessibility/accessibility.dart';
import 'package:example/constants/theme/color_schemes.dart';
import 'package:example/view/pages/home_page.dart';
import 'package:flutter/material.dart';
import 'package:flutter/semantics.dart' show SemanticsBinding;
import 'package:go_router/go_router.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  final sharedPreferencesWithCache = await createSharedPreferencesWithCache();
  final sharedPreferencesService = SharedPreferencesServiceWithCache(
    sharedPreferencesWithCache,
  );
  // or else if you use legacy SharedPreferences
  // const sharedPreferencesService = SharedPreferencesServiceLegacy();
  final accessibilitySettings =
      await sharedPreferencesService.getLocalStorageAccessibilitySettings();
  final appThemes = AppThemes.fromColorSchemes(
    lightColorScheme: kLightColorScheme, // your light color scheme
    darkColorScheme: kDarkColorScheme, // your dark color scheme
    highContrastLightColorScheme:
        kHighConstrastLightColorScheme, // your high contrast light color scheme
    highContrastDarkColorScheme:
        kHighConstrastDarkColorScheme, // your high contrast dark color scheme
    textTheme: kTextThemeMergableEnglishLike2021, // your text theme
  ); // or use AppThemes() default constructor for finer control
  runApp(
    AccessibilityInitializer(
      sharedPreferencesService: sharedPreferencesService,
      accessibilitySettingsCollection: accessibilitySettings,
      child: MyApp(appThemes: appThemes),
    ),
  );
  SemanticsBinding.instance.ensureSemantics();
}

/// {@template MyApp}
/// A widget that is the root of your application.
/// {@endtemplate}
class MyApp extends StatelessWidget {
  /// The configuration of the app themes.
  final AppThemes appThemes;

  /// {@macro MyApp}
  const MyApp({required this.appThemes, super.key});

  static final _router = GoRouter(
    initialLocation: '/',
    routes: [
      GoRoute(
        path: '/',
        builder:
            (context, state) => const HomePage(title: 'Accessibility Page'),
      ),
    ],
  );

  @override
  Widget build(BuildContext context) => AccessibleMaterialApp.router(
    title: 'Accessibility Example',
    routerConfig: _router,
    theme: appThemes.lightTheme,
    highContrastTheme: appThemes.lightHighContrastTheme,
    darkTheme: appThemes.darkTheme,
    highContrastDarkTheme: appThemes.darkHighContrastTheme,
    debugShowCheckedModeBanner: false,
  );
}