Skip to content

Commit

Permalink
docs(spindle-ui): コンポーネント表記の修正 Snackbar -> SnackBar
Browse files Browse the repository at this point in the history
  • Loading branch information
tokimari committed Jan 10, 2025
1 parent 229d44d commit b275097
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ InlineNotificationコンポーネントは、ユーザーのアクションに

## ユーザーへの通知の種別

ユーザーにお知らせをするための他のComponentとしてToastとSnackbarがあります。画面内で完結せず、遷移させるべき状況もあります。現状下記のように使い分けています。
ユーザーにお知らせをするための他のComponentとしてToastとSnackBarがあります。画面内で完結せず、遷移させるべき状況もあります。現状下記のように使い分けています。

### 通信を伴うデータ更新のフィードバック

Expand All @@ -50,7 +50,7 @@ InlineNotificationコンポーネントは、ユーザーのアクションに
| Component | 用途 | テキストの長さ | 追加のアクション | 自動で消える秒数 | 表示位置 |
| ---- | ---- | ---- | ---- | ---- | ---- |
| [Toast](/docs/toast--information) | 更新処理の**成功を伝える**<br />**見落としても支障がないもの** | 1行 | なし | 4秒 | フローティング<br />(画面上下の中央のみ※) |
| [Snackbar](/docs/snackbar--information) | **読んでは欲しい訴求** | 3,4行まで | あり | 10秒 | フローティング<br />(画面上下の左・右・中央) |
| [SnackBar](/docs/snackbar--information) | **読んでは欲しい訴求** | 3,4行まで | あり | 10秒 | フローティング<br />(画面上下の左・右・中央) |
| [InlineNotification](/docs/inlinenotification--information) | 更新処理の**失敗を伝える**<br />**ユーザーが追加でアクションする必要があるもの** | 制限なし | あり | 消えない | ページに埋め込む必要があり、レイアウトに影響を与える |

※現在は、SPは中央下のみ実装されています。
Expand Down
2 changes: 1 addition & 1 deletion packages/spindle-ui/src/InlineNotification/design-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ InlineNotificationコンポーネントは、ユーザーのアクションに
Component | テキストの長さ | 追加のアクションの有無 | 自動で消える秒数 | 表示位置 | メッセージの内容
:-- | :-- | :-- | :-- | :-- | :--
Toast | 1行のみ | なし | 4秒 | フローティングで位置固定で表示(画面上下の中央のみ) | 見落としても支障がない
Snackbar | 3,4行まで | あり | 10秒 | フローティングで位置固定で表示(画面上下の左・右・中央)| 読んでは欲しい、訴求
SnackBar | 3,4行まで | あり | 10秒 | フローティングで位置固定で表示(画面上下の左・右・中央)| 読んでは欲しい、訴求
InlineNotification | 制限なし | あり | 消えない | ページに埋め込む必要がありレイアウトに影響を与える | エラー通知など、ユーザーの追加のアクションが必要なもの

## スクリーンショット
Expand Down
2 changes: 1 addition & 1 deletion packages/spindle-ui/src/SnackBar/SnackBar.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ SnackBarコンポーネントは、利用者に一時的なお知らせをする
| Component | 用途 | テキストの長さ | 追加のアクション | 自動で消える秒数 | 表示位置 |
| ---- | ---- | ---- | ---- | ---- | ---- |
| [Toast](/docs/toast--information) | 更新処理の**成功を伝える**<br />**見落としても支障がないもの** | 1行 | なし | 4秒 | フローティング<br />(画面上下の中央のみ※) |
| [Snackbar](/docs/snackbar--information) | **読んでは欲しい訴求** | 3,4行まで | あり | 10秒 | フローティング<br />(画面上下の左・右・中央) |
| [SnackBar](/docs/snackbar--information) | **読んでは欲しい訴求** | 3,4行まで | あり | 10秒 | フローティング<br />(画面上下の左・右・中央) |
| [InlineNotification](/docs/inlinenotification--information) | 更新処理の**失敗を伝える**<br />**ユーザーが追加でアクションする必要があるもの** | 制限なし | あり | 消えない | ページに埋め込む必要があり、レイアウトに影響を与える |

※現在は、SPは中央下のみ実装されています。
Expand Down
2 changes: 1 addition & 1 deletion packages/spindle-ui/src/Toast/Toast.stories.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Toastコンポーネントは、利用者に一時的なお知らせをする際

## ユーザーへの通知の種別

ユーザーにお知らせをするための他のComponentとしてSnackbarとInlineNotificationがあります。画面内で完結せず、遷移させるべき状況もあります。現状下記のように使い分けています。
ユーザーにお知らせをするための他のComponentとしてSnackBarとInlineNotificationがあります。画面内で完結せず、遷移させるべき状況もあります。現状下記のように使い分けています。

### 通信を伴うデータ更新のフィードバック

Expand Down

0 comments on commit b275097

Please sign in to comment.