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 - align design documentation with code #1087

Open
1 of 4 tasks
thrbnhrtmnn opened this issue Apr 19, 2024 · 0 comments
Open
1 of 4 tasks

Tooltip - align design documentation with code #1087

thrbnhrtmnn opened this issue Apr 19, 2024 · 0 comments
Labels
⭕ core team issue This is for the core team and should not be done by contributors 🎨 design issue Task is for designers 🎓 junior issue Good for juniors

Comments

@thrbnhrtmnn
Copy link
Contributor

Description / User story

After #860 we found a few alignment issues in the current design documentation which should be fixed with this task.

In code "placement" refers to the preferred placement of the tooltip in reference to the element which a user has to hover for the tooltip to appear (the tooltip will be placed here only when the viewport allows it, if not the placement will automatically be adjusted so the tooltip is in view), whereas in design the "placement" refers to the arrow. To align this, we should update the design so the prop is aligned with code. This would also lead to the "none" option being removed from design and made its own boolean property named "hasArrow".

When looking at the design documentation, we could also improve the intro text by making more clear what the "element" which triggers the tooltip could be.

Requirements / Prerequisites

  • none

Acceptance Criteria

  • placement prop has been updated in design
  • hasArrow has been added as a prop in design
  • the intro text has been optimized

Additional information

  • ...

Code of Conduct

  • I agree to follow this project's Code of Conduct
@thrbnhrtmnn thrbnhrtmnn added 🎨 design issue Task is for designers ⭕ core team issue This is for the core team and should not be done by contributors labels Apr 19, 2024
@thrbnhrtmnn thrbnhrtmnn added this to the Prop Alignment milestone Apr 19, 2024
@thrbnhrtmnn thrbnhrtmnn added the 🎓 junior issue Good for juniors label Apr 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⭕ core team issue This is for the core team and should not be done by contributors 🎨 design issue Task is for designers 🎓 junior issue Good for juniors
Projects
None yet
Development

No branches or pull requests

1 participant