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.

Sign up for GitHub

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

Jump to bottom

[Tooltip] Update Usage tab #4448

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

[Tooltip] Update Usage tab #4448

wants to merge 3 commits into from
+72 −177

Conversation

thyhmdo
Copy link
Member

@thyhmdo thyhmdo commented Jan 28, 2025 •
edited
Loading

Closes #4441

  • Tooltip Usage tab only
  • Clarified the usage of the tooltip
  • Only focused on clarifying tooltips that should be already integrated with other components.

Changed

  • Updated this to be the one variant template

Removed

  • Icon button
  • Standard tooltip

@thyhmdo thyhmdo requested a review from aagonzales January 28, 2025 22:29
@thyhmdo thyhmdo requested review from a team as code owners January 28, 2025 22:29
@vercel Vercel
Copy link

vercel bot commented Jan 28, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 3, 2025 8:52pm

aagonzales
aagonzales reviewed Feb 5, 2025
View reviewed changes
Copy link
Member

@aagonzales aagonzales left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I noticed the definition tooltip was missing from the live demo. It maybe helpful to get that added in so people can see what the remaining variants are.

I also noticed tooltips still have two variants but there is no longer a variant section.

src/pages/components/tooltip/usage.mdx
@@ -16,16 +16,22 @@ clarity to a user.

</PageDescription>

<InlineNotification>

**New update** We have removed standard tooltip and icon button tooltip as
Copy link
Member

Choose a reason for hiding this comment

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

I would change some of this language, words like "removed" sound scary. Maybe something more like:

"Documentation update: The standard tooltip and icon button tooltip have been combined under the default variant in this documentation to align with the coded component. There are no breaking changes to the code ... "

src/pages/components/tooltip/usage.mdx

**New update** We have removed standard tooltip and icon button tooltip as
variants from this guidance. There’s no need to include a separate tooltip
within the component. There are no breaking changes, but we are working on
Copy link
Member

Choose a reason for hiding this comment

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

I also don't fully understand what you mean about it being within other components.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aagonzales aagonzales aagonzales left review comments

@alisonjoseph alisonjoseph alisonjoseph approved these changes

@guidari guidari Awaiting requested review from guidari guidari is a code owner automatically assigned from carbon-design-system/developers-system-reviewers

Assignees
No one assigned
Labels
status: one more review 👀 status: ready for review 👀
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Tooltip] Doc update on Usage tab
5 participants
@thyhmdo @alisonjoseph @aagonzales @laurenmrice @Kritvi-bhatia17