diff --git a/ui-kit/.storybook/preview.js b/ui-kit/.storybook/preview.js index 73c9c720..212055c7 100644 --- a/ui-kit/.storybook/preview.js +++ b/ui-kit/.storybook/preview.js @@ -14,7 +14,7 @@ export const parameters = { options: { storySort: { method: '', - order: ['Lubycon UI Kit',['Welcome', 'Getting Started'], 'Styles', 'Components'], + order: ['Lubycon UI Kit',['Welcome', 'Getting Started', 'Usage'], 'Styles', 'Components'], locales: '', }, }, diff --git a/ui-kit/src/stories/Components/Accordion/index.stories.mdx b/ui-kit/src/stories/Components/Accordion/index.stories.mdx index 62050164..d866b646 100644 --- a/ui-kit/src/stories/Components/Accordion/index.stories.mdx +++ b/ui-kit/src/stories/Components/Accordion/index.stories.mdx @@ -5,8 +5,12 @@ import { Meta, Story, Canvas } from '@storybook/addon-docs/blocks'; # Accordion +아코디언은 펼치거나 접을 수 있는 패널 컴포넌트 입니다. 펼침 상태를 활용하여 추가적인 정보를 사용자에게 제공할 수 있습니다. 기본적으로 접힌 상태이며, 사용자가 해당 패널을 클릭하면 펼침 상태로 변경됩니다. + ## Preview +라벨은 펼쳐지기 전에 아코디언에 보여지는 텍스트 영역을 가리킵니다. 펼쳐진 부분의 텍스트 영역은 아코디언 컴포넌트의 내부에 기입한 내용으로 나타납니다. + + +## Default Open + +아코디언 컴포넌트가 처음 렌더될 때의 펼침여부를 결정할 수 있습니다. + + + + + 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+ 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+ 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+
+
+
+ +# 이벤트 핸들러 + +Lubycon UI Kit에서는 아코디언 컴포넌트의 상태에 따라 호출되는 함수 props를 제공하고 있습니다. + +`onChange`는 아코디언 패널의 펼침 접힘 상태가 변경되었을 때, `onOpen`은 아코디언 패널이 펼쳐졌을 때, `onClose`는 아코디언 패널이 접혀졌을 때 호출됩니다. + + + + + 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+ 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+ 아코디언이 펼쳐지면 아래에 내용이 나옵니다. +
+
+
+
diff --git a/ui-kit/src/stories/Components/Alert/index.stories.mdx b/ui-kit/src/stories/Components/Alert/index.stories.mdx index 5206485b..e84616d5 100644 --- a/ui-kit/src/stories/Components/Alert/index.stories.mdx +++ b/ui-kit/src/stories/Components/Alert/index.stories.mdx @@ -11,7 +11,21 @@ import { alerts } from './data'; - + 메세지를 넣어주세요 + + + +### Title + +특별히 강조하고 싶은 메세지가 있는 경우에는 `title` 프로퍼티를 사용할 수 있습니다. `title` 프로퍼티에 입력된 값은 `Alert` 의 왼쪽 부분에 진한 글씨로 강조되어 렌더됩니다. + +### Type + +`Alert` 컴포넌트는 Lubycon UI Kit에서 제공하는 4가지 시맨틱 컬러를 기반으로 한 타입을 가지고 있습니다. 기본적으로 아무 타입도 주지 않았을 때 `Alert` 컴포넌트는 `informative` 타입으로 렌더됩니다. + + + + {alerts.map(({ type, title }) => ( diff --git a/ui-kit/src/stories/Components/Button/index.stories.mdx b/ui-kit/src/stories/Components/Button/index.stories.mdx index 989a2032..40235b84 100644 --- a/ui-kit/src/stories/Components/Button/index.stories.mdx +++ b/ui-kit/src/stories/Components/Button/index.stories.mdx @@ -7,45 +7,66 @@ import { sizeList, buttonText, semanticColors } from './data'; # Button +버튼 컴포넌트는 HTML의 button 엘리먼트를 기반으로 만들어졌기 때문에, Lubycon UI Kit이 제공하는 인터페이스 외에 기존 HTML의 button 엘리먼트가 제공하고 있던 기능도 모두 사용 가능합니다. + ## Preview - {sizeList.map((size, index) => ( - - - {size.charAt(0).toUpperCase() + size.slice(1)} - - - - - - - - - ))} + -## Types +### Size + +`Button` 컴포넌트는 `small` `medium` `large` 3가지의 사이즈를 가지고 있습니다. + + + + + + + + + + + + + + + + + +### Types + +`Button` 컴포넌트는 Lubycon UI Kit에서 제공하는 4가지 시맨틱 컬러를 기반으로 한 타입을 가지고 있습니다. + +기본적으로 아무 타입도 주지 않았을 때 `Button` 컴포넌트는 배경색이 없는 투명 상태로 렌더됩니다. - {semanticColors.map((type, index) => ( - - - {type.charAt(0).toUpperCase() + type.slice(1)} - - - - - - ))} + + + + + + + + + + + + + + + + + diff --git a/ui-kit/src/stories/Components/Card/index.stories.mdx b/ui-kit/src/stories/Components/Card/index.stories.mdx index 6ec4be63..1c586ad4 100644 --- a/ui-kit/src/stories/Components/Card/index.stories.mdx +++ b/ui-kit/src/stories/Components/Card/index.stories.mdx @@ -17,38 +17,44 @@ import { Meta, Story, Canvas } from '@storybook/addon-docs/blocks'; # Card -## Preview +- Card는 단일 주제에 대한 정보 전달을 목적으로 하는 컴포넌트입니다. +- Card는 상세하고 디테일한 문서 내용을 전달하기에 앞서 진입점으로 사용되는 컴포넌트입니다. +- 카드의 내용에 따라 자율적인 UI 변경이 가능합니다. Icon, UI controls, text를 추가할 수 있습니다. +- 표현하고자 하는 내용에 따라 header/text/footer 레이아웃을 변경해 사용할 수 있습니다. +- Default와 Image card 두 가지 형태를 제공합니다. + +## Default Card + +가장 기본적인 text type 카드입니다. 필요에 따라 커스텀해 사용할 수 있습니다. - -
- - 제목 - - - 내용을 입력하세요. -
- 내용을 입력하세요. -
- 내용을 입력하세요. -
- 내용을 입력하세요. + + + 제목 + + + 내용을 입력하세요. +
+ 내용을 입력하세요. +
+ 내용을 입력하세요. +
+ 내용을 입력하세요. +
+
+ + + + 더보기 -
- - - - 더보기 - - - - -
-
+ + + +
@@ -56,45 +62,17 @@ import { Meta, Story, Canvas } from '@storybook/addon-docs/blocks'; - - - - 제목 - - - - - 더보기 - - - - - - - - - 춤추는 에비츄 - - - - - - - - - 장보는 에비츄 - - - - + + 제목 + + + + + 더보기 + + + + + diff --git a/ui-kit/src/stories/Components/Checkbox/index.stories.mdx b/ui-kit/src/stories/Components/Checkbox/index.stories.mdx index d2902087..c03e84f3 100644 --- a/ui-kit/src/stories/Components/Checkbox/index.stories.mdx +++ b/ui-kit/src/stories/Components/Checkbox/index.stories.mdx @@ -5,12 +5,15 @@ import { Checkbox } from 'src'; # Checkbox +기본적인 목적에 충실한 체크박스 컴포넌트를 제공합니다. 하나의 아이템이나 여러 개의 아이템을 선택하는 상황을 표현하는데 사용할 수 있습니다. + ## Preview +간단한 라벨 정의만으로 체크박스 컴포넌트를 사용할 수 있습니다. + - @@ -27,6 +30,8 @@ import { Checkbox } from 'src'; ## Inline +필요에 따라 display 설정을 props로 조정할 수 있습니다. + diff --git a/ui-kit/src/stories/Components/Grid/index.stories.mdx b/ui-kit/src/stories/Components/Grid/index.stories.mdx index 6ede94ff..77eceea9 100644 --- a/ui-kit/src/stories/Components/Grid/index.stories.mdx +++ b/ui-kit/src/stories/Components/Grid/index.stories.mdx @@ -6,6 +6,8 @@ import { columns, columnStyle } from './data'; # Grid +그리드는 유연하게 레이아웃을 정의하면서도 시각적인 일관성을 만들어줍니다. Lubycon UI Kit 의 그리드는 12개의 컬럼을 기반으로 구성되어있습니다. + ## Preview diff --git a/ui-kit/src/stories/Components/Modal/index.stories.mdx b/ui-kit/src/stories/Components/Modal/index.stories.mdx index 728edcd9..1ed42df8 100644 --- a/ui-kit/src/stories/Components/Modal/index.stories.mdx +++ b/ui-kit/src/stories/Components/Modal/index.stories.mdx @@ -6,8 +6,16 @@ import { Preview, ModalHooks } from './Components'; # Modal +모달 컴포넌트는 사용자 화면 위에 나타나는 또 다른 UI 입니다. 모달 컴포넌트가 열리게 되면, 모달 영역 내의 콘텐츠만 조작이 가능합니다. 현재 페이지 영역 내에서 더 자세한 정보를 보여주고 싶을 때 사용할 수 있습니다. + +> **주의사항** +> +> Modal 컴포넌트는 컴포넌트 합성 방식으로 사용이 가능합니다. Lubycon UI Kit에서 지정한 헤더와 푸터같은 특정 영역은 별도의 컴포넌트로 분리되어 있습니다 + ## Preview +기본 모달 컴포넌트 형태입니다. `Modal` 컴포넌트 내부를 사용자의 임의로 구성하여 사용할 수 있습니다. 모달 내부에는 적어도 한 개 이상의 컴포넌트가 들어가야 합니다. size나 모달의 상태에 따른 여러가지 이벤트 핸들러를 등록할 수 있습니다. + @@ -16,6 +24,8 @@ import { Preview, ModalHooks } from './Components'; ## With Hooks +모달 컴포넌트를 명령형으로 사용하는 방법입니다. openModal 함수의 인자로 컴포넌트를 정의해서 사용할 수 있습니다. 해당 함수는 모달의 ID 값을 반환하며, 이 ID 값을 closeModl 함수의 인자로 넘겨서 해당 모달이 닫히도록 만들 수 있습니다. + diff --git a/ui-kit/src/stories/Components/ProgressBar/index.stories.mdx b/ui-kit/src/stories/Components/ProgressBar/index.stories.mdx index 748ca649..7afd077a 100644 --- a/ui-kit/src/stories/Components/ProgressBar/index.stories.mdx +++ b/ui-kit/src/stories/Components/ProgressBar/index.stories.mdx @@ -6,8 +6,12 @@ import { Preview, Label, LabelFormatter } from './Components'; # ProgressBar +ProgressBar 컴포넌트는 진행 상태를 시각적으로 나타내는 컴포넌트 입니다. Lubycon UI Kit에서는 현재 긴 막대 모양의 디자인만 제공하고 있습니다. + ## Preview +가장 기본적인 형태의 ProgressBar 입니다. 별도의 텍스트 없이 ProgressBar만 렌더링 됩니다. + @@ -16,6 +20,8 @@ import { Preview, Label, LabelFormatter } from './Components'; ## Label +Label을 함께 노출합니다. 기본으로 지정된 위치는 ProgressBar의 상단이며, 값은 현재 진행 정도를 나타내는 숫자입니다. `top`, `bottom`, `left`, `right` 값을 통해 변경할 수 있습니다. +