Skip to content

feat(tooltip): documentation, consumer migration guide#6345

Open
5t3ph wants to merge 7 commits into
seckles/tooltip-code-styles-testsfrom
seckles/tooltip-documentation
Open

feat(tooltip): documentation, consumer migration guide#6345
5t3ph wants to merge 7 commits into
seckles/tooltip-code-styles-testsfrom
seckles/tooltip-documentation

Conversation

@5t3ph
Copy link
Copy Markdown
Contributor

@5t3ph 5t3ph commented May 27, 2026

Description

Completes Phase 7 (documentation), and adds the consumer migration guide for swc-tooltip.

Phase 7 — Documentation

  • Storybook stories: Playground, Overview, Anatomy, Options (variants, placements), States (open), Behaviors (events, auto-stack), Accessibility, and UpcomingFeatures (additive-phase items)
  • JSDoc on all public properties, slots, and --swc-tooltip-background-color CSS custom property

Consumer migration guide

  • New migration-guide.mdx at 2nd-gen/packages/swc/components/tooltip/
  • Covers all six breaking changes (B1–B6): icon slot removal, variant="positive" removal, variant="info" rename, event renames with timing change, self-managed removal and new for-based sibling authoring pattern
  • Prominent initial-release scope callout: automatic hover/focus wiring and pixel positioning are not yet available; includes manual event wiring pattern for the current release
  • --mod-tooltip-* breaking change callout and --swc-tooltip-background-color public property table
  • Migration plan checklist updated; all consumer migration guide items marked complete

Motivation and context

Tooltip is the first 2nd-gen component with non-trivial behavioral complexity (native popover, ARIA wiring via ariaDescribedByElements, additive controller architecture). The consumer migration guide specifically calls out what works today vs. what ships in a future release to prevent consumers from expecting hover/focus auto-wiring that isn't yet active.

Related issue(s)

  • SWC-2026
  • SWC-2027

@5t3ph 5t3ph requested a review from a team as a code owner May 27, 2026 17:01
@5t3ph 5t3ph added Component:Tooltip Status:Ready for review PR ready for review or re-review. 2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. labels May 27, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 27, 2026

⚠️ No Changeset found

Latest commit: ba73d86

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 27, 2026

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-6345

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Copy link
Copy Markdown
Member

@cdransf cdransf left a comment

Choose a reason for hiding this comment

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

Looks good! Just had one question ✨

Comment thread 2nd-gen/packages/swc/components/tooltip/stories/tooltip.stories.ts Outdated
@caseyisonit caseyisonit added Status:Ready for merge PR has 2 approvals, all tests pass, and is ready to merge and removed Status:Ready for review PR ready for review or re-review. labels May 28, 2026
Copy link
Copy Markdown
Contributor

@rubencarvalho rubencarvalho left a comment

Choose a reason for hiding this comment

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

Looks good! We just need to make sure to update the "hover" section when we integrate the HoverController! 😄
Also, please check if the global-button.css should be included 👍

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Is this supposed to be commited?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This is nice, but I feel like our whole SB customization needs some love 😛 cc: @caseyisonit

@5t3ph 5t3ph force-pushed the seckles/tooltip-code-styles-tests branch from 3dc9c3f to 891601d Compare June 2, 2026 19:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2nd gen These issues or PRs map to our 2nd generation work to modernizing infrastructure. Component:Tooltip Status:Ready for merge PR has 2 approvals, all tests pass, and is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants