Skip to content

Commit 12a201a

Browse files
authored
mark the Tooltip and Toggletip components as stable (#2743)
1 parent a1448ad commit 12a201a

File tree

12 files changed

+45
-21
lines changed

12 files changed

+45
-21
lines changed

.changeset/cuddly-worms-love.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@sumup-oss/eslint-plugin-circuit-ui": minor
3+
---
4+
5+
Updated the `component-lifecycle-imports` ESLint rule to flag imports of stable components Tooltip and Toggletip from `@sumup-oss/circuit-ui/experimental`.

.changeset/wet-avocados-speak.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
"@sumup-oss/circuit-ui": major
3+
---
4+
5+
Marked the `Tooltip` and `Toggletip` components as stable. Update the related imports:
6+
7+
```diff
8+
- import { Tooltip, type TooltipProps, type TooltipReferenceProps } from '@sumup-oss/circuit-ui/experimental';
9+
+ import { Tooltip, type TooltipProps, type TooltipReferenceProps } from '@sumup-oss/circuit-ui';
10+
```
11+
12+
```diff
13+
- import { Toggletip, type ToggletipProps } from '@sumup-oss/circuit-ui/experimental';
14+
+ import { Toggletip, type ToggletipProps } from '@sumup-oss/circuit-ui';
15+
```
16+

.storybook/components/Icons.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import {
3232
SelectorGroup,
3333
clsx,
3434
utilClasses,
35+
Tooltip,
3536
} from '../../packages/circuit-ui/index.js';
36-
import { Tooltip } from '../../packages/circuit-ui/experimental.js';
3737
import { slugify } from '../slugify.js';
3838
import classes from './Icons.module.css';
3939

.storybook/components/Theme.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ import {
2626
useNotificationToast,
2727
type TableHeaderCell,
2828
type TableRow,
29+
Tooltip,
2930
} from '../../packages/circuit-ui/index.js';
30-
import { Tooltip } from '../../packages/circuit-ui/experimental.js';
3131

3232
type CustomPropertyName = `--cui-${string}`;
3333
type CustomPropertyValue = string;

packages/circuit-ui/components/Calendar/Calendar.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Use the `onMonthChange` prop to lazy-load modifiers for the currently visible mo
4242

4343
```tsx
4444
import { useState } from 'react';
45-
import { Calendar, type CalendarProps } from '@sumup-oss/circuit-ui/experimental';
45+
import { Calendar, type CalendarProps } from '@sumup-oss/circuit-ui';
4646
import { Temporal } from 'temporal-polyfill';
4747

4848
function App() {

packages/circuit-ui/components/Toggletip/Toggletip.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import * as Stories from './Toggletip.stories';
55

66
# Toggletip
77

8-
<Status variant="experimental" />
8+
<Status variant="stable" />
99

1010
Toggletips display additional information that is contextual, helpful, and nonessential to the user upon pressing a UI trigger element and can contain interactive elements.
1111

packages/circuit-ui/components/Tooltip/Tooltip.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import * as Stories from './Tooltip.stories';
55

66
# Tooltip
77

8-
<Status variant="experimental" />
8+
<Status variant="stable" />
99

1010
Tooltips display additional information upon hover or focus that is contextual, helpful, and nonessential to clarify the purpose of otherwise ambiguous interactive elements.
1111

packages/circuit-ui/components/legacy/Tooltip/Tooltip.mdx

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import * as Stories from './Tooltip.stories';
66
# Tooltip
77

88
<Status variant="deprecated">
9-
Use the experimental [Tooltip](Components/Tooltip/Docs) or [Toggletip](Components/Toggletip/Docs) components instead.
9+
Use the [Tooltip](Components/Tooltip/Docs) or [Toggletip](Components/Toggletip/Docs) components instead.
1010
</Status>
1111

1212
<Story of={Stories.Base} />
@@ -30,7 +30,7 @@ The Tooltip component depends on the legacy JSON theme. Wrap the the component o
3030
```tsx
3131
import { ThemeProvider } from '@emotion/react';
3232
import { light } from '@sumup-oss/design-tokens';
33-
import { Tooltip } from '@sumup-oss/circuit-ui';
33+
import { Tooltip } from '@sumup-oss/circuit-ui/legacy';
3434

3535
export default function App() {
3636
return (
@@ -87,8 +87,7 @@ function Component() {
8787

8888
```tsx
8989
// After
90-
import { Badge } from "@sumup-oss/circuit-ui";
91-
import { Tooltip } from "@sumup-oss/circuit-ui/experimental";
90+
import { Badge, Tooltip } from "@sumup-oss/circuit-ui";
9291

9392
function Component() {
9493
return (
@@ -141,8 +140,7 @@ function Component() {
141140

142141
```tsx
143142
// After
144-
import { Toggletip } from "@sumup-oss/circuit-ui/experimental";
145-
import { IconButton } from "@sumup-oss/circuit-ui";
143+
import { IconButton, Toggletip } from "@sumup-oss/circuit-ui";
146144
import { Info } from "@sumup-oss/icons";
147145

148146
function Component() {

packages/circuit-ui/components/legacy/Tooltip/Tooltip.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ export interface TooltipProps {
119119
/**
120120
* @deprecated
121121
*
122-
* Use the experimental [`Tooltip`](https://circuit.sumup.com/?path=/docs/components-tooltip--docs)
122+
* Use the [`Tooltip`](https://circuit.sumup.com/?path=/docs/components-tooltip--docs)
123123
* or [`Toggletip`](https://circuit.sumup.com/?path=/docs/components-toggletip--docs) components instead
124124
* ([migration guide](https://circuit.sumup.com/?path=/docs/components-tooltip-legacy--docs#migration)).
125125
*/

packages/circuit-ui/experimental.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,3 @@
1313
* limitations under the License.
1414
*/
1515

16-
export {
17-
Tooltip,
18-
type TooltipProps,
19-
type TooltipReferenceProps,
20-
} from './components/Tooltip/index.js';
21-
export {
22-
Toggletip,
23-
type ToggletipProps,
24-
} from './components/Toggletip/index.js';

0 commit comments

Comments
 (0)