feat: mark switch as deprecated

AxaFrance · Feb 6, 2024 · 2796de7 · 2796de7
1 parent d0ce262
commit 2796de7
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/packages/Form/Input/switch/src/Switch.stories.tsx b/packages/Form/Input/switch/src/Switch.stories.tsx
@@ -7,7 +7,7 @@ import readme from '../README.md';
 import SwitchItem from './SwitchItem';
 
 export default {
-  title: 'Form elements/Radio switch',
+  title: 'Form elements/Radio switch (Deprecated)',
   component: Switch,
   parameters: {
     readme: {
@@ -40,7 +40,15 @@ const options: Omit<ComponentProps<typeof SwitchItem>, 'onChange'>[] = [
 
 type SwitchProps = ComponentProps<typeof Switch>;
 
-export const SwitchStory: Story<SwitchProps> = (args) => <Switch {...args} />;
+export const SwitchStory: Story<SwitchProps> = (args) => (
+  <>
+    <p>
+      Deprecated: This component is no longer maintained and shouldn't be used.
+      It will be removed in the next version.
+    </p>
+    <Switch {...args} />
+  </>
+);
 SwitchStory.storyName = 'Switch';
 SwitchStory.args = {
   name: 'Form.SwitchInput',

diff --git a/packages/Form/Input/switch/src/Switch.tsx b/packages/Form/Input/switch/src/Switch.tsx
@@ -16,6 +16,9 @@ type Props = Omit<SwitchItemProps, keyof Pick<Option, 'id' | 'label'>> & {
   options: SwitchOptions[];
 };
 
+/**
+ * @deprecated This component is no longer maintained and shouldn't be used. It will be removed in the next version.
+ */
 const Switch = ({ value, options, onChange, ...otherProps }: Props) => {
   const [selectedValue, setSelectedValue] = useState(value);
   const [sliderStyle, setSliderStyle] = useState<CSSProperties>({

diff --git a/packages/Form/Input/switch/src/SwitchInput.tsx b/packages/Form/Input/switch/src/SwitchInput.tsx
@@ -15,6 +15,9 @@ type Props = ComponentPropsWithoutRef<typeof Field> &
     disabled?: Boolean;
   };
 
+/**
+ * @deprecated This component is no longer maintained and shouldn't be used. It will be removed in the next version.
+ */
 const SwitchInput = ({
   classModifier,
   message,