Update Toggle documentation, fix ToggleGroup stories

aragon · Jan 11, 2024 · c8e8500 · c8e8500
1 parent b8315f5
commit c8e8500
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/components/toggles/toggle/toggle.tsx b/src/components/toggles/toggle/toggle.tsx
@@ -13,6 +13,11 @@ export interface IToggleProps extends Omit<ComponentProps<'button'>, 'ref'> {
     label: string;
 }
 
+/**
+ * The Toggle component is a button that handles the "on" and "off" states.
+ *
+ * **NOTE**: The component must be used inside a `<ToggleGroup />` component in order to work properly.
+ */
 export const Toggle: React.FC<IToggleProps> = (props) => {
     const { className, label, value, disabled, ...otherProps } = props;
 

diff --git a/src/components/toggles/toggleGroup/toggleGroup.stories.tsx b/src/components/toggles/toggleGroup/toggleGroup.stories.tsx
@@ -3,9 +3,9 @@ import { useState } from 'react';
 import { Toggle } from '../toggle';
 import { ToggleGroup, type IToggleGroupProps } from './toggleGroup';
 
-const meta: Meta<typeof Toggle> = {
+const meta: Meta<typeof ToggleGroup> = {
     title: 'components/Toggles/ToggleGroup',
-    component: Toggle,
+    component: ToggleGroup,
     tags: ['autodocs'],
     parameters: {
         design: {