Skip to content

Tooltip: Do not export all types publicly in the experimental bundle #5064

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

Merged
broccolinisoup merged 5 commits into from
Oct 7, 2024
Merged

Tooltip: Do not export all types publicly in the experimental bundle #5064

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
19224ed
Do not export all types publicly in the experimental bundle
broccolinisoup Oct 4, 2024
75a826c
export tooltip direction for button
broccolinisoup Oct 4, 2024
079656d
snapshot
broccolinisoup Oct 4, 2024
014e73d
Create eight-avocados-lick.md
broccolinisoup Oct 4, 2024
fa0b38a
Update .changeset/eight-avocados-lick.md
broccolinisoup Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/eight-avocados-lick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": patch

@broccolinisoup broccolinisoup Oct 4, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is technically a breaking change since we remove export but there is no usage internally at dotcom. Should we release potentially major? Or should we just do major and include in the major release?

@joshblack joshblack Oct 4, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@broccolinisoup I think since tooltip is behind experimental/next it doesn't fall under semver so should be fine 👍 I would personally do minor since this is more around changing APIs than it would be fixing a bug but I don't know how important that is for these kind of "unstable" components 🤷

@broccolinisoup broccolinisoup Oct 7, 2024

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

You are totally right!

Comment thread
broccolinisoup marked this conversation as resolved.
Outdated
---

Tooltip: Do not export all types publicly in the experimental bundle
2 changes: 1 addition & 1 deletion packages/react/src/TooltipV2/Tooltip.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export type TooltipProps = React.PropsWithChildren<
ComponentProps<typeof StyledTooltip>
>

export type TriggerPropsType = {
type TriggerPropsType = {
'aria-describedby'?: string
'aria-labelledby'?: string
'aria-label'?: string
Expand Down
3 changes: 0 additions & 3 deletions packages/react/src/__tests__/__snapshots__/exports.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,10 +316,7 @@ exports[`@primer/react/experimental should not update exports without a semver c
"type TableTitleProps",
"type TitleProps",
"Tooltip",
"TooltipContext",
"type TooltipDirection",
"type TooltipProps",
"type TriggerPropsType",
"UnderlinePanels",
"type UnderlinePanelsPanelProps",
"type UnderlinePanelsProps",
Expand Down
3 changes: 2 additions & 1 deletion packages/react/src/experimental/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ export type {
NavListDividerProps,
} from '../NavList'
export * from './SelectPanel2'
export * from '../TooltipV2'
export {Tooltip} from '../TooltipV2'
export type {TooltipProps} from '../TooltipV2'
export * from '../ActionBar'

export {ScrollableRegion} from '../ScrollableRegion'
Expand Down