feat: props 설명 추가

COW-dev · Jan 23, 2025 · f19699a · f19699a
1 parent be03e15
commit f19699a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/src/shared/ui/Tabs/TabsItem.tsx b/src/shared/ui/Tabs/TabsItem.tsx
@@ -2,10 +2,16 @@ import { useContext } from 'react';
 
 import { TabsContext } from './Tabs.context';
 
-type Props = React.HTMLAttributes<HTMLDivElement> & {
+type Props = {
+  /**
+   * tab name to be displayed.
+   */
   label: string;
+  /**
+   * if activated, exposed element.
+   */
   children: React.ReactNode;
-};
+} & React.HTMLAttributes<HTMLDivElement>;
 
 export function TabsItem({ label, children, ...props }: Props) {
   const content = useContext(TabsContext);

diff --git a/src/shared/ui/Tabs/TabsRoot.tsx b/src/shared/ui/Tabs/TabsRoot.tsx
@@ -5,7 +5,13 @@ import { motion } from 'framer-motion';
 import { TabsContext } from './Tabs.context';
 
 type Props = {
+  /**
+   * children elements of the Tabs
+   */
   children: React.ReactNode;
+  /**
+   * default focusing tabsItem index.
+   */
   defaultIndex?: number;
 } & React.HTMLAttributes<HTMLDivElement>;