Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(seed-docs): Chips Usage Option 추가 #359

Merged
merged 1 commit into from
Oct 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/content/component/chip-button/anatomy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/content/component/chip-button/thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions docs/content/component/chip-button/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,56 @@ slug: /component/chip-button/usage
4. Prefix Icon
5. Suffix Icon

## 옵션

<HalfCard>
<HalfCardImageCell>
![chipbutton options size](./chipbutton-options-size.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Size</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Button은 small, medium 2개의 사이즈를 가질 수 있습니다. medium이 가장 보편적으로 사용되며, 페이지 내의 중요도와 시각적 균형에 맞게 적절하게 사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chipbutton options disabled](./chipbutton-options-disabled.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Disabled</HalfCardDescriptionTitle>
<HalfCardDescription>
Disabled 상태는 Chip Button이 존재하지만 지금은 사용할 수 없는 상태를 나타냅니다. 이 옵션은 레이아웃 일관성을 유지하고 이후 상호작용이 가능할 수도 있음을 사용자에게 알려줍니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chipbutton options size](./chipbutton-options-count.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Count</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Button이 특정 데이터의 개수 값을 포함하고 있거나, 필터링된 항목 수를 표시할 때 Count 옵션을 사용할 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chipbutton options size](./chipbutton-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Prefix icon으로 Label을 보조하기 위한 모노크롬 아이콘을 사용할 수 있습니다. Suffix icon으로 Chevron을 사용해 칩 버튼의 상호작용을 강조할 수 있습니다. 동시 사용은 권장하지 않습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 | 값 | 기본값 |
Expand Down
Binary file added docs/content/component/chip-filter/anatomy.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/content/component/chip-filter/component-meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "../../../schema/component-meta.json",
"name": "Chip Filter",
"description": "여러개의 옵션 중 하나를 선택할 수 있는 컴포넌트입니다.",
"thumbnail": "../../comingSoon.png",
"thumbnail": "./thumbnail.png",
"group": "Chips",
"platform": {
"ios": {
Expand Down Expand Up @@ -41,4 +41,4 @@
}
}
}
}
}
Binary file added docs/content/component/chip-filter/thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 57 additions & 3 deletions docs/content/component/chip-filter/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,64 @@
slug: /component/chip-filter/usage
---

## Chip Filter
## 구조도

in progress
<Anatomy>![anatomy](./anatomy.png)</Anatomy>

1. Root
2. Label
3. Prefix Icon
4. Suffix Icon

## 옵션

<HalfCard>
<HalfCardImageCell>
![chip filter options selection](./chipfilter-options-selection.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Selection</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Filter는 selected, unselected 중 하나의 상태를 가질 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip filter options disabled](./chipfilter-options-disabled.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Disabled</HalfCardDescriptionTitle>
<HalfCardDescription>
Disabled 상태는 Chip Filter가 존재하지만 지금은 사용할 수 없는 상태를
나타냅니다. 이 옵션은 레이아웃 일관성을 유지하고 이후 상호작용이 가능할
수도 있음을 사용자에게 알려줍니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip filter options icon](./chipfilter-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Prefix icon으로 Label을 보조하기 위한 모노크롬 아이콘을 사용할 수
있습니다. Suffix icon으로 Chevron을 사용해 칩 버튼의 상호작용을 강조할 수
있습니다. 동시 사용은 권장하지 않습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 | 값 | 기본값 |
| ----------- | ----------- | ------ |
| is disabled | true, false | false |
| prefix icon | icon | |
| suffix icon | Icon | |

## 상호작용

Expand Down Expand Up @@ -33,4 +87,4 @@ in progress
Chip Filter의 액션을 실행시킬 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>
</HalfCard>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/content/component/chip-radio-group/thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
88 changes: 84 additions & 4 deletions docs/content/component/chip-radio-group/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,88 @@
slug: /component/chip-radio-group/usage
---

## Chip Radio Group Usage
## 구조도

in-progress
<Anatomy>![anatomy](./anatomy.png)</Anatomy>

1. Root
2. Chip
3. Label
4. Prefix Icon
5. Suffix Icon

## 옵션

<HalfCard>
<HalfCardImageCell>
![chip radio group options size](./chipradiogroup-options-size.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Size</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Radio Group은 small, medium 2개의 사이즈를 가질 수 있습니다. medium이
가장 보편적으로 사용되며, 페이지 내의 중요도와 시각적 균형에 맞게 적절하게
사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip radio group options
selection](./chipradiogroup-options-selection.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Selection</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Radio Group은 selected, unselected 중 하나의 상태를 가질 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip radio group options disabled](./chipradiogroup-options-disabled.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Disabled</HalfCardDescriptionTitle>
<HalfCardDescription>
Disabled 상태는 Chip Radio Group가 존재하지만 지금은 사용할 수 없는 상태를
나타냅니다. 이 옵션은 레이아웃 일관성을 유지하고 이후 상호작용이 가능할
수도 있음을 사용자에게 알려줍니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip radio group options icon](./chipradiogroup-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Prefix icon으로 Label을 보조하기 위한 모노크롬 아이콘을 사용할 수
있습니다. Suffix icon으로 Chevron을 사용해 칩 버튼의 상호작용을 강조할 수
있습니다. 동시 사용은 권장하지 않습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블 (Chip Radio Group)

| 속성 | 값 | 기본값 |
| ----------- | ------------- | ------ |
| size | small, medium | medium |
| is disabled | true, false | false |

### 옵션 테이블 (Chip Radio)

| 속성 | 값 | 기본값 |
| ----------- | ----------- | ------ |
| label | text | |
| is disabled | true, false | false |
| prefix icon | icon | |
| suffix icon | Icon | |

## 상호작용

Expand All @@ -28,7 +107,8 @@ in-progress
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Focus</HalfCardDescriptionTitle>
<HalfCardDescription>
<Keyboard>←</Keyboard> 또는 <Keyboard>→</Keyboard> 키를 통해 Chip 간 Focus 이동이 가능합니다.
<Keyboard>←</Keyboard> 또는 <Keyboard>→</Keyboard> 키를 통해 Chip 간 Focus
이동이 가능합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>
</HalfCard>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/content/component/chip-toggle-button/style.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ slug: /component/chip-toggle-button/style

## Anatomy

<Anatomy>![anatomy](./anatomy.png)</Anatomy>

1. Root - Primitive.Root
2. Label - Primitive.Label
3. Prefix Icon
Expand Down
Binary file modified docs/content/component/chip-toggle-button/thumbnail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
76 changes: 73 additions & 3 deletions docs/content/component/chip-toggle-button/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,79 @@
slug: /component/chip-toggle-button/usage
---

## Chip Toggle Button Usage
## 구조도

in-progress
<Anatomy>![anatomy](./anatomy.png)</Anatomy>

1. Root
2. Label
3. Prefix Icon
4. Suffix Icon

## 옵션

<HalfCard>
<HalfCardImageCell>
![chipbutton options size](./chiptogglebutton-options-size.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Size</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Toggle Button은 small, medium 2개의 사이즈를 가질 수 있습니다.
medium이 가장 보편적으로 사용되며, 페이지 내의 중요도와 시각적 균형에 맞게
적절하게 사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip filter options selection](./chiptogglebutton-options-selection.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Selection</HalfCardDescriptionTitle>
<HalfCardDescription>
Chip Toggle Button는 selected, unselected 중 하나의 상태를 가질 수
있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip filter options disabled](./chiptogglebutton-options-disabled.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Disabled</HalfCardDescriptionTitle>
<HalfCardDescription>
Disabled 상태는 Chip Toggle Button이 존재하지만 지금은 사용할 수 없는
상태를 나타냅니다. 이 옵션은 레이아웃 일관성을 유지하고 이후 상호작용이
가능할 수도 있음을 사용자에게 알려줍니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![chip filter options icon](./chiptogglebutton-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Prefix icon으로 Label을 보조하기 위한 모노크롬 아이콘을 사용할 수
있습니다. Suffix icon으로 Chevron을 사용해 칩 버튼의 상호작용을 강조할 수
있습니다. 동시 사용은 권장하지 않습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 | 값 | 기본값 |
| ----------- | ----------- | ------ |
| is disabled | true, false | false |
| prefix icon | icon | |
| suffix icon | Icon | |

## 상호작용

Expand Down Expand Up @@ -32,4 +102,4 @@ in-progress
Selected 상태를 전환할 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>
</HalfCard>
Binary file modified docs/content/component/radio-group/anatomy.png