Skip to content

Commit

Permalink
docs(seed-docs): Inline Alerts (#409)
Browse files Browse the repository at this point in the history
* Inline Alert - Option guideline

* chore: 썸네일 변경

---------

Co-authored-by: junghyeonsu <jung660317@naver.com>
  • Loading branch information
yeeeeeeeni and junghyeonsu authored Apr 12, 2024
1 parent 7b70cf5 commit 212fb03
Show file tree
Hide file tree
Showing 30 changed files with 283 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "../../../schema/component-meta.json",
"name": "Actionable Inline Alert",
"description": "유저가 꼭 알아야하는 경고성 메시지나 광고의 상태를 전달하는 시스템 메시지에요. 주로 Top Navigation 아래에 고정되어 노출하며, 주목도가 높으니 필요한 경우에 제한적으로 사용해주세요.",
"thumbnail": "../../imageNotReady.png",
"thumbnail": "./images/thumbnail.png",
"group": "Inline Alerts",
"platform": {
"ios": {
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.
93 changes: 93 additions & 0 deletions docs/content/component/actionable-inline-alert/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,96 @@ slug: /component/actionable-inline-alert/usage
---

## 구조도

<Anatomy>![actionable inline alert usage anatomy](./images/anatomy.png)</Anatomy>

1. Root
2. Icon
3. Content
4. Title
5. Description
6. Action


## 옵션

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-variant-normal.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Normal</HalfCardDescriptionTitle>
<HalfCardDescription>
일반적인 상황에 사용되는 배리언트로, 일반적인 정보나 안내에 적합합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-variant-info.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Info</HalfCardDescriptionTitle>
<HalfCardDescription>
추가 정보를 전달하거나 유저에게 주의를 요하는 경우에 사용됩니다. 주로 중요한 메시지 전달에 활용됩니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-variant-success.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Success</HalfCardDescriptionTitle>
<HalfCardDescription>
성공적인 작업을 나타내는 배리언트로, 유저의 긍정적인 경험을 강조하거나 과업이 완료되었을 때 나타냅니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-variant-danger.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Danger</HalfCardDescriptionTitle>
<HalfCardDescription>
위험한 상황을 나타내거나 유저에게 경고를 주어야 할 때 사용되는 배리언트로, 주의가 필요한 상황을 강조합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-weight.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Weight</HalfCardDescriptionTitle>
<HalfCardDescription>
Standard는 기본값으로 사용을 권장하며, 대부분의 상황에서 적합합니다. 일반적인 메시지나 안내에 이 옵션을 사용하여 메시지를 전달하는 것이 좋습니다. Strong은 특정 메시지를 강조하는 데 사용됩니다. 시각적으로 강한 주목도를 갖고있어 꼭 필요한 경우에 제한적으로 사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![actionable inline alert options text](./images/actionableinlinealert-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Icon은 Inline Alert의 내용이나 목적을 시각적으로 나타내고 보조하는 역할을 합니다. 유저가 Icon을 통해 어떤 유형의 메시지인지 쉽게 인지할 수 있도록 돕습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 || 기본값 |
| ----------- | -------------------------------------- | ------ |
| variant | normal, info, success, danger | normal |
| weight | standard, strong | |
| description | text | |
| icon | Icon | |
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"$schema": "../../../schema/component-meta.json",
"name": "Dismissable Inline Alert",
"description": "게시글이나 프로필에 노출되는 시스템 메시지예요. 유저가 꼭 알아야하는 경고성 메시지나 광고의 상태를 표현할 수 있어요. 주로 Top Navigation 아래에 고정되어 노출하며, 주목도가 높으니 필요한 경우에 제한적으로 사용해주세요.",
"thumbnail": "../../imageNotReady.png",
"thumbnail": "./images/thumbnail.png",
"group": "Inline Alerts",
"platform": {
"ios": {
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.
93 changes: 93 additions & 0 deletions docs/content/component/dismissable-inline-alert/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,96 @@ slug: /component/dismissable-inline-alert/usage
---

## 구조도

<Anatomy>![dismissable inline alert usage anatomy](./images/anatomy.png)</Anatomy>

1. Root
2. Icon
3. Content
4. Title
5. Description
6. Action


## 옵션

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-variant-normal.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Normal</HalfCardDescriptionTitle>
<HalfCardDescription>
일반적인 상황에 사용되는 배리언트로, 일반적인 정보나 안내에 적합합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-variant-info.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Info</HalfCardDescriptionTitle>
<HalfCardDescription>
추가 정보를 전달하거나 유저에게 주의를 요하는 경우에 사용됩니다. 주로 중요한 메시지 전달에 활용됩니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-variant-success.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Success</HalfCardDescriptionTitle>
<HalfCardDescription>
성공적인 작업을 나타내는 배리언트로, 유저의 긍정적인 경험을 강조하거나 과업이 완료되었을 때 나타냅니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-variant-danger.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Danger</HalfCardDescriptionTitle>
<HalfCardDescription>
위험한 상황을 나타내거나 유저에게 경고를 주어야 할 때 사용되는 배리언트로, 주의가 필요한 상황을 강조합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-weight.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Weight</HalfCardDescriptionTitle>
<HalfCardDescription>
Standard는 기본값으로 사용을 권장하며, 대부분의 상황에서 적합합니다. 일반적인 메시지나 안내에 이 옵션을 사용하여 메시지를 전달하는 것이 좋습니다. Strong은 특정 메시지를 강조하는 데 사용됩니다. 시각적으로 강한 주목도를 갖고있어 꼭 필요한 경우에 제한적으로 사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![dismissable inline alert options text](./images/dismissableinlinealert-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Icon은 Inline Alert의 내용이나 목적을 시각적으로 나타내고 보조하는 역할을 합니다. 유저가 Icon을 통해 어떤 유형의 메시지인지 쉽게 인지할 수 있도록 돕습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 || 기본값 |
| ----------- | -------------------------------------- | ------ |
| variant | normal, info, success, danger | normal |
| weight | standard, strong | |
| description | text | |
| icon | Icon | |
4 changes: 2 additions & 2 deletions docs/content/component/inline-alert/component-meta.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"$schema": "../../../schema/component-meta.json",
"name": "Inline Alert",
"description": "유저가 꼭 알아야하는 경고성 메시지나 광고의 상태를 전달하는 시스템 메시지에요. 주로 Top Navigation 아래에 고정되어 노출하며, 주목도가 높으니 필요한 경우에 제한적으로 사용해주세요.",
"thumbnail": "../../imageNotReady.png",
"description": "유저가 꼭 알아야하는 경고성 메시지나 광고의 상태를 전달하는 시스템 메시지입니다. 주로 Top Navigation 아래에 고정되어 노출하며, 주목도가 높으니 필요한 경우에 제한적으로 사용합니다.",
"thumbnail": "./images/thumbnail.png",
"group": "Inline Alerts",
"platform": {
"ios": {
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.
93 changes: 93 additions & 0 deletions docs/content/component/inline-alert/usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,96 @@ slug: /component/inline-alert/usage
---

## 구조도

<Anatomy>![inline alert usage anatomy](./images/anatomy.png)</Anatomy>

1. Root
2. Icon
3. Content
4. Title
5. Description
6. Action


## 옵션

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-variant-normal.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Normal</HalfCardDescriptionTitle>
<HalfCardDescription>
일반적인 상황에 사용되는 배리언트로, 일반적인 정보나 안내에 적합합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-variant-info.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Info</HalfCardDescriptionTitle>
<HalfCardDescription>
추가 정보를 전달하거나 유저에게 주의를 요하는 경우에 사용됩니다. 주로 중요한 메시지 전달에 활용됩니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-variant-success.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Success</HalfCardDescriptionTitle>
<HalfCardDescription>
성공적인 작업을 나타내는 배리언트로, 유저의 긍정적인 경험을 강조하거나 과업이 완료되었을 때 나타냅니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-variant-danger.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Danger</HalfCardDescriptionTitle>
<HalfCardDescription>
위험한 상황을 나타내거나 유저에게 경고를 주어야 할 때 사용되는 배리언트로, 주의가 필요한 상황을 강조합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-weight.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Weight</HalfCardDescriptionTitle>
<HalfCardDescription>
Standard는 기본값으로 사용을 권장하며, 대부분의 상황에서 적합합니다. 일반적인 메시지나 안내에 이 옵션을 사용하여 메시지를 전달하는 것이 좋습니다. Strong은 특정 메시지를 강조하는 데 사용됩니다. 시각적으로 강한 주목도를 갖고있어 꼭 필요한 경우에 제한적으로 사용합니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

<HalfCard>
<HalfCardImageCell>
![inline alert options text](./images/inlinealert-options-icon.png)
</HalfCardImageCell>
<HalfCardDescriptionCell>
<HalfCardDescriptionTitle>Icon</HalfCardDescriptionTitle>
<HalfCardDescription>
Icon은 Inline Alert의 내용이나 목적을 시각적으로 나타내고 보조하는 역할을 합니다. 유저가 Icon을 통해 어떤 유형의 메시지인지 쉽게 인지할 수 있도록 돕습니다.
</HalfCardDescription>
</HalfCardDescriptionCell>
</HalfCard>

### 옵션 테이블

| 속성 || 기본값 |
| ----------- | -------------------------------------- | ------ |
| variant | normal, info, success, danger | normal |
| weight | standard, strong | |
| description | text | |
| icon | Icon | |

0 comments on commit 212fb03

Please sign in to comment.