Skip to content

Commit

Permalink
fix: tooltip docs typo and bug (#3759)
Browse files Browse the repository at this point in the history
* fix: tooltip docs typo and bug

* chore: yarn format

---------

Co-authored-by: Alison Joseph <[email protected]>
  • Loading branch information
laurenmrice and alisonjoseph authored Sep 28, 2023
1 parent 26a23b8 commit 930e1cb
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions src/pages/components/tooltip/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,7 @@ interactive elements, such as a button, that a user needs to interact with.
},
]}
/>

## Formatting

### Standard tooltip anatomy
Expand Down Expand Up @@ -336,10 +337,8 @@ or link.
### Best practices

- The content within a standard tooltip should be purely additional information
that is not critical for a user to read to complete a task.
- Standard tooltips appear on hover and are not focusable or read by screen
readers. If the content is essential for the user to interpret concerning
their workflow, use a
that is not critical for a user to read to complete a task. If the content is
essential for the user to interpret concerning their workflow, use a
[toggletip](https://carbondesignsystem.com/components/toggletip/usage/) for
this information instead.

Expand Down

1 comment on commit 930e1cb

@vercel
Copy link

@vercel vercel bot commented on 930e1cb Sep 28, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.