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): add <SelectBox /> guideline #410

Merged
merged 2 commits into from
Apr 19, 2024
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
2 changes: 1 addition & 1 deletion docs/content/component/select-box/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": "Select Box",
"description": "주로 동적폼에서 사용되며, 여러개의 선택지(옵션)를 제공하는 경우에 사용해요.",
"thumbnail": "../../imageNotReady.png",
"thumbnail": "./images/thumbnail.png",
"platform": {
"ios": {
"status": "todo",
Expand Down
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
98 changes: 98 additions & 0 deletions docs/content/component/select-box/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,101 @@ slug: /component/select-box/usage
---

## 구조도

<Anatomy>![select box usage anatomy](./images/anatomy.png)</Anatomy>

1. Root
2. Content
3. Label
4. Description
5. Control


## 옵션

<HalfCard>
<HalfCardImageCell>
![select box options text](./images/selectbox-options-checkbox.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Checkbox</HalfCardDescriptionTitle>
<HalfCardDescription>
유저가 여러가지 옵션을 복수 선택할 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![select box options text](./images/selectbox-options-radio.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Radio</HalfCardDescriptionTitle>
<HalfCardDescription>
두 가지 이상의 옵션 중 하나의 옵션만 선택할 수 있으며, 사용자가 하나의 옵션을 선택하면 다른 옵션은 Unselected 됩니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![select box options text](./images/selectbox-options-titleonly.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Description</HalfCardDescriptionTitle>
<HalfCardDescription>
사용자가 선택해야 하는 옵션에 대한 추가 컨텍스트나 도움말을 제공할 수 있습니다. 사용자가 옵션 선택을 더욱 쉽게 이해하고 완료할 수 있도록 돕습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>


### 옵션 테이블

| 속성 | 값 | 기본값 |
| ----------- | -------------------------------------- | ------ |
| control | checkbox, radio | checkbox |
| description | text | |

## 상호작용

### 터치/마우스

<HalfCard>
<HalfCardImageCell>
![select box behavior touch area](./images/selectbox-behavior-3.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Touch area</HalfCardDescriptionTitle>
<HalfCardDescription>
마우스 클릭 또는 터치로 Select Box와 상호작용할 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 키보드

<HalfCard>
<HalfCardImageCell>
![select box behavior focus](./images/selectbox-behavior-1.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Focus</HalfCardDescriptionTitle>
<HalfCardDescription>
<Keyboard>tab</Keyboard> 키를 통해 Focus를 옮길 수 있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![select box behavior Selected](./images/selectbox-behavior-2.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Selected ON/OFF</HalfCardDescriptionTitle>
<HalfCardDescription>
Focus된 상태에서 <Keyboard>space</Keyboard> 키를 통해 ON / OFF를 전환할 수
있습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>
Loading