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

Tooltip component naming is misleading #763

Open
danielck opened this issue Aug 18, 2023 · 0 comments
Open

Tooltip component naming is misleading #763

danielck opened this issue Aug 18, 2023 · 0 comments

Comments

@danielck
Copy link
Contributor

The Problem

Tooltips are small pieces of information that e.g. explain what a certain button or tool does. They are not themselves focusable and should not contain focusable elements. The contents of the tooltip should be referenced from the tool/control it describes using aria-describedby. This means the text should not be very long. There is also an ARIA role "tooltip", which is specifically for this kind of purpose.

Even though this component does not use the ARIA role, the name itself is misleading, because it is not intended to be used as a "tip" for a "tool", but rather as additional information about some adjacent text of form control. The tip does not concern the info toggle itself but something else. We should avoid using names that match or are similar to existing ARIA roles when the behaviour or structure do not match.

Proposed Solution

Rename to e.g. Toggletip.

Additional Info

Use of term 'toggletip':

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant