@squadbase/vantage 0.6.2-dev1.b332e5a → 0.6.2-dev1.d7c0911
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/add-4GHF2TX2.js +6 -0
- package/dist/add-4GHF2TX2.js.map +1 -0
- package/dist/{build-TVKFIVFQ.js → build-X5NVCQKT.js} +7 -7
- package/dist/{build-TVKFIVFQ.js.map → build-X5NVCQKT.js.map} +1 -1
- package/dist/{check-3KHZXZMQ.js → check-ZBIH422T.js} +5 -5
- package/dist/{check-3KHZXZMQ.js.map → check-ZBIH422T.js.map} +1 -1
- package/dist/chunk-2ICNHUG6.js +1820 -0
- package/dist/chunk-2ICNHUG6.js.map +1 -0
- package/dist/{chunk-5ZOP4SQR.js → chunk-2N72FKLB.js} +12 -7
- package/dist/chunk-2N72FKLB.js.map +1 -0
- package/dist/{chunk-P7W4LR3Z.js → chunk-7DZGJQ3P.js} +3 -3
- package/dist/{chunk-P7W4LR3Z.js.map → chunk-7DZGJQ3P.js.map} +1 -1
- package/dist/{chunk-U2M6HGKQ.js → chunk-AABMKHEU.js} +4 -4
- package/dist/{chunk-U2M6HGKQ.js.map → chunk-AABMKHEU.js.map} +1 -1
- package/dist/{chunk-QI3XQKHS.js → chunk-GNXCX4WE.js} +10 -3
- package/dist/chunk-GNXCX4WE.js.map +1 -0
- package/dist/{chunk-PXRX5PEC.js → chunk-PDOBHMUQ.js} +3 -3
- package/dist/chunk-PDOBHMUQ.js.map +1 -0
- package/dist/{chunk-ZVANIULZ.js → chunk-RNTDBX6S.js} +4 -4
- package/dist/{chunk-ZVANIULZ.js.map → chunk-RNTDBX6S.js.map} +1 -1
- package/dist/{chunk-A2UUGASH.js → chunk-U736PVHY.js} +2 -2
- package/dist/chunk-U736PVHY.js.map +1 -0
- package/dist/{chunk-PVTHHV7X.js → chunk-V3LF7BE7.js} +27 -5
- package/dist/chunk-V3LF7BE7.js.map +1 -0
- package/dist/{chunk-LMUACBMA.js → chunk-WAMZWZJB.js} +53 -8
- package/dist/chunk-WAMZWZJB.js.map +1 -0
- package/dist/chunk-WRSX2MDK.js +7866 -0
- package/dist/chunk-WRSX2MDK.js.map +1 -0
- package/dist/{chunk-RPZAALCX.js → chunk-XPQSTZUU.js} +254 -164
- package/dist/chunk-XPQSTZUU.js.map +1 -0
- package/dist/{chunk-DTDVSFRY.js → chunk-XQUSGIDG.js} +17 -3
- package/dist/chunk-XQUSGIDG.js.map +1 -0
- package/dist/cli.js +12 -11
- package/dist/cli.js.map +1 -1
- package/dist/client/index.d.ts +32 -3
- package/dist/client/index.js +205 -12
- package/dist/client/index.js.map +1 -1
- package/dist/components/index.d.ts +1975 -28
- package/dist/components/index.js +4 -4
- package/dist/{dev-GDKATCC7.js → dev-4XEDTELV.js} +8 -8
- package/dist/dev-4XEDTELV.js.map +1 -0
- package/dist/doc/index.js +2 -2
- package/dist/doc/index.js.map +1 -1
- package/dist/{docs-EJJ3BECT.js → docs-JVP4RPKT.js} +3 -3
- package/dist/{docs-EJJ3BECT.js.map → docs-JVP4RPKT.js.map} +1 -1
- package/dist/{doctor-WQXPXP6K.js → doctor-5E2VEZPK.js} +5 -5
- package/dist/{doctor-WQXPXP6K.js.map → doctor-5E2VEZPK.js.map} +1 -1
- package/dist/markdown/index.js +1 -1
- package/dist/markdown/index.js.map +1 -1
- package/dist/{preview-OGMCNQUO.js → preview-T6CLSQVX.js} +3 -3
- package/dist/{preview-OGMCNQUO.js.map → preview-T6CLSQVX.js.map} +1 -1
- package/dist/query/index.d.ts +0 -11
- package/dist/query/index.js +2 -2
- package/dist/{routes-MWBWWOJ2.js → routes-3SGAFDMC.js} +4 -4
- package/dist/{routes-MWBWWOJ2.js.map → routes-3SGAFDMC.js.map} +1 -1
- package/dist/{search-6Y422SV6.js → search-5LC4XPB5.js} +3 -3
- package/dist/{search-6Y422SV6.js.map → search-5LC4XPB5.js.map} +1 -1
- package/dist/table/index.js +10 -9
- package/dist/table/index.js.map +1 -1
- package/dist/ui/index.d.ts +144 -11
- package/dist/ui/index.js +1339 -87
- package/dist/ui/index.js.map +1 -1
- package/dist/{upgrade-HCANX4GQ.js → upgrade-JHXZBGQS.js} +6 -6
- package/dist/{upgrade-HCANX4GQ.js.map → upgrade-JHXZBGQS.js.map} +1 -1
- package/dist/vite/index.d.ts +10 -0
- package/dist/vite/index.js +3 -3
- package/docs/en/components.md +29 -15
- package/docs/en/parts/data-table.md +22 -0
- package/docs/en/parts/delta.md +50 -0
- package/docs/en/parts/format.md +43 -0
- package/docs/en/parts/kpi-card.md +57 -0
- package/docs/en/parts/metric-value.md +3 -2
- package/docs/en/parts/sparkline.md +1 -1
- package/docs/en/parts/trend-indicator.md +17 -1
- package/docs/en/ui-and-theming.md +1 -1
- package/docs/index.json +366 -76
- package/docs/ja/changelog.md +31 -0
- package/docs/ja/components.md +57 -101
- package/docs/ja/page-types/csv.md +83 -0
- package/docs/ja/page-types/doc.md +83 -0
- package/docs/ja/page-types/excel.md +82 -0
- package/docs/ja/page-types/slide.md +132 -0
- package/docs/ja/page-types.md +47 -0
- package/docs/ja/parts/area-chart.md +61 -0
- package/docs/ja/parts/bar-chart.md +69 -0
- package/docs/ja/parts/bar-list.md +35 -0
- package/docs/ja/parts/category-bar.md +36 -0
- package/docs/ja/parts/data-table.md +22 -0
- package/docs/ja/parts/delta.md +50 -0
- package/docs/ja/parts/donut-chart.md +47 -0
- package/docs/ja/parts/echart.md +3 -0
- package/docs/ja/parts/format.md +44 -0
- package/docs/ja/parts/kpi-card.md +55 -0
- package/docs/ja/parts/line-chart.md +58 -0
- package/docs/ja/parts/metric-value.md +3 -2
- package/docs/ja/parts/progress-circle.md +34 -0
- package/docs/ja/parts/sparkline.md +2 -2
- package/docs/ja/parts/tracker.md +32 -0
- package/docs/ja/parts/trend-indicator.md +17 -1
- package/docs/ja/routing.md +8 -86
- package/docs/ja/ui/alert-dialog.md +41 -0
- package/docs/ja/ui/avatar.md +31 -0
- package/docs/ja/ui/combobox.md +74 -0
- package/docs/ja/ui/drawer.md +41 -0
- package/docs/ja/ui/field.md +42 -0
- package/docs/ja/ui/hover-card.md +21 -0
- package/docs/ja/ui/kbd.md +16 -0
- package/docs/ja/ui/pagination.md +36 -0
- package/docs/ja/ui/radio-group.md +21 -0
- package/docs/ja/ui/toast.md +46 -0
- package/docs/ja/ui-and-theming.md +14 -7
- package/package.json +13 -4
- package/registry/ui/accordion.tsx +76 -0
- package/registry/ui/alert-dialog.tsx +189 -0
- package/registry/ui/alert.tsx +80 -0
- package/registry/ui/app-shell.tsx +287 -0
- package/registry/ui/area-chart.tsx +3639 -0
- package/registry/ui/avatar.tsx +110 -0
- package/registry/ui/badge.tsx +56 -0
- package/registry/ui/bar-chart.tsx +3636 -0
- package/registry/ui/bar-list.tsx +3680 -0
- package/registry/ui/breadcrumb.tsx +128 -0
- package/registry/ui/button.tsx +62 -0
- package/registry/ui/calendar.tsx +223 -0
- package/registry/ui/card.tsx +107 -0
- package/registry/ui/category-bar.tsx +1255 -0
- package/registry/ui/chart-frame.tsx +1358 -0
- package/registry/ui/checkbox.tsx +30 -0
- package/registry/ui/collapsible.tsx +23 -0
- package/registry/ui/combobox.tsx +310 -0
- package/registry/ui/command.tsx +198 -0
- package/registry/ui/dashboard-card.tsx +217 -0
- package/registry/ui/data-table.tsx +693 -146
- package/registry/ui/date-range-picker.tsx +390 -0
- package/registry/ui/delta.tsx +188 -0
- package/registry/ui/dialog.tsx +161 -0
- package/registry/ui/donut-chart.tsx +3688 -0
- package/registry/ui/drawer.tsx +229 -0
- package/registry/ui/dropdown-menu.tsx +274 -0
- package/registry/ui/echart.tsx +890 -0
- package/registry/ui/field.tsx +240 -0
- package/registry/ui/filter-bar.tsx +392 -0
- package/registry/ui/funnel-steps.tsx +3541 -0
- package/registry/ui/heatmap.tsx +1752 -0
- package/registry/ui/hover-card.tsx +52 -0
- package/registry/ui/input-group.tsx +160 -0
- package/registry/ui/input.tsx +24 -0
- package/registry/ui/kbd.tsx +30 -0
- package/registry/ui/kpi-card.tsx +677 -0
- package/registry/ui/label.tsx +22 -0
- package/registry/ui/legend.tsx +3500 -0
- package/registry/ui/line-chart.tsx +3637 -0
- package/registry/ui/metric-value.tsx +62 -0
- package/registry/ui/multi-select.tsx +232 -0
- package/registry/ui/page-shell.tsx +282 -0
- package/registry/ui/pagination.tsx +140 -0
- package/registry/ui/placeholder.tsx +36 -0
- package/registry/ui/popover.tsx +92 -0
- package/registry/ui/progress-circle.tsx +867 -0
- package/registry/ui/progress.tsx +85 -0
- package/registry/ui/radio-group.tsx +39 -0
- package/registry/ui/sample-data.tsx +86 -0
- package/registry/ui/scatter-chart.tsx +4150 -0
- package/registry/ui/scroll-area.tsx +56 -0
- package/registry/ui/searchable-select.tsx +214 -0
- package/registry/ui/section-header.tsx +43 -0
- package/registry/ui/segmented-control.tsx +76 -0
- package/registry/ui/select.tsx +255 -0
- package/registry/ui/separator.tsx +27 -0
- package/registry/ui/sheet.tsx +139 -0
- package/registry/ui/sidebar.tsx +725 -0
- package/registry/ui/skeleton.tsx +17 -0
- package/registry/ui/slider.tsx +56 -0
- package/registry/ui/sparkline.tsx +230 -0
- package/registry/ui/spinner.tsx +14 -0
- package/registry/ui/states.tsx +90 -0
- package/registry/ui/status-badge.tsx +121 -0
- package/registry/ui/switch.tsx +34 -0
- package/registry/ui/table.tsx +118 -0
- package/registry/ui/tabs.tsx +84 -0
- package/registry/ui/textarea.tsx +22 -0
- package/registry/ui/toast.tsx +250 -0
- package/registry/ui/toggle-group.tsx +91 -0
- package/registry/ui/toggle.tsx +47 -0
- package/registry/ui/tooltip.tsx +68 -0
- package/registry/ui/tracker.tsx +843 -0
- package/registry/ui/trend-indicator.tsx +74 -0
- package/registry/ui/updated-at.tsx +122 -0
- package/registry/ui/waterfall-chart.tsx +4186 -0
- package/skills/vantage-add-feature/SKILL.md +9 -7
- package/skills/vantage-pitfalls/SKILL.md +5 -1
- package/templates/AGENTS.md +22 -1
- package/templates/agents/csv.md +2 -1
- package/templates/agents/doc.md +4 -3
- package/templates/agents/page.md +20 -6
- package/templates/agents/xlsx.md +2 -1
- package/theme.css +237 -136
- package/dist/add-DY4AXANK.js +0 -6
- package/dist/add-DY4AXANK.js.map +0 -1
- package/dist/chunk-5ZOP4SQR.js.map +0 -1
- package/dist/chunk-A2UUGASH.js.map +0 -1
- package/dist/chunk-DTDVSFRY.js.map +0 -1
- package/dist/chunk-LMUACBMA.js.map +0 -1
- package/dist/chunk-NKFBFDRZ.js +0 -2241
- package/dist/chunk-NKFBFDRZ.js.map +0 -1
- package/dist/chunk-PVTHHV7X.js.map +0 -1
- package/dist/chunk-PXRX5PEC.js.map +0 -1
- package/dist/chunk-QI3XQKHS.js.map +0 -1
- package/dist/chunk-RPZAALCX.js.map +0 -1
- package/dist/chunk-VA776YE5.js +0 -316
- package/dist/chunk-VA776YE5.js.map +0 -1
- package/dist/dev-GDKATCC7.js.map +0 -1
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Tracker
|
|
2
|
+
|
|
3
|
+
> 期間ごとの状態を小さなブロックの列で示す。稼働状況やバッチの結果に。
|
|
4
|
+
|
|
5
|
+
1 期間 = 1 ブロックで状態を色分けして並べます。日ごとの稼働状況・バッチの成否・日次目標の
|
|
6
|
+
達成 / 未達のような**連続した状態**に向きます。ブロックにホバーすると `tooltip` が出ます。
|
|
7
|
+
ECharts を使わない HTML で、配色はテーマに追従します。
|
|
8
|
+
|
|
9
|
+
```tsx
|
|
10
|
+
import { Tracker } from "@squadbase/vantage/components";
|
|
11
|
+
import type { TrackerBlock, ChartColor } from "@squadbase/vantage/components";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
| Prop | Type | Default | 説明 |
|
|
15
|
+
| --- | --- | --- | --- |
|
|
16
|
+
| `data` | `TrackerBlock[]` | | `{ color?: ChartColor; tooltip?: string; key?: string \| number }` の配列。**必須**。左から古い順。 |
|
|
17
|
+
| `defaultColor` | `ChartColor` | | `color` の無いブロックの色。既定は muted-foreground を淡くした灰色(データ無し・未実行に)。 |
|
|
18
|
+
| `hoverEffect` | `boolean` | `true` | ホバー中のブロックを薄くする。 |
|
|
19
|
+
| `className` | `string` | | 足すクラス。高さは既定 `h-8`。 |
|
|
20
|
+
|
|
21
|
+
残りの props は外側の `<div>` にそのまま渡ります。
|
|
22
|
+
|
|
23
|
+
## 状態に色を割り当てる
|
|
24
|
+
|
|
25
|
+
`color` はトークン名か CSS カラーです。失敗に `var(--destructive)` を使うと、テーマの
|
|
26
|
+
破壊的操作の色と揃います。
|
|
27
|
+
|
|
28
|
+
```tsx
|
|
29
|
+
const COLOR = { ok: "chart-2", warn: "chart-3", error: "var(--destructive)" } as const;
|
|
30
|
+
|
|
31
|
+
<Tracker data={days.map((d) => ({ color: COLOR[d.status], tooltip: `${d.date} ${d.label}` }))} />
|
|
32
|
+
```
|
|
@@ -1,6 +1,22 @@
|
|
|
1
1
|
# TrendIndicator
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> 非推奨。新規は Delta を使う。増減の矢印と変化率。
|
|
4
|
+
|
|
5
|
+
> [!WARNING]
|
|
6
|
+
> **非推奨です。新規のコードでは [`Delta`](parts/delta) を使ってください。**
|
|
7
|
+
> `TrendIndicator` は向き(`direction`)と色を手で渡すため、値と矢印が食い違うことがあります。`Delta` は今期と
|
|
8
|
+
> 比較相手の値から向き・率・色・ラベルを計算します。KPI をカードで見せるなら
|
|
9
|
+
> [`KpiCard`](parts/kpi-card) を使います。
|
|
10
|
+
|
|
11
|
+
```tsx
|
|
12
|
+
// 旧
|
|
13
|
+
<TrendIndicator value={12.4} direction="up" />
|
|
14
|
+
<TrendIndicator value={0.4} direction="down" positiveIsGood={false} />
|
|
15
|
+
|
|
16
|
+
// 新
|
|
17
|
+
<Delta value={1_240_000} comparison={{ previous: 1_103_000, vs: "prior-period" }} />
|
|
18
|
+
<Delta value={0.021} comparison={{ previous: 0.026, vs: "prior-period" }} polarity="lower-is-better" />
|
|
19
|
+
```
|
|
4
20
|
|
|
5
21
|
前期比などの変化を、矢印と変化率で示します。**「上がった=良い」とは限らない**ので、色は
|
|
6
22
|
`direction` と `positiveIsGood` の組み合わせで決まります — 解約率のように下がる方が良い指標では
|
package/docs/ja/routing.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# ファイルベースルーティング
|
|
2
2
|
|
|
3
|
-
> ファイルを置くだけでルートが生まれる。ページ・レイアウト・動的パラメータ・404/error
|
|
3
|
+
> ファイルを置くだけでルートが生まれる。ページ・レイアウト・動的パラメータ・404/error の規約。
|
|
4
4
|
|
|
5
5
|
Vantage のルーティングは **ファイルの配置がそのまま URL** になります。ルーターの設定は書きません。
|
|
6
6
|
|
|
@@ -46,92 +46,13 @@ Vantage のルーティングは **ファイルの配置がそのまま URL**
|
|
|
46
46
|
|
|
47
47
|
## tsx 以外もページになる
|
|
48
48
|
|
|
49
|
-
ルートになるのは `.tsx` / `.jsx`
|
|
50
|
-
|
|
51
|
-
tsx
|
|
49
|
+
ルートになるのは `.tsx` / `.jsx` だけではありません。**`<name>.slide.tsx`** はスライドデッキに、
|
|
50
|
+
**`<name>.doc.tsx`** はドキュメントに、**`.csv` と `.xlsx`** はそのまま表として読めるページに
|
|
51
|
+
なります。どれも URL の作り方は tsx と同じで、`.slide` / `.doc` と拡張子は URL に出ません
|
|
52
|
+
(`june.slide.tsx`・`june.csv` → `/june`)。`vantage routes` にも `useRoutes()` のナビにも同格で並びます。
|
|
52
53
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
`src/data/june.xlsx` を置いて `/data/june` を開くと、ダウンロードせずブラウザ上で表として
|
|
56
|
-
読めます。xlsx は複数シートを切り替えられ、元ファイルをダウンロードする導線も付きます。
|
|
57
|
-
|
|
58
|
-
描かれるのは**表計算ソフトそのものの見た目**です —— 列は A / B / C、左に行番号、ファイルの
|
|
59
|
-
1 行目はヘッダとして固定され、罫線はデータの外まで続きます。シートのタブは下端に並びます。
|
|
60
|
-
読み取り専用なので編集もソートもできません(セルを選んで `Cmd/Ctrl+C` でコピーはできます)。
|
|
61
|
-
並べ替えや絞り込みが要るデータは、`server/api/` から配って `DataTable` で描いてください。
|
|
62
|
-
|
|
63
|
-
- **タイトルはファイル名から導かれます**(`june.xlsx` → 「June」、`index.csv` はディレクトリ名)。
|
|
64
|
-
データファイルに `definePage` は書けないので、名前を変えたいときはファイルをリネームします。
|
|
65
|
-
- **パースはブラウザで行われます。** dev・ビルド後・デプロイ後で同じコードが同じバイトを読むので、
|
|
66
|
-
同じ URL が同じものを返します。25MB を超えるファイルはそのページにエラーが出ます
|
|
67
|
-
(`vantage check` が `FILE_PAGE_TOO_LARGE` で先に警告します)。
|
|
68
|
-
- 数式・グラフ・セル書式は再現されません。**値として読めれば十分**という設計です。
|
|
69
|
-
- ページにしたくないファイルは `_` を前置します(`_june.xlsx`)。tsx から自分で描きたいときは
|
|
70
|
-
こうしてルート化を止め、`@squadbase/vantage/table` の `FilePageView` を使います。
|
|
71
|
-
|
|
72
|
-
> [!WARNING]
|
|
73
|
-
> **ビューアの無い拡張子はルートになりません。** `.xls` / `.ods` / `.tsv` などを置いても
|
|
74
|
-
> 404 にすらならず、ナビにも `vantage routes` にも出ません。`vantage check` の
|
|
75
|
-
> `UNSUPPORTED_PAGE_FILE` 警告が唯一の告知点です。
|
|
76
|
-
|
|
77
|
-
### スライド(`.slide.tsx`)
|
|
78
|
-
|
|
79
|
-
`.slide` は**ページ種別サフィックス**で、URL には出ません(`src/june.slide.tsx` → `/june`)。
|
|
80
|
-
中身は `<SlideDeck>` を返す普通の React コンポーネントなので、`definePage` もナビも
|
|
81
|
-
通常のページと同じように効きます。
|
|
82
|
-
|
|
83
|
-
```tsx
|
|
84
|
-
import { definePage } from "@squadbase/vantage";
|
|
85
|
-
import { Slide, SlideDeck } from "@squadbase/vantage/slide";
|
|
86
|
-
|
|
87
|
-
export const page = definePage({ title: "6月度レビュー", navLabel: "6月度" });
|
|
88
|
-
|
|
89
|
-
export default function Deck() {
|
|
90
|
-
return (
|
|
91
|
-
<SlideDeck>
|
|
92
|
-
<Slide>…</Slide>
|
|
93
|
-
<Slide>…</Slide>
|
|
94
|
-
</SlideDeck>
|
|
95
|
-
);
|
|
96
|
-
}
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
1920×1080 の固定キャンバスに書き、画面サイズに合わせて縮小されます。キーボードとクリックで
|
|
100
|
-
送れ、左のスライド一覧は `L` で開閉、`F` で全画面、ツールバーから pptx を書き出せます。詳しくは
|
|
101
|
-
[UI とテーマ](ui-and-theming)。
|
|
102
|
-
|
|
103
|
-
> [!WARNING]
|
|
104
|
-
> `.slide` を付けられるのは**ルートになるページモジュールだけ**です。`_layout.slide.tsx` や
|
|
105
|
-
> `deck.slide.ts` は `INVALID_PAGE_VARIANT` エラーになります。また `june.slide.tsx` と
|
|
106
|
-
> `june.tsx`、`sales.csv` と `sales.tsx` はいずれも同じ URL に解決するので `ROUTE_CONFLICT` です。
|
|
107
|
-
|
|
108
|
-
### ドキュメント(`.doc.tsx`)
|
|
109
|
-
|
|
110
|
-
`.doc` も**ページ種別サフィックス**です(`src/june-summary.doc.tsx` → `/june-summary`)。上から下へ
|
|
111
|
-
読む文章のページで、中身は `<Document>` を返す普通の React コンポーネントです。
|
|
112
|
-
|
|
113
|
-
```tsx
|
|
114
|
-
import { definePage } from "@squadbase/vantage";
|
|
115
|
-
import { Document } from "@squadbase/vantage/doc";
|
|
116
|
-
|
|
117
|
-
export const page = definePage({ title: "6月度サマリー" });
|
|
118
|
-
|
|
119
|
-
export default function JuneSummary() {
|
|
120
|
-
return (
|
|
121
|
-
<Document>
|
|
122
|
-
<h1>6月度サマリー</h1>
|
|
123
|
-
<p>6月の売上は目標を 5% 上回りました。</p>
|
|
124
|
-
<table>…</table>
|
|
125
|
-
</Document>
|
|
126
|
-
);
|
|
127
|
-
}
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
`<Document>` の中の見出し・段落・リスト・表・引用・コードには、クラスを書かなくてもスタイルが
|
|
131
|
-
当たります。詳しくは [UI とテーマ](ui-and-theming)。右下の「PDF として保存」ボタン(ブラウザの
|
|
132
|
-
言語が日本語以外なら「Save as PDF」)から印刷ダイアログを開けます。印刷されるのはドキュメントの本文
|
|
133
|
-
だけで、アプリのヘッダーやサイドバーは載らず、ダークモードでもライトの配色で出ます。`.slide` と
|
|
134
|
-
同じく、`.doc` を付けられるのはルートになるページモジュールだけです。
|
|
54
|
+
それぞれの書き方・できること・制限、そして**置いてもページにならないファイル**(`.xls`・`.tsv`・
|
|
55
|
+
`.md` など)は [ページの種類](page-types) にまとめてあります。
|
|
135
56
|
|
|
136
57
|
## ルーティングされないディレクトリ
|
|
137
58
|
|
|
@@ -291,3 +212,4 @@ setSegments((prev) => [...prev, "enterprise"]);
|
|
|
291
212
|
## 次に読む
|
|
292
213
|
|
|
293
214
|
- [ページと definePage](pages-and-metadata) — ページの契約とメタデータ
|
|
215
|
+
- [ページの種類](page-types) — スライド・ドキュメント・CSV・Excel
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Alert Dialog
|
|
2
|
+
|
|
3
|
+
> 取り消せない操作の前に確認するモーダル。
|
|
4
|
+
|
|
5
|
+
削除など取り消せない操作の前に、ユーザーの明示的な返答を求めるモーダルです。
|
|
6
|
+
[`Dialog`](ui/dialog) と違い、背景のクリックでは閉じません。
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import {
|
|
10
|
+
AlertDialog,
|
|
11
|
+
AlertDialogTrigger,
|
|
12
|
+
AlertDialogContent,
|
|
13
|
+
AlertDialogHeader,
|
|
14
|
+
AlertDialogMedia,
|
|
15
|
+
AlertDialogTitle,
|
|
16
|
+
AlertDialogDescription,
|
|
17
|
+
AlertDialogFooter,
|
|
18
|
+
AlertDialogCancel,
|
|
19
|
+
AlertDialogAction,
|
|
20
|
+
} from "@squadbase/vantage/ui";
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## パーツ
|
|
24
|
+
|
|
25
|
+
| パーツ | 役割 |
|
|
26
|
+
| --- | --- |
|
|
27
|
+
| `AlertDialog` | 状態。`open` / `defaultOpen` / `onOpenChange` |
|
|
28
|
+
| `AlertDialogTrigger` | 開くきっかけ。`render` でボタンにする |
|
|
29
|
+
| `AlertDialogContent` | 本体。`size` で幅を選ぶ |
|
|
30
|
+
| `AlertDialogMedia` | 見出し横のアイコン枠 |
|
|
31
|
+
| `AlertDialogHeader` / `AlertDialogTitle` / `AlertDialogDescription` | 見出し |
|
|
32
|
+
| `AlertDialogFooter` | ボタン行 |
|
|
33
|
+
| `AlertDialogCancel` | 閉じるボタン(既定 `variant="outline"`) |
|
|
34
|
+
| `AlertDialogAction` | 実行ボタン。`Button` の props をそのまま取る |
|
|
35
|
+
|
|
36
|
+
| Prop | Type | Default | 説明 |
|
|
37
|
+
| --- | --- | --- | --- |
|
|
38
|
+
| `size` | `"default" \| "sm"` | `"default"` | `AlertDialogContent` に渡す。`sm` はボタンを 2 列に並べる。 |
|
|
39
|
+
|
|
40
|
+
`AlertDialogAction` は**押しても自動では閉じません**。処理が終わったら `open` を `false` に
|
|
41
|
+
するか、閉じてよいなら `AlertDialogCancel` と同じく `render` で包んでください。
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# Avatar
|
|
2
|
+
|
|
3
|
+
> ユーザーの顔写真またはイニシャル。
|
|
4
|
+
|
|
5
|
+
ユーザーやオーナーを小さな丸で示します。画像が読み込めないとき・`src` が無いときは
|
|
6
|
+
`AvatarFallback` の中身(イニシャルなど)を出します。
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import {
|
|
10
|
+
Avatar,
|
|
11
|
+
AvatarImage,
|
|
12
|
+
AvatarFallback,
|
|
13
|
+
AvatarBadge,
|
|
14
|
+
AvatarGroup,
|
|
15
|
+
AvatarGroupCount,
|
|
16
|
+
} from "@squadbase/vantage/ui";
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## パーツ
|
|
20
|
+
|
|
21
|
+
| パーツ | 役割 |
|
|
22
|
+
| --- | --- |
|
|
23
|
+
| `Avatar` | 外枠。`size` で大きさを選ぶ |
|
|
24
|
+
| `AvatarImage` | 画像。読み込みに失敗すると描画されない |
|
|
25
|
+
| `AvatarFallback` | 画像が無いときの中身 |
|
|
26
|
+
| `AvatarBadge` | 右下の小さな丸(オンライン表示など) |
|
|
27
|
+
| `AvatarGroup` / `AvatarGroupCount` | 重ねて並べる。`AvatarGroupCount` は「+4」などの残数 |
|
|
28
|
+
|
|
29
|
+
| Prop | Type | Default | 説明 |
|
|
30
|
+
| --- | --- | --- | --- |
|
|
31
|
+
| `size` | `"default" \| "sm" \| "lg"` | `"default"` | `Avatar` に渡す。`sm` は 24px、`default` は 32px、`lg` は 40px。 |
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Combobox
|
|
2
|
+
|
|
3
|
+
> 入力して候補を絞り込むセレクト。
|
|
4
|
+
|
|
5
|
+
テキストを打って候補を絞り込み、1 つ(または複数)を選ぶ入力です。候補が数件なら
|
|
6
|
+
[`Select`](ui/select) のほうが手数が少なくて済みます。Base UI の `Combobox` の上に
|
|
7
|
+
作っています。
|
|
8
|
+
|
|
9
|
+
```tsx
|
|
10
|
+
import {
|
|
11
|
+
Combobox,
|
|
12
|
+
ComboboxInput,
|
|
13
|
+
ComboboxContent,
|
|
14
|
+
ComboboxEmpty,
|
|
15
|
+
ComboboxList,
|
|
16
|
+
ComboboxItem,
|
|
17
|
+
ComboboxGroup,
|
|
18
|
+
ComboboxLabel,
|
|
19
|
+
ComboboxCollection,
|
|
20
|
+
ComboboxSeparator,
|
|
21
|
+
ComboboxChips,
|
|
22
|
+
ComboboxChip,
|
|
23
|
+
ComboboxChipsInput,
|
|
24
|
+
ComboboxTrigger,
|
|
25
|
+
ComboboxValue,
|
|
26
|
+
useComboboxAnchor,
|
|
27
|
+
} from "@squadbase/vantage/ui";
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## パーツ
|
|
31
|
+
|
|
32
|
+
| パーツ | 役割 |
|
|
33
|
+
| --- | --- |
|
|
34
|
+
| `Combobox` | 状態。`items` / `value` / `defaultValue` / `onValueChange` / `multiple` |
|
|
35
|
+
| `ComboboxInput` | 入力欄。`showTrigger`(既定 `true`)/ `showClear` で右端のボタンを出す |
|
|
36
|
+
| `ComboboxContent` | 候補のポップアップ。`side` / `align` / `anchor` |
|
|
37
|
+
| `ComboboxList` | 候補の並び。子に関数を渡すと、絞り込み後の `items` が 1 件ずつ渡る |
|
|
38
|
+
| `ComboboxItem` | 1 候補。`value` は必須 |
|
|
39
|
+
| `ComboboxEmpty` | 一致する候補が無いときの表示 |
|
|
40
|
+
| `ComboboxGroup` / `ComboboxLabel` / `ComboboxCollection` / `ComboboxSeparator` | グループ分け |
|
|
41
|
+
| `ComboboxChips` / `ComboboxChip` / `ComboboxChipsInput` | 複数選択をチップで見せる |
|
|
42
|
+
| `ComboboxTrigger` / `ComboboxValue` | 入力欄を使わずボタンで開く形 |
|
|
43
|
+
| `useComboboxAnchor` | チップ枠をポップアップの基準にするための ref |
|
|
44
|
+
|
|
45
|
+
| Prop | Type | Default | 説明 |
|
|
46
|
+
| --- | --- | --- | --- |
|
|
47
|
+
| `items` | `readonly unknown[]` | | `Combobox` に渡す候補。入力に応じて絞り込まれ、`ComboboxList` の関数に渡る。 |
|
|
48
|
+
| `multiple` | `boolean` | `false` | 複数選択にする。 |
|
|
49
|
+
| `onValueChange` | `(value) => void` | | 選択が変わったとき。単一選択では未選択の `null` も渡りうる。 |
|
|
50
|
+
|
|
51
|
+
## 複数選択
|
|
52
|
+
|
|
53
|
+
`multiple` を付け、`ComboboxChips` の中にチップと `ComboboxChipsInput` を置きます。ポップアップを
|
|
54
|
+
チップ枠の幅に合わせるには `useComboboxAnchor()` の ref を両方に渡します。
|
|
55
|
+
|
|
56
|
+
```tsx
|
|
57
|
+
const anchor = useComboboxAnchor();
|
|
58
|
+
|
|
59
|
+
<Combobox items={metrics} multiple>
|
|
60
|
+
<ComboboxChips ref={anchor}>
|
|
61
|
+
<ComboboxValue>
|
|
62
|
+
{(values: string[]) =>
|
|
63
|
+
values.map((v) => <ComboboxChip key={v}>{v}</ComboboxChip>)
|
|
64
|
+
}
|
|
65
|
+
</ComboboxValue>
|
|
66
|
+
<ComboboxChipsInput placeholder="指標を追加" />
|
|
67
|
+
</ComboboxChips>
|
|
68
|
+
<ComboboxContent anchor={anchor}>
|
|
69
|
+
<ComboboxList>
|
|
70
|
+
{(item: string) => <ComboboxItem key={item} value={item}>{item}</ComboboxItem>}
|
|
71
|
+
</ComboboxList>
|
|
72
|
+
</ComboboxContent>
|
|
73
|
+
</Combobox>;
|
|
74
|
+
```
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Drawer
|
|
2
|
+
|
|
3
|
+
> 画面の端からスワイプで出し入れするパネル。
|
|
4
|
+
|
|
5
|
+
画面の下(または上下左右)から出てくるパネルです。スワイプで閉じられるので、モバイルでの
|
|
6
|
+
詳細表示やアクション一覧に向いています。デスクトップで広い面積のフォームを出すなら
|
|
7
|
+
[`Sheet`](ui/sheet) が素直です。Base UI の `Drawer` の上に作っています。
|
|
8
|
+
|
|
9
|
+
```tsx
|
|
10
|
+
import {
|
|
11
|
+
Drawer,
|
|
12
|
+
DrawerTrigger,
|
|
13
|
+
DrawerContent,
|
|
14
|
+
DrawerHeader,
|
|
15
|
+
DrawerTitle,
|
|
16
|
+
DrawerDescription,
|
|
17
|
+
DrawerFooter,
|
|
18
|
+
DrawerClose,
|
|
19
|
+
} from "@squadbase/vantage/ui";
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## パーツ
|
|
23
|
+
|
|
24
|
+
| パーツ | 役割 |
|
|
25
|
+
| --- | --- |
|
|
26
|
+
| `Drawer` | 状態。`open` / `defaultOpen` / `onOpenChange`、向き、スナップポイント |
|
|
27
|
+
| `DrawerTrigger` | 開くきっかけ。`render` でボタンにする |
|
|
28
|
+
| `DrawerContent` | 本体。オーバーレイとポータルを内包する |
|
|
29
|
+
| `DrawerHeader` / `DrawerTitle` / `DrawerDescription` | 見出し |
|
|
30
|
+
| `DrawerFooter` | ボタン行 |
|
|
31
|
+
| `DrawerClose` | 閉じるトリガー |
|
|
32
|
+
|
|
33
|
+
| Prop | Type | Default | 説明 |
|
|
34
|
+
| --- | --- | --- | --- |
|
|
35
|
+
| `swipeDirection` | `"down" \| "up" \| "left" \| "right"` | `"down"` | `Drawer` に渡す。閉じるときにスワイプする向き(= 出てくる端)。 |
|
|
36
|
+
| `showSwipeHandle` | `boolean` | `false` | `Drawer` に渡す。つまみ(ハンドル)を表示する。 |
|
|
37
|
+
| `snapPoints` | `(number \| string)[]` | | `Drawer` に渡す。途中で止まる高さ(`0.5` や `"20rem"`)。 |
|
|
38
|
+
| `modal` | `boolean` | `true` | `Drawer` に渡す。`false` で背景を操作可能にし、オーバーレイを出さない。 |
|
|
39
|
+
|
|
40
|
+
`DrawerTitle` は支援技術のために必須です。見せたくない場合も置いた上で `className="sr-only"` に
|
|
41
|
+
してください。
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Field
|
|
2
|
+
|
|
3
|
+
> ラベル・説明・エラーを入力と束ねるフォームのレイアウト部品。
|
|
4
|
+
|
|
5
|
+
入力 1 つぶんのラベル・補足説明・エラーメッセージを、決まった間隔と向きで並べる部品です。
|
|
6
|
+
入力そのものは [`Input`](ui/input) や [`Switch`](ui/switch) などを
|
|
7
|
+
中に置きます。
|
|
8
|
+
|
|
9
|
+
```tsx
|
|
10
|
+
import {
|
|
11
|
+
Field,
|
|
12
|
+
FieldLabel,
|
|
13
|
+
FieldDescription,
|
|
14
|
+
FieldError,
|
|
15
|
+
FieldContent,
|
|
16
|
+
FieldTitle,
|
|
17
|
+
FieldGroup,
|
|
18
|
+
FieldSet,
|
|
19
|
+
FieldLegend,
|
|
20
|
+
FieldSeparator,
|
|
21
|
+
} from "@squadbase/vantage/ui";
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## パーツ
|
|
25
|
+
|
|
26
|
+
| パーツ | 役割 |
|
|
27
|
+
| --- | --- |
|
|
28
|
+
| `Field` | 入力 1 つぶんの外枠。`orientation` で並び方を選ぶ |
|
|
29
|
+
| `FieldLabel` | ラベル(`Label` を使う)。`htmlFor` で入力と結ぶ |
|
|
30
|
+
| `FieldDescription` | 補足説明 |
|
|
31
|
+
| `FieldError` | エラー。`children` か `errors`(`{ message }[]`)を渡す。空なら描画しない |
|
|
32
|
+
| `FieldContent` | 横並びのときにラベルと説明をまとめる列 |
|
|
33
|
+
| `FieldTitle` | `<label>` ではない見出し |
|
|
34
|
+
| `FieldGroup` | 複数の `Field` を縦に並べる |
|
|
35
|
+
| `FieldSet` / `FieldLegend` | `<fieldset>` / `<legend>` |
|
|
36
|
+
| `FieldSeparator` | 区切り線。中に文字も置ける |
|
|
37
|
+
|
|
38
|
+
| Prop | Type | Default | 説明 |
|
|
39
|
+
| --- | --- | --- | --- |
|
|
40
|
+
| `orientation` | `"vertical" \| "horizontal" \| "responsive"` | `"vertical"` | `Field` に渡す。`responsive` はコンテナ幅が広いときだけ横並びにする。 |
|
|
41
|
+
| `data-invalid` | `boolean` | | `Field` に付けるとラベルと説明がエラー色になる。入力には `aria-invalid` を付ける。 |
|
|
42
|
+
| `errors` | `Array<{ message?: string } \| undefined>` | | `FieldError` に渡す。複数あれば箇条書きにし、重複は 1 つにまとめる。 |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Hover Card
|
|
2
|
+
|
|
3
|
+
> リンクにホバーすると出るプレビューカード。
|
|
4
|
+
|
|
5
|
+
リンクや用語にポインタを載せたとき(キーボードではフォーカスしたとき)に、補足の内容を
|
|
6
|
+
カードで見せます。指標の定義やユーザーのプロフィールなど、**読むだけ**の情報向けです。
|
|
7
|
+
操作を伴うなら [`Popover`](ui/popover)、短い一言なら
|
|
8
|
+
[`Tooltip`](ui/tooltip) を使ってください。Base UI の `PreviewCard` の上に作っています。
|
|
9
|
+
|
|
10
|
+
```tsx
|
|
11
|
+
import { HoverCard, HoverCardTrigger, HoverCardContent } from "@squadbase/vantage/ui";
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
`HoverCardTrigger` は既定で `<a>` を描画します。別の要素にしたい場合は `render` を渡します。
|
|
15
|
+
|
|
16
|
+
| Prop | Type | Default | 説明 |
|
|
17
|
+
| --- | --- | --- | --- |
|
|
18
|
+
| `side` | `"top" \| "right" \| "bottom" \| "left"` | `"bottom"` | `HoverCardContent` に渡す。トリガーのどちら側に出すか。 |
|
|
19
|
+
| `align` | `"start" \| "center" \| "end"` | `"center"` | `HoverCardContent` に渡す。 |
|
|
20
|
+
| `sideOffset` | `number` | `4` | `HoverCardContent` とトリガーの距離(px)。 |
|
|
21
|
+
| `delay` | `number` | `600` | `HoverCardTrigger` に渡す。開くまでのミリ秒。 |
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# Kbd
|
|
2
|
+
|
|
3
|
+
> キーボードのキー表示。
|
|
4
|
+
|
|
5
|
+
ショートカットキーを表示するための小さな部品です。複数のキーは `KbdGroup` で並べます。
|
|
6
|
+
|
|
7
|
+
```tsx
|
|
8
|
+
import { Kbd, KbdGroup } from "@squadbase/vantage/ui";
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
| Prop | Type | 説明 |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| `Kbd` | `ComponentProps<"kbd">` | 1 つのキー。 |
|
|
14
|
+
| `KbdGroup` | `ComponentProps<"div">` | キーを横に並べる。 |
|
|
15
|
+
|
|
16
|
+
ボタンや [`Tooltip`](ui/tooltip) の中に置くと、周りの文字色に合わせて馴染みます。
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# Pagination
|
|
2
|
+
|
|
3
|
+
> ページ送りのリンク列。
|
|
4
|
+
|
|
5
|
+
一覧をページに分けたときのページ送りです。見た目だけの部品で、現在ページや総ページ数は
|
|
6
|
+
持ちません — 状態は呼び出し側(URL の検索パラメータや `useState`)で管理します。
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import {
|
|
10
|
+
Pagination,
|
|
11
|
+
PaginationContent,
|
|
12
|
+
PaginationItem,
|
|
13
|
+
PaginationLink,
|
|
14
|
+
PaginationPrevious,
|
|
15
|
+
PaginationNext,
|
|
16
|
+
PaginationEllipsis,
|
|
17
|
+
} from "@squadbase/vantage/ui";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## パーツ
|
|
21
|
+
|
|
22
|
+
| パーツ | 役割 |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `Pagination` | `<nav>`。`aria-label="pagination"` 付き |
|
|
25
|
+
| `PaginationContent` / `PaginationItem` | `<ul>` / `<li>` |
|
|
26
|
+
| `PaginationLink` | 1 ページ分の `<a>`。`isActive` で現在ページを示す |
|
|
27
|
+
| `PaginationPrevious` / `PaginationNext` | 前後への `<a>`。`text` で文言を変える |
|
|
28
|
+
| `PaginationEllipsis` | 省略記号 |
|
|
29
|
+
|
|
30
|
+
| Prop | Type | Default | 説明 |
|
|
31
|
+
| --- | --- | --- | --- |
|
|
32
|
+
| `isActive` | `boolean` | | `PaginationLink` に渡す。`aria-current="page"` と枠線付きの見た目になる。 |
|
|
33
|
+
| `text` | `string` | `"Previous" / "Next"` | `PaginationPrevious` / `PaginationNext` のラベル(640px 未満では隠れる)。 |
|
|
34
|
+
|
|
35
|
+
リンクは素の `<a>` なので、`href` を渡すとそのまま遷移します。画面内の状態だけを変えたい場合は
|
|
36
|
+
`onClick` で `preventDefault()` してください。
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Radio Group
|
|
2
|
+
|
|
3
|
+
> 少数の選択肢から 1 つを選ぶラジオボタン。
|
|
4
|
+
|
|
5
|
+
選択肢をすべて見せたまま 1 つ選ばせる入力です。選択肢が多いときは
|
|
6
|
+
[`Select`](ui/select)、横並びのボタンで切り替えたいときは
|
|
7
|
+
[`SegmentedControl`](parts/segmented-control) を検討してください。
|
|
8
|
+
|
|
9
|
+
```tsx
|
|
10
|
+
import { RadioGroup, RadioGroupItem } from "@squadbase/vantage/ui";
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
`RadioGroupItem` 自体はラベルを持ちません。`id` を振って [`Label`](ui/label) の
|
|
14
|
+
`htmlFor` と結んでください。
|
|
15
|
+
|
|
16
|
+
| Prop | Type | 説明 |
|
|
17
|
+
| --- | --- | --- |
|
|
18
|
+
| `value` | `unknown` | `RadioGroup` の選択値(制御)。 |
|
|
19
|
+
| `defaultValue` | `unknown` | `RadioGroup` の初期値(非制御)。 |
|
|
20
|
+
| `onValueChange` | `(value: unknown) => void` | `RadioGroup` に渡す。選ばれた `RadioGroupItem` の `value` を受け取る。 |
|
|
21
|
+
| `disabled` | `boolean` | グループ全体、または項目単位で無効にする。 |
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Toast
|
|
2
|
+
|
|
3
|
+
> 画面の隅に一時的に出る通知。
|
|
4
|
+
|
|
5
|
+
保存完了や失敗など、操作の結果を短く知らせる通知です。Base UI の `Toast` の上に作っており、
|
|
6
|
+
`sonner` には依存しません。
|
|
7
|
+
|
|
8
|
+
```tsx
|
|
9
|
+
import { Toaster, toast } from "@squadbase/vantage/ui";
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## 使い方
|
|
13
|
+
|
|
14
|
+
アプリのルート付近を **`Toaster` で 1 度だけ包み**、どこからでも `toast.add()` を呼びます。
|
|
15
|
+
`Toaster` は子要素を描画したうえで、画面右下(モバイルでは下部中央)に通知の置き場を出します。
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
<Toaster>
|
|
19
|
+
<App />
|
|
20
|
+
</Toaster>;
|
|
21
|
+
|
|
22
|
+
toast.add({ title: "レポートを保存しました", type: "success" });
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
`toast` はモジュール単位で 1 つ作られたマネージャで、`add` / `close` / `update` / `promise` を
|
|
26
|
+
持ちます。
|
|
27
|
+
|
|
28
|
+
| Prop | Type | Default | 説明 |
|
|
29
|
+
| --- | --- | --- | --- |
|
|
30
|
+
| `title` | `ReactNode` | | 見出し。 |
|
|
31
|
+
| `description` | `ReactNode` | | 本文。 |
|
|
32
|
+
| `type` | `"success" \| "info" \| "warning" \| "error" \| "loading" \| string` | | 左に出すアイコンを決める。省略するとアイコン無し。 |
|
|
33
|
+
| `timeout` | `number` | `5000` | 自動で閉じるまでのミリ秒。`0` で閉じない。 |
|
|
34
|
+
| `actionProps` | `ButtonProps` | | 指定するとアクションボタンを出す(`children` がラベル、`onClick` が処理)。 |
|
|
35
|
+
|
|
36
|
+
`toast.add()` は ID を返します。`toast.update(id, {...})` で中身を差し替え、
|
|
37
|
+
`toast.close(id)` で閉じます。非同期処理には `toast.promise(promise, { loading, success, error })`
|
|
38
|
+
が使えます。
|
|
39
|
+
|
|
40
|
+
> [!NOTE]
|
|
41
|
+
> shadcn/ui の `sonner` 版(`toast("…")` / `toast.success("…")`)とは呼び出し方が違います。
|
|
42
|
+
> こちらは shadcn/ui の Base UI 版 `toast` と同じ API です。
|
|
43
|
+
> `Toaster` の外で個別のマネージャが要るときは `createToastManager()` で作り、
|
|
44
|
+
> `<Toaster toastManager={manager}>` に渡します。部品(`Toast` / `ToastTitle` /
|
|
45
|
+
> `ToastDescription` / `ToastAction` / `ToastClose` / `ToastViewport` / `ToastPortal` /
|
|
46
|
+
> `ToastProvider`、`useToastManager`)を組み直して独自の並びも作れます。
|
|
@@ -32,11 +32,16 @@ export default function Overview() {
|
|
|
32
32
|
```
|
|
33
33
|
|
|
34
34
|
`/ui` にあるもの(抜粋): `Button`、`Card`、`Table` プリミティブ、`Tabs`、`Input` / `Select` /
|
|
35
|
-
`Checkbox` / `
|
|
36
|
-
`
|
|
35
|
+
`Checkbox` / `RadioGroup` / `Switch` / `Slider` / `Combobox` / `Field`、`Calendar`、`Dialog` /
|
|
36
|
+
`AlertDialog` / `Sheet` / `Drawer` / `Popover` / `HoverCard` / `Tooltip` / `DropdownMenu`、`Sidebar`、
|
|
37
|
+
`Pagination`、`Avatar`、`Kbd`、`Toaster` + `toast.add()`、`Alert` / `Skeleton` / `Spinner`、
|
|
38
|
+
`Loading` / `Empty` / `ErrorState`。
|
|
37
39
|
|
|
38
40
|
`/components` にあるもの(抜粋): `PageShell`、`AppShell`、`DashboardCard`、`DataTable`、
|
|
39
|
-
`
|
|
41
|
+
型付きチャート(`LineChart` / `AreaChart` / `BarChart` / `DonutChart` / `BarList` / `CategoryBar` /
|
|
42
|
+
`ProgressCircle` / `Tracker`)、`EChart`、`FunnelSteps`、`FilterBar`、`DateRangePicker`、`KpiCard`、
|
|
43
|
+
`Delta`。グラフはまず型付きチャートで描き、その props で表せない図(二軸・散布図・
|
|
44
|
+
ヒートマップなど)だけ `EChart` に `EChartsOption` を渡します。
|
|
40
45
|
|
|
41
46
|
各コンポーネントの props と使い方は [コンポーネント](components) タブにまとめてあります。
|
|
42
47
|
|
|
@@ -203,13 +208,15 @@ import { cn } from "@squadbase/vantage/ui";
|
|
|
203
208
|
コンポーネントの中身を自分のものにしたいときは、編集可能なソースを `components/` にコピーします。
|
|
204
209
|
|
|
205
210
|
```bash
|
|
206
|
-
vantage add ui data-table # 編集可能な DataTable をコピー
|
|
211
|
+
vantage add ui data-table # 編集可能な DataTable をコピー → components/ui/data-table.tsx
|
|
212
|
+
vantage add ui bar-chart # /components の部品も同じく add ui で取り出せる
|
|
207
213
|
vantage add block sales-overview
|
|
208
214
|
```
|
|
209
215
|
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
216
|
+
`/ui` のプリミティブも `/components` の部品も、すべて kebab-case の名前で `add ui` に渡せます
|
|
217
|
+
(各コンポーネントのページに取り込みコマンドがあります)。コピーの中の import は公開サブパス
|
|
218
|
+
(`@squadbase/vantage/ui` など)に書き換わっているので、そのまま動きます。使うだけならコピーは
|
|
219
|
+
要りません。import が既定です。
|
|
213
220
|
|
|
214
221
|
## 次に読む
|
|
215
222
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@squadbase/vantage",
|
|
3
|
-
"version": "0.6.2-dev1.
|
|
3
|
+
"version": "0.6.2-dev1.d7c0911",
|
|
4
4
|
"description": "Data dashboard framework for Squadbase Editor. Vite-powered, config-free, one-file first.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -108,8 +108,10 @@
|
|
|
108
108
|
"dev:types": "tsc --noEmit --watch",
|
|
109
109
|
"test": "vitest run",
|
|
110
110
|
"test:watch": "vitest",
|
|
111
|
-
"
|
|
112
|
-
"
|
|
111
|
+
"registry": "node scripts/gen-registry.mjs",
|
|
112
|
+
"registry:check": "node scripts/gen-registry.mjs --check",
|
|
113
|
+
"typecheck": "tsc --noEmit && tsc --noEmit -p tsconfig.registry.json",
|
|
114
|
+
"type-check": "tsc --noEmit && tsc --noEmit -p tsconfig.registry.json",
|
|
113
115
|
"prepublishOnly": "node scripts/build-docs.mjs && node scripts/build.mjs",
|
|
114
116
|
"release": "npm publish --@squadbase:registry=https://registry.npmjs.org",
|
|
115
117
|
"site:install": "npm --prefix site install",
|
|
@@ -147,9 +149,16 @@
|
|
|
147
149
|
},
|
|
148
150
|
"peerDependencies": {
|
|
149
151
|
"react": ">=18.2.0",
|
|
150
|
-
"react-dom": ">=18.2.0"
|
|
152
|
+
"react-dom": ">=18.2.0",
|
|
153
|
+
"typescript": ">=5.0.0"
|
|
154
|
+
},
|
|
155
|
+
"peerDependenciesMeta": {
|
|
156
|
+
"typescript": {
|
|
157
|
+
"optional": true
|
|
158
|
+
}
|
|
151
159
|
},
|
|
152
160
|
"devDependencies": {
|
|
161
|
+
"@squadbase/squadkit": "*",
|
|
153
162
|
"@types/node": "^22.10.0",
|
|
154
163
|
"@types/papaparse": "^5.5.2",
|
|
155
164
|
"@types/react": "^19.2.0",
|