Audit Accessibility
Designaudit-accessibilityAudit Accessibility is an Agent Skill for design published in the flutter/flutter-intellij repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Ensure the plugin's custom UI components are accessible to users with screen readers and other assistive technologies.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/flutter/flutter-intellij/blob/HEAD/.agents/skills/audit-accessibility/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/audit-accessibility, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Skill: Accessibility (A11y) Audit
You are tasked with ensuring the plugin's custom UI components are accessible to users with screen readers and other assistive technologies.
Objective
Ensure the plugin's custom UI components are accessible to users with screen readers and other assistive technologies.
Workflow Instructions
1. Baseline
- Run
./gradlew testClassesto ensure project compilation. - Run
./gradlew testto ensure the project is stable. - Run
./gradlew verifyPluginto ensure no verification issues.
2. Identify Custom UI
- List all custom
JPanel,JComponent, orDialogclasses in the codebase.
3. Check Properties
- Verify that every interactive component has:
getAccessibleContext().setAccessibleName(...)getAccessibleContext().setAccessibleDescription(...)
4. Focus Management
- Ensure custom components handle focus traversal correctly (Tab/Shift+Tab).
5. Color Contrast
- If custom colors are used, verify they meet WCAG contrast guidelines (especially for dark themes).
6. Verify
- Run
./gradlew testClassesand./gradlew testto ensure no regressions. - Run
./gradlew verifyPluginto ensure strict compliance. - Use the "Accessibility Inspector" (if available in the SDK) or a screen reader to navigate the UI.
- Suggest manual test steps: Check the code changes made and write test steps for a user to execute that will trigger the code paths that have changed. If needed, add logging statements to verify that the code paths have successfully run.
7. Report & Review
- Summarize the accessibility improvements in the form of a git commit message.
- Test Location: Explicitly state where in the IDE the user should go to test the changed functionality (e.g., "Go to Preferences > Languages & Frameworks > Flutter").
- Action: Ask the user to review the UI changes closely.
- Do not commit or push.