Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Show a11y errors in the form preview #75

Open
pinussilvestrus opened this issue Jun 1, 2023 · 1 comment
Open

Show a11y errors in the form preview #75

pinussilvestrus opened this issue Jun 1, 2023 · 1 comment
Labels
a11y backlog Queued in backlog enhancement New feature or request needs discussion Needs further discussion

Comments

@pinussilvestrus
Copy link
Contributor

pinussilvestrus commented Jun 1, 2023

Is your feature request related to a problem? Please describe.

Users need a way to easily identify and fix accessibility errors in their forms as they become more complex.

The goal is to enable users to build accessible forms, and the use of the dev tools like axe provides a foundation for identifying accessibility errors. However, as forms grow in complexity with more components, it is helpful to have a visual representation of these errors in our own tooling.

By providing meaningful a11y errors on the form and a helpful guide to fix it, it becomes easier building accessible forms, leading to improved accessibility compliance and a better user experience for all users, including those with disabilities.

Describe the solution you'd like

Use axe to display accessibility errors directly to the users. This feature will help users identify missing labels, alternative text, and other accessibility issues in real-time, making it easier for them to address and fix these errors efficiently.

As an example, the axe dev tools show a lot of details around such detected errors, as of ways to resolve these.

image

Describe alternatives you've considered

Do not include this validation as part of the playground, but use https://github.com/camunda/form-linting instead.

We could consider showing such information via a tooltip next to the respective form field.

Additional context

/

@pinussilvestrus pinussilvestrus added enhancement New feature or request a11y backlog Queued in backlog needs discussion Needs further discussion labels Jun 1, 2023
@bpmn-io-tasks bpmn-io-tasks bot added the in progress Currently worked on label Jun 2, 2023
@bpmn-io-tasks bpmn-io-tasks bot removed the backlog Queued in backlog label Jun 2, 2023
@pinussilvestrus pinussilvestrus added backlog Queued in backlog and removed in progress Currently worked on labels Jun 2, 2023
@pinussilvestrus
Copy link
Contributor Author

A spike was made via #76

This only shows how to use axe do generate such errors and provide a link for "more", e.g. how to fix the issue.

I could imagine keeping this out of form-playground completely and implement this as part of https://github.com/camunda/form-linting (e.g. with showing the errors on the canvas as well, as we do with BPMN linting)

Kapture 2023-06-02 at 13 29 40

@pinussilvestrus pinussilvestrus removed their assignment Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a11y backlog Queued in backlog enhancement New feature or request needs discussion Needs further discussion
Projects
None yet
Development

No branches or pull requests

1 participant