accessibility library

The accessibility package.

This package contains a set of settings for the accessibility of an application.

Classes

AccessibilityInitializer
This widget is the root of your application.
AccessibilityLocalizations
Callers can lookup localized strings with an instance of AccessibilityLocalizations returned by AccessibilityLocalizations.of(context).
AccessibilitySettings
A list of accessibility settings items.
AccessibilitySettingsConfiguration
A configuration object for accessibility settings.
AccessibilitySettingsInherited
A provider of all the accessibility settings of the application.
AccessibilitySettingsViewModel
A view model that manages the accessibility settings of the application.
AccessibleMaterialApp
A MaterialApp that watch for accessibility settings changes.
AccessibleSizedBox
Displays a SizedBox with an height that depends on the accessibility settings.
AccessibleText
A Text that adapts its theme based on the accessibility settings.
AccessibleWidgetBuilder
A widget builder that displays a child based on the accessibility settings.
AppThemes
Defines a set of themes for the application.
ColorSettings
Defines the color settings model.
EffectsSettingListenableBuilder
A ValueListenableBuilder that listens to the effects allowed setting changes.
IconSize
Defines all possible size of the icons in the app, following the Material 2021 guidelines. Docs: https://m3.material.io/styles/icons/designing-icons
LocalStorageDefaultValues
Defines all the default values used in the app.
LocalStorageKeys
Defines all the keys used to store data in the app.
PaddingSize
Defines all possible padding sizes in the app, following the Material 2021 guidelines. Docs: https://m3.material.io/foundations/layout/understanding-layout/spacing
ReadMoreText
A widget that shows a text with a read more button.
ReadMoreTextButton
A widget that shows a text with on click to a button.
RestoreSettingsButton
A button that restores the default accessibility settings of the application.
SettingsGroup
This shows a section with an optional grouping title. This section contains a list of settings of the application.
SharedPreferencesInherited
A provider of the shared preferences of the application.
SharedPreferencesService
This service is a implementation of the SharedPreferencesService that uses the legacy SharedPreferences to store and retrieve data.
SharedPreferencesServiceLegacy
This service is a implementation of the SharedPreferencesService that uses the legacy SharedPreferences to store and retrieve data.
SharedPreferencesServiceWithCache
This service is a implementation of the SharedPreferencesService that provides a cache layer to improve performance.
TextRawMagnifier
A magnifier optimized for Text widgets, but can be used with any widget.
TextSettings
Defines the text accessibility settings model.
ThemeSettingsBuilder
This widget is used to provide the theme configuration of the application.

Enums

ColorProfileLevel
Defines all color profile levels.
ThemeProfileLevel
Defines all theme profile levels.

Extension Types

AccessibleThemeData
A theme data that conforms to accessibility settings.

Extensions

AccessibleHeight on double
An extension to make accessible height calculations.
BuildContextControls on BuildContext
Adds a set of utility methods on BuildContext.
ColorTransformation on Color
An extension to manipulate a Color.

Constants

kMaterialAccentColors → const List<ColorSwatch<int>>
The list of the common Material accent colors to select.
kMaterialColors → const List<ColorSwatch<int>>
The list of the common Material colors to select.
kMaterialFullColors → const List<ColorSwatch<int>>
The list of all Material colors to select.
kTextThemeMergableEnglishLike2021 → const TextTheme
The configuration of the text theme of the application.

Functions

createSharedPreferencesWithCache({SharedPreferencesWithCacheOptions? cacheOptions}) Future<SharedPreferencesWithCache>
Creates a SharedPreferencesWithCache instance.

Typedefs

AccessibilitySettingsCollection = ({ColorSettings colorSettings, bool effectsAllowed, TextSettings textSettings, ThemeMode themeMode})
A list of accessibility settings items.