Skip to content

MateuxLucax/accessibility-lint

Repository files navigation

Accessibility Lint

License: Apache License 2.0

Dart Flutter Android iOS

A static analysis linter that helps developers create accessible Dart and Flutter applications by enforcing best practices for accessibility.

Features

  • Avoid Icon Button Without Tooltip: Ensures all IconButton widgets have a tooltip property.
  • Add Haptic Feedback on User Interaction: Ensures all interactive widgets have haptic feedback.
  • Avoid Icon Without Semantic Label: Ensures all Icon widgets have a semanticLabel property.
  • Avoid Image Without Semantic Label: Ensures all Image widgets have a semanticLabel property.
  • Avoid Small Interactive Elements: Ensures all interactive elements are large enough to be easily tapped.

Installation

To add the accessibility linter to your project, run:

flutter pub add --dev custom_lint accessibility_lint

Then, add in your analysis_options.yaml file:

analyzer:
  plugins:
    - custom_lint

Usage

To run the accessibility linter, run:

dart run custom_lint

License

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

About

Flutter Custom Lint plugin aimed at providing helpful accessibility lint

Topics

Resources

License

Stars

Watchers

Forks

Languages