diff --git a/.changeset/cuddly-worms-love.md b/.changeset/cuddly-worms-love.md new file mode 100644 index 0000000000..8b65a396c7 --- /dev/null +++ b/.changeset/cuddly-worms-love.md @@ -0,0 +1,5 @@ +--- +"@sumup-oss/eslint-plugin-circuit-ui": minor +--- + +Updated the `component-lifecycle-imports` ESLint rule to flag imports of stable components Tooltip and Toggletip from `@sumup-oss/circuit-ui/experimental`. diff --git a/.changeset/wet-avocados-speak.md b/.changeset/wet-avocados-speak.md new file mode 100644 index 0000000000..e776168913 --- /dev/null +++ b/.changeset/wet-avocados-speak.md @@ -0,0 +1,16 @@ +--- +"@sumup-oss/circuit-ui": major +--- + +Marked the `Tooltip` and `Toggletip` components as stable. Update the related imports: + +```diff +- import { Tooltip, type TooltipProps, type TooltipReferenceProps } from '@sumup-oss/circuit-ui/experimental'; ++ import { Tooltip, type TooltipProps, type TooltipReferenceProps } from '@sumup-oss/circuit-ui'; +``` + +```diff +- import { Toggletip, type ToggletipProps } from '@sumup-oss/circuit-ui/experimental'; ++ import { Toggletip, type ToggletipProps } from '@sumup-oss/circuit-ui'; +``` + diff --git a/packages/circuit-ui/components/Toggletip/Toggletip.mdx b/packages/circuit-ui/components/Toggletip/Toggletip.mdx index c57bea565c..0c715352a0 100644 --- a/packages/circuit-ui/components/Toggletip/Toggletip.mdx +++ b/packages/circuit-ui/components/Toggletip/Toggletip.mdx @@ -5,7 +5,7 @@ import * as Stories from './Toggletip.stories'; # Toggletip - + Toggletips display additional information that is contextual, helpful, and nonessential to the user upon pressing a UI trigger element and can contain interactive elements. diff --git a/packages/circuit-ui/components/Tooltip/Tooltip.mdx b/packages/circuit-ui/components/Tooltip/Tooltip.mdx index faa2cc3ea5..4233b4b00f 100644 --- a/packages/circuit-ui/components/Tooltip/Tooltip.mdx +++ b/packages/circuit-ui/components/Tooltip/Tooltip.mdx @@ -5,7 +5,7 @@ import * as Stories from './Tooltip.stories'; # Tooltip - + Tooltips display additional information upon hover or focus that is contextual, helpful, and nonessential to clarify the purpose of otherwise ambiguous interactive elements. diff --git a/packages/circuit-ui/experimental.ts b/packages/circuit-ui/experimental.ts index e32e3b5857..d88415a6bb 100644 --- a/packages/circuit-ui/experimental.ts +++ b/packages/circuit-ui/experimental.ts @@ -13,12 +13,3 @@ * limitations under the License. */ -export { - Tooltip, - type TooltipProps, - type TooltipReferenceProps, -} from './components/Tooltip/index.js'; -export { - Toggletip, - type ToggletipProps, -} from './components/Toggletip/index.js'; diff --git a/packages/circuit-ui/index.ts b/packages/circuit-ui/index.ts index d907f47453..0d20bf4564 100644 --- a/packages/circuit-ui/index.ts +++ b/packages/circuit-ui/index.ts @@ -201,6 +201,15 @@ export { useComponents, } from './components/ComponentsContext/index.js'; export type { ComponentsContextType } from './components/ComponentsContext/index.js'; +export { + Tooltip, + type TooltipProps, + type TooltipReferenceProps, +} from './components/Tooltip/index.js'; +export { + Toggletip, + type ToggletipProps, +} from './components/Toggletip/index.js'; // Hooks export { useClickOutside } from './hooks/useClickOutside/index.js'; diff --git a/packages/eslint-plugin-circuit-ui/component-lifecycle-imports/index.ts b/packages/eslint-plugin-circuit-ui/component-lifecycle-imports/index.ts index f31c6771eb..1a6c2a58af 100644 --- a/packages/eslint-plugin-circuit-ui/component-lifecycle-imports/index.ts +++ b/packages/eslint-plugin-circuit-ui/component-lifecycle-imports/index.ts @@ -82,6 +82,11 @@ const mappings = [ 'ColorInputProps', 'PhoneNumberInputProps', 'PhoneNumberInput', + 'Tooltip', + 'TooltipProps', + 'TooltipReferenceProps', + 'Toggletip', + 'ToggletipProps', ], }, ];