Update tooltip docs to add note about disabled
#2084
Conversation
|
khiga8
added
the
skip changeset
| # The majority of tooltips will fall under this category. | ||
| # - When there is no visible text on the trigger element and the tooltip content is appropriate as a label for the element, set `type: :label`. | ||
| # `label` type is usually only appropriate for an icon-only control. | ||
| # |
There was a problem hiding this comment.
I noticed that the "Accessibility" section and the "Which type do I set" information is not being rendered on the doc page for tooltip. I'm assuming this is due to the ongoing docs migration work, and we're only allowing top-level text to show up.
I think this information is very important to surface so I opted to remove the headings to ensure it shows up in the doc.
There was a problem hiding this comment.
Hmm that's interesting. I'll look into it. Ideally all markdown under the @accessibility tag should make it to the new docsite.
There was a problem hiding this comment.
Thank you! Happy to add back the headings later!
Co-authored-by: Cameron Dutro <camertron@gmail.com>
|
Please merge whenever since I don't have merge authorization! Thank you! |
What are you trying to accomplish?
Documenting that tooltip should not be used with
disabled.List the issues that this change affects.
Follow up to Slack thread
Closes #2085
Risk Assessment
Anything you want to highlight for special attention from reviewers?
I noticed that the
Accessibilitysection and theWhat type do I setinformation was not being rendered on the doc page for tooltip. I'm assuming this is due to the ongoing docs migration work, and we're only allowing top-level text.I think this information is very important to surface so I opted to remove the headings to ensure it shows up in the doc.
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.