Skip to content

Commit 338e53d

Browse files
committed
📝 doc: add Storybook and README links to each component
1 parent 2a7412a commit 338e53d

1 file changed

Lines changed: 50 additions & 18 deletions

File tree

README.md

Lines changed: 50 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- 🌈 `as` 속성을 통해 컴포넌트 다형성을 지원하도록 구현했습니다.
1313
- ⚠️ 웹 접근성을 고려해 적절한 `html role`을 사용하여 컴포넌트를 구성하였습니다.
1414
- 🧩 다양한 사용 환경을 고려해 `cjs`, `esm` 모듈을 지원하도록 번들링을 구성하였습니다.
15-
- ⌨️ Unconrolled Component 특성을 활용해 인터랙션이 필요한 컴포넌트들을 지원하였습니다.
15+
- ⌨️ Uncontrolled Component 특성을 활용해 인터랙션이 필요한 컴포넌트들을 지원하였습니다.
1616
- 💫 Form 관련 컴포넌트들은 [React Hook Form](https://react-hook-form.com/)을 지원합니다.
1717

1818
## Project Overview
@@ -52,24 +52,56 @@ import {Mail, Bell, Book, ...} from '@jdesignlab/react-icons'
5252

5353
## Components
5454

55-
- [Box](https://designsystemlab.github.io/design-system/?path=/docs/layout-box--basic)
56-
- [Button](https://designsystemlab.github.io/design-system/?path=/docs/actions-button--basic)
57-
- [Card](https://designsystemlab.github.io/design-system/?path=/docs/data-display-card--basic)
58-
- [Checkbox](https://designsystemlab.github.io/design-system/?path=/docs/forms-checkbox--basic)
59-
- [Drawer](https://designsystemlab.github.io/design-system/?path=/docs/actions-drawer--basic)
60-
- [Dropdown](https://designsystemlab.github.io/design-system/?path=/docs/layout-dropdown--basic)
61-
- [Flex](https://designsystemlab.github.io/design-system/?path=/docs/layout-flex--basic)
62-
- [Input](https://designsystemlab.github.io/design-system/?path=/docs/forms-textinput--basic)
63-
- [Modal](https://designsystemlab.github.io/design-system/?path=/docs/actions-modal--basic)
64-
- [Popover](https://designsystemlab.github.io/design-system/?path=/docs/actions-popover--basic)
65-
- [Radio](https://designsystemlab.github.io/design-system/?path=/docs/forms-radio--basic)
66-
- [Select](https://designsystemlab.github.io/design-system/?path=/docs/forms-select--basic)
67-
- [Stack](https://designsystemlab.github.io/design-system/?path=/docs/layout-stack--basic)
68-
- [Tabs](https://designsystemlab.github.io/design-system/?path=/docs/navigation-tabs--basic)
69-
- [Text](https://designsystemlab.github.io/design-system/?path=/docs/typography-text--basic)
70-
- [Textarea](https://designsystemlab.github.io/design-system/?path=/docs/forms-textarea--basic)
71-
- [Tooltip](https://designsystemlab.github.io/design-system/?path=/docs/layout-stack--basic)
55+
**Box**
56+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/box) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/layout-box--basic)
7257

58+
**Button**
59+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/button) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/actions-button--basic)
60+
61+
**Card**
62+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/card) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/data-display-card--basic)
63+
64+
**Checkbox**
65+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/checkbox) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/data-display-card--basic)
66+
67+
**Drawer**
68+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/drawer) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/actions-drawer--basic)
69+
70+
**Dropdown**
71+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/dropdown) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/layout-dropdown--basic)
72+
73+
**Flex**
74+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/flex) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/layout-flex--basic)
75+
76+
**Input**
77+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/input) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/forms-textinput--basic)
78+
79+
**Modal**
80+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/modal) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/actions-modal--basic)
81+
82+
**Popover**
83+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/popover) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/actions-popover--basic)
84+
85+
**Radio**
86+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/radio) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/forms-radio--basic)
87+
88+
**Select**
89+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/select) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/forms-select--basic)
90+
91+
**Stack**
92+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/stack) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/layout-stack--basic)
93+
94+
**Tabs**
95+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/tabs) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/navigation-tabs--basic)
96+
97+
**Text**
98+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/tabs) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/typography-text--basic)
99+
100+
**Textarea**
101+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/textarea) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/forms-textarea--basic)
102+
103+
**Tooltip**
104+
[<img src="https://img.shields.io/badge/README-1dd1a1?style=flat&logo=README&logoColor=white">](https://github.com/DesignSystemLab/design-system/tree/main/packages/tooltip) [<img src="https://img.shields.io/badge/storybook-FF4785?style=flat&logo=storybook&logoColor=white&style">](https://designsystemlab.github.io/design-system/?path=/docs/layout-stack--basic)
73105

74106
## Contributors
75107

0 commit comments

Comments
 (0)