docs: 스토리북 문서 자잘한 수정

GDSC-Hongik · Jun 10, 2024 · b5a51ba · b5a51ba
1 parent 5528a79
commit b5a51ba
Show file tree

Hide file tree

Showing 4 changed files with 46 additions and 60 deletions.
diff --git a/packages/wow-ui/src/components/Checkbox/Checkbox.stories.tsx b/packages/wow-ui/src/components/Checkbox/Checkbox.stories.tsx
@@ -48,9 +48,7 @@ const meta = {
         type: { summary: "ReactNode" },
         defaultValue: { summary: null },
       },
-      control: {
-        type: "text",
-      },
+      control: false,
     },
     onChange: {
       description: "외부 활성 상태가 변경될 때 호출될 콜백 함수를 나타냅니다.",
@@ -122,19 +120,15 @@ const meta = {
         type: { summary: "InputHTMLAttributes<HTMLInputElement>" },
         defaultValue: { summary: "{}" },
       },
-      control: {
-        type: "object",
-      },
+      control: false,
     },
     style: {
       description: "체크박스의 커스텀 스타일을 설정합니다.",
       table: {
         type: { summary: "CSSProperties" },
         defaultValue: { summary: "{}" },
       },
-      control: {
-        type: "object",
-      },
+      control: false,
     },
   },
 } satisfies Meta<typeof Checkbox>;

diff --git a/packages/wow-ui/src/components/Chip/Chip.stories.ts b/packages/wow-ui/src/components/Chip/Chip.stories.ts
@@ -14,7 +14,6 @@ const meta = {
       },
     },
   },
-
   argTypes: {
     disabled: {
       description: "disabled는 칩 버튼이 비활성화 상태인지 여부를 나타냅니다.",
@@ -37,7 +36,6 @@ const meta = {
         type: "boolean",
       },
     },
-
     isChecked: {
       description: "isChecked는 외부에서 제어할 활성 상태를 나타냅니다.",
       table: {
@@ -61,11 +59,7 @@ const meta = {
     label: {
       description: "칩에 들어가게 될 텍스트입니다.",
       table: {
-        type: { summary: "string" },
-      },
-      type: {
-        name: "string",
-        required: true,
+        type: { summary: "string", required: true },
       },
       control: {
         type: "text",
@@ -75,29 +69,37 @@ const meta = {
       description: "칩 클릭 시 동작할 이벤트입니다.",
       table: {
         type: { summary: "() => void" },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onDelete: {
       description: "칩에 대한 필터를 제거하기 위한 함수입니다.",
       table: {
         type: { summary: "() => void" },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onKeyDown: {
       description:
         "칩이 포커스됐을 때 엔터 키 또는 스페이스 바를 눌렀을 때 동작할 이벤트입니다.",
       table: {
         type: { summary: "() => void" },
-        control: {
-          type: "function",
-        },
       },
+      control: {
+        type: "function",
+      },
+    },
+    style: {
+      description: "칩의 커스텀 스타일을 설정합니다.",
+      table: {
+        type: { summary: "CSSProperties" },
+        defaultValue: { summary: "{}" },
+      },
+      control: false,
     },
   },
 } satisfies Meta<typeof Chip>;

diff --git a/packages/wow-ui/src/components/Switch/Switch.stories.tsx b/packages/wow-ui/src/components/Switch/Switch.stories.tsx
@@ -58,19 +58,19 @@ const meta = {
       table: {
         type: { summary: "() => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onClick: {
       description: "스위치 클릭 시 동작할 이벤트입니다.",
       table: {
         type: { summary: "() => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onKeyDown: {
@@ -79,9 +79,9 @@ const meta = {
       table: {
         type: { summary: "() => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
   },

diff --git a/packages/wow-ui/src/components/TextField/TextField.stories.tsx b/packages/wow-ui/src/components/TextField/TextField.stories.tsx
@@ -19,16 +19,12 @@ const meta = {
     label: {
       description: "텍스트필드의 라벨입니다.",
       table: {
-        type: { summary: "string" },
+        type: { summary: "string", required: true },
         defaultValue: { summary: null },
       },
       control: {
         type: "text",
       },
-      type: {
-        name: "string",
-        required: true,
-      },
     },
     placeholder: {
       description: "텍스트필드의 플레이스홀더 텍스트입니다.",
@@ -96,68 +92,62 @@ const meta = {
         type: { summary: "ReactNode" },
         defaultValue: { summary: null },
       },
-      control: {
-        type: "text",
-      },
+      control: false,
     },
     onChange: {
       description: "외부 활성 상태가 변경될 때 호출될 콜백 함수입니다.",
       table: {
         type: { summary: "(value: string) => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onBlur: {
       description: "텍스트필드가 포커스를 잃을 때 호출될 콜백 함수입니다.",
       table: {
         type: { summary: "() => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     onFocus: {
       description: "텍스트필드가 포커스됐을 때 호출될 콜백 함수입니다.",
       table: {
         type: { summary: "() => void" },
         defaultValue: { summary: null },
-        control: {
-          type: "function",
-        },
+      },
+      control: {
+        type: "function",
       },
     },
     textareaProps: {
       description: "텍스트필드에 전달할 추가 textarea 속성입니다.",
       table: {
         type: { summary: "TextareaHTMLAttributes<HTMLTextAreaElement>" },
         defaultValue: { summary: null },
-        control: {
-          type: "object",
-        },
       },
+      control: false,
     },
     style: {
       description: "텍스트필드의 커스텀 스타일 속성입니다.",
       table: {
         type: { summary: "CSSProperties" },
         defaultValue: { summary: null },
-        control: {
-          type: "object",
-        },
       },
+      control: false,
     },
     className: {
       description: "텍스트필드에 전달하는 커스텀 클래스명입니다.",
       table: {
         type: { summary: "string" },
         defaultValue: { summary: null },
-        control: {
-          type: "text",
-        },
+      },
+      control: {
+        type: "text",
       },
     },
   },