diff --git a/ui/components/ui/check-box/README.mdx b/ui/components/ui/check-box/README.mdx index 0318006f5..3a73e7cd5 100644 --- a/ui/components/ui/check-box/README.mdx +++ b/ui/components/ui/check-box/README.mdx @@ -2,12 +2,12 @@ import { Story, Canvas, ArgsTable } from '@storybook/addon-docs'; import CheckBox from '.'; -# Checkbox +# Check Box(Deprecated) A small interactive box that can be toggled by the user to indicate an affirmative or negative choice. - + ## Props diff --git a/ui/components/ui/check-box/check-box.component.js b/ui/components/ui/check-box/check-box.component.js index 734c60238..5c4b1b300 100644 --- a/ui/components/ui/check-box/check-box.component.js +++ b/ui/components/ui/check-box/check-box.component.js @@ -10,6 +10,15 @@ const CHECKBOX_STATE = { export const { CHECKED, INDETERMINATE, UNCHECKED } = CHECKBOX_STATE; +/** + * @deprecated The `` component has been deprecated in favor of the new `` component from the component-library. + * Please update your code to use the new `` component instead, which can be found at ui/components/component-library/checkbox/checkbox.tsx. + * You can find documentation for the new Checkbox component in the MetaMask Storybook: + * {@link https://metamask.github.io/metamask-storybook/?path=/docs/components-componentlibrary-checkbox--docs} + * If you would like to help with the replacement of the old CheckBox component, please submit a pull request against this GitHub issue: + * {@link https://github.com/MetaMask/metamask-extension/issues/20163} + */ + const CheckBox = ({ className, disabled, diff --git a/ui/components/ui/check-box/check-box.stories.js b/ui/components/ui/check-box/check-box.stories.js index 907d27de5..2791db157 100644 --- a/ui/components/ui/check-box/check-box.stories.js +++ b/ui/components/ui/check-box/check-box.stories.js @@ -15,7 +15,7 @@ const checkboxOptions = { }; export default { - title: 'Components/UI/Check Box', + title: 'Components/UI/Check Box(Deprecated)', component: CheckBox, parameters: {