@squadbase/vantage-template 0.1.1-dev2.224e848 → 0.1.1-dev2.7803570
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/README.md +12 -2
- package/base-template/.squadbase/skills/vantage-add-feature/SKILL.md +9 -7
- package/base-template/.squadbase/skills/vantage-app/SKILL.md +10 -6
- package/base-template/.squadbase/skills/vantage-design/SKILL.md +62 -52
- package/base-template/.squadbase/skills/vantage-design/references/extract.md +26 -27
- package/base-template/.squadbase/skills/vantage-design/references/format.md +12 -172
- package/base-template/.squadbase/skills/vantage-design/references/presets.md +50 -110
- package/base-template/.squadbase/skills/vantage-pitfalls/SKILL.md +50 -1
- package/base-template/.squadbase/skills/vantage-slide/SKILL.md +299 -0
- package/base-template/.squadbase/skills/vantage-slide/references/morph.md +102 -0
- package/base-template/.squadbase/skills/vantage-slide/references/steps.md +57 -0
- package/base-template/.squadbase/skills/vantage-slide/references/tokens.md +87 -0
- package/base-template/.squadbase/skills/vantage-slide/references/transitions.md +196 -0
- package/base-template/AGENTS.md +204 -17
- package/base-template/agents/api.md +29 -0
- package/base-template/agents/csv.md +2 -1
- package/base-template/agents/doc.md +52 -3
- package/base-template/agents/page.md +55 -10
- package/base-template/agents/slide.md +83 -4
- package/base-template/agents/xlsx.md +2 -1
- package/base-template/bun.lock +78 -68
- package/base-template/bunfig.toml +5 -0
- package/base-template/package.json +6 -6
- package/base-template/src/_layout.tsx +13 -6
- package/base-template/src/components/build-recovery.tsx +37 -1
- package/base-template/src/components/user-card.tsx +11 -11
- package/base-template/src/index.tsx +7 -3
- package/base-template/src/styles.css +108 -12
- package/dist/index.js +956 -0
- package/package.json +20 -17
- package/ui-templates/CLAUDE.md +2 -0
- package/ui-templates/kpi-chart-simple/pages/index.tsx +48 -48
- package/ui-templates/kpi-chart-simple-ja/pages/index.tsx +48 -48
- package/base-template/DESIGN.md +0 -108
|
@@ -25,6 +25,11 @@ export async function GET({ params, env }: ApiContext) {
|
|
|
25
25
|
エクスポートする。それ以外の名前は `INVALID_API_EXPORT` エラー。
|
|
26
26
|
- 動的 API も `[id].ts` 記法: `server/api/customers/[id].ts` → `GET /api/customers/:id`。
|
|
27
27
|
`params.id` で取り出す(`noUncheckedIndexedAccess` が効くので narrowing が要る)。
|
|
28
|
+
- **`noUncheckedIndexedAccess` は配列・レコードの添字すべてに効く。** `arr[0]` も `obj[key]` も
|
|
29
|
+
`T | undefined` になる。最初に書く前に、添字アクセスと `useApiQuery` の `data` が
|
|
30
|
+
undefined を扱っているかを頭の中で型検査してから書く。上流の生の応答の値は
|
|
31
|
+
`Number(row.metricValues?.[0]?.value ?? "0")` のように `?.` と `??` で取り出す
|
|
32
|
+
(`!` で黙らせない)。
|
|
28
33
|
- **クライアントに見せたいエラーは `HttpError(status, msg)` を throw する。** それ以外の throw は
|
|
29
34
|
ログに記録され汎用の 500 に丸められる。
|
|
30
35
|
- **シークレットは `ApiContext.env` にだけ届く**(クライアントには決して届かない)。
|
|
@@ -34,9 +39,12 @@ export async function GET({ params, env }: ApiContext) {
|
|
|
34
39
|
|
|
35
40
|
```tsx
|
|
36
41
|
import { useApiQuery, useApiMutation } from "@squadbase/vantage/query"
|
|
42
|
+
import { Loading, ErrorState } from "@squadbase/vantage/ui"
|
|
37
43
|
|
|
38
44
|
const q = useApiQuery<Customer>(`/api/customers/${customerId}`)
|
|
45
|
+
if (q.isPending) return <Loading />
|
|
39
46
|
if (q.isError) return <ErrorState message={q.error.message} /> // HttpError のメッセージ
|
|
47
|
+
q.data // ここで初めて Customer(undefined ではない)
|
|
40
48
|
|
|
41
49
|
// クエリ文字列は search で。undefined の項目は落ちる
|
|
42
50
|
const rows = useApiQuery<Row[]>("/api/customers", { search: { segment } })
|
|
@@ -45,5 +53,26 @@ const rows = useApiQuery<Row[]>("/api/customers", { search: { segment } })
|
|
|
45
53
|
const save = useApiMutation<Customer, Payload>("/api/customers", { method: "POST" })
|
|
46
54
|
```
|
|
47
55
|
|
|
56
|
+
**`data` は、同じ結果オブジェクトで `isPending` と `isError` を判定したあとでしか
|
|
57
|
+
narrowing されない。** 判定前や、配列の `.find` などでまとめた判定のあとでは `T | undefined` のまま。
|
|
58
|
+
複数のクエリは 1 本ずつ判定してから `data` を使う(`data!` で黙らせない):
|
|
59
|
+
|
|
60
|
+
```tsx
|
|
61
|
+
const sessions = useApiQuery<SessionsDaily[]>("/api/sessions-daily")
|
|
62
|
+
const metrics = useApiQuery<MetricsDaily[]>("/api/metrics-daily")
|
|
63
|
+
|
|
64
|
+
if (sessions.isPending || metrics.isPending) return <Loading />
|
|
65
|
+
if (sessions.isError) return <ErrorState message={sessions.error.message} />
|
|
66
|
+
if (metrics.isError) return <ErrorState message={metrics.error.message} />
|
|
67
|
+
// ここから sessions.data: SessionsDaily[] / metrics.data: MetricsDaily[]
|
|
68
|
+
return <Chart sessions={sessions.data} metrics={metrics.data} />
|
|
69
|
+
|
|
70
|
+
// NG: const failed = [sessions, metrics].find((q) => q.isError) のように配列でまとめて判定すると
|
|
71
|
+
// 各 q.data は narrowing されず、`T[] | undefined` を T[] の props に渡して型エラーになる
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
カードごとに別々に読み込み中・エラーを出すなら、`data` を渡す側で `q.data ?? []` にするか、
|
|
75
|
+
カードのコンポーネントの中で上と同じ判定をする。
|
|
76
|
+
|
|
48
77
|
`ApiError` は `message`・`status`・`body`・`requestId` を持つ。hook が使えない場所では
|
|
49
78
|
`apiJson(path, init)`、生の `Response` が要るときは `apiFetch`。
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
```
|
|
28
28
|
- 数式・グラフ・セル書式といった概念は csv には無いので、値がそのまま読めます。ブラウザで
|
|
29
29
|
パースするので 25MB を超えるファイルはそのページにエラーが出ます —— 大きいデータは
|
|
30
|
-
`server/api/` から配って `DataTable`
|
|
30
|
+
`server/api/` から配って `DataTable` で描いてください。20 万行を超えると先頭
|
|
31
|
+
20 万行だけが表示されます(残りはダウンロードして見る)
|
|
31
32
|
- **ビューアの無い拡張子(`.tsv` など)はルートになりません。** `vantage check` の
|
|
32
33
|
`UNSUPPORTED_PAGE_FILE` 警告が知らせます
|
|
@@ -12,9 +12,16 @@
|
|
|
12
12
|
|
|
13
13
|
```tsx
|
|
14
14
|
import { definePage } from "@squadbase/vantage"
|
|
15
|
-
import {
|
|
15
|
+
import { BarChart } from "@squadbase/vantage/components"
|
|
16
16
|
import { Document } from "@squadbase/vantage/doc"
|
|
17
17
|
|
|
18
|
+
const weekly = [
|
|
19
|
+
{ week: "第1週", 売上: 1180 },
|
|
20
|
+
{ week: "第2週", 売上: 1240 },
|
|
21
|
+
{ week: "第3週", 売上: 1210 },
|
|
22
|
+
{ week: "第4週", 売上: 1620 },
|
|
23
|
+
]
|
|
24
|
+
|
|
18
25
|
export const page = definePage({ title: "6月度サマリー", navLabel: "6月度サマリー" })
|
|
19
26
|
export default function JuneSummary() {
|
|
20
27
|
return (
|
|
@@ -23,7 +30,7 @@ export default function JuneSummary() {
|
|
|
23
30
|
<p>6月の売上は <strong>5,250 万円</strong>で、目標を 5% 上回りました。</p>
|
|
24
31
|
<h2>週次の売上</h2>
|
|
25
32
|
<figure>
|
|
26
|
-
<
|
|
33
|
+
<BarChart data={weekly} index="week" categories={["売上"]} height={280} ariaLabel="6月の週次売上" />
|
|
27
34
|
<figcaption>第4週はキャンペーン初週</figcaption>
|
|
28
35
|
</figure>
|
|
29
36
|
<table>…</table>
|
|
@@ -42,13 +49,38 @@ export default function JuneSummary() {
|
|
|
42
49
|
見た目を変えたいときはユーティリティを並べず、下の `--doc-*` を変えます。
|
|
43
50
|
- **数値はコードに直接書く。** ドキュメントは書いた時点の内容を残すページです。
|
|
44
51
|
`useApiQuery` などで読み込むと、開くたびに値が変わります。
|
|
45
|
-
-
|
|
52
|
+
- **チャートは型付きチャート(`BarChart`・`LineChart` など。`@squadbase/vantage/components`)を
|
|
53
|
+
文中に置く**(選び方は `agents/page.md` の「グラフはまず型付きチャートで描く」)。`figure` で囲めば
|
|
46
54
|
`figcaption` がキャプションになります。
|
|
47
55
|
- **PDF の保存ボタンは作らない。** `<Document>` が右下に PDF 保存のボタンを出し、印刷時は
|
|
48
56
|
本文だけをライトの配色で出します。
|
|
49
57
|
- **ページ全体を包むのは `<Document>` だけ。** `PageShell` などのダッシュボード用の枠で包まない
|
|
50
58
|
(本文の幅と余白は `<Document>` が決めます)。
|
|
51
59
|
|
|
60
|
+
## まず block を探す
|
|
61
|
+
|
|
62
|
+
1 節分の中身は、手で組む前に `@squadbase/vantage/doc` の block から探します(`<Document>` の直下に
|
|
63
|
+
並べる。多くは 1 block = 1 節。`DocCallout`・`DocFigure`・`DocDataTable` は節ではなく、節の中(本文の間)に置く部品)。props は `vantage docs <name>`(例: `vantage docs doc-kpi-scorecard`)で引く。
|
|
64
|
+
|
|
65
|
+
| block | 用途 |
|
|
66
|
+
| --- | --- |
|
|
67
|
+
| `DocReportHeader` | レポートの冒頭(タイトル・サブタイトル・対象期間・データ時点・作成者・出典) |
|
|
68
|
+
| `DocExecutiveSummary` | 結論を先に述べる要約の節 |
|
|
69
|
+
| `DocKpiScorecard` | 主要指標をまとめたスコアカード |
|
|
70
|
+
| `DocFigure` | 図表 1 つとキャプション(チャートは children で渡す) |
|
|
71
|
+
| `DocDataTable` | 素の `table` による表 |
|
|
72
|
+
| `DocCallout` | 補足・示唆・注意・決定の囲み(`kind`: `note` / `insight` / `warning` / `decision`) |
|
|
73
|
+
| `DocKeyFindings` | 主要な発見の箇条 |
|
|
74
|
+
| `DocActionItems` | 次のアクション(担当・期限つき) |
|
|
75
|
+
| `DocNotesAndSources` | 末尾の注記・用語の定義・データソースをまとめた節 |
|
|
76
|
+
|
|
77
|
+
**props の渡し方は block 間で共通。** 数値は `value: number | null` と `format`(整形は block がする。表示を上書きするときだけ `display`。`null` は「—」)。前期比などは `delta: { value, format? }` と `comparisonLabel`(例 `"前年同期比"`)、良し悪しは指標ごとの `betterWhen`(`"up"` が既定、コストなど下がるほど良いものは `"down"`。向きは block が符号から出す)。目標は `target: number`。出典は `source`、時点は `asOf` に**日付だけ**(例 `"2026-09-30"`。「データ時点」は block が付けるので「時点」を書かない)。時系列は、単一系列なら `{ x, y }[]`(`trend`)。
|
|
78
|
+
|
|
79
|
+
本文の中で増減を書くときは `DeltaText`(部品。「▲ +3.2%」の形で、文字サイズは持たず置かれた行に従う。`value` `format` `betterWhen` `comparisonLabel`)を使う。節ではなく文の中に置く。
|
|
80
|
+
|
|
81
|
+
block が合わない**1 節だけ**を素の HTML 要素で手で書く。import 元は `@squadbase/vantage/doc` のままで、
|
|
82
|
+
block のための新しい import 元はありません。本文は文字列か ReactNode で渡し、Markdown 文字列は渡さない。
|
|
83
|
+
|
|
52
84
|
## 見た目を変える
|
|
53
85
|
|
|
54
86
|
配色・書体・本文の幅は `--doc-*` の CSS 変数です。既定値はアプリのトークンへの別名なので、
|
|
@@ -73,3 +105,20 @@ export default function JuneSummary() {
|
|
|
73
105
|
`.doc` を付けられるのはルートになるページモジュールだけで、`_layout.doc.tsx` などは
|
|
74
106
|
`INVALID_PAGE_VARIANT` エラーになります。`june.doc.tsx` と `june.tsx` は同じ URL に解決するので
|
|
75
107
|
`ROUTE_CONFLICT` です。
|
|
108
|
+
|
|
109
|
+
## ファイル形式の規約
|
|
110
|
+
|
|
111
|
+
置き場所・URL・default export・`definePage` の書き方は全ページ共通(`agents/page.md` の
|
|
112
|
+
「ページファイルの規約」)。ここではドキュメント固有のものだけを挙げます。
|
|
113
|
+
|
|
114
|
+
**MUST**
|
|
115
|
+
|
|
116
|
+
- ファイル名は `<name>.doc.tsx`(`.jsx` も可)。サフィックスは小文字で 1 つだけ。`.doc.mdx` は
|
|
117
|
+
`INVALID_PAGE_VARIANT`、`.DOC.tsx`・二重サフィックスは黙って通常ページになる
|
|
118
|
+
- default export は `<Document>` をルートに返す。フレームワークは包まない
|
|
119
|
+
- ドキュメントの部品は `@squadbase/vantage/doc` から import する
|
|
120
|
+
|
|
121
|
+
**SHOULD**
|
|
122
|
+
|
|
123
|
+
- `PageShell` で包まない・PDF の保存ボタンを自作しない(上の「書き方」)
|
|
124
|
+
- 数値はコードに直接書き、いつ時点の値かを本文に書く
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
(ダッシュボード)を書くときに読んでください。前提となる不変条件・ディレクトリ構造は
|
|
5
5
|
`AGENTS.md` を先に読んでいる想定です。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
書き始める前に `AGENTS.md` の「見た目の規約」(と、あればプロジェクトルートの `DESIGN.md`)に従う。
|
|
8
8
|
|
|
9
9
|
## 最小アプリ(2 ファイル)
|
|
10
10
|
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
},
|
|
27
27
|
"dependencies": {
|
|
28
28
|
"@squadbase/vantage": "^0.5.0",
|
|
29
|
-
"react": "^19.
|
|
30
|
-
"react-dom": "^19.
|
|
29
|
+
"react": "^19.3.1",
|
|
30
|
+
"react-dom": "^19.3.1"
|
|
31
31
|
}
|
|
32
32
|
}
|
|
33
33
|
```
|
|
@@ -71,6 +71,7 @@ URL になる。各ページは**デフォルトエクスポートの React コ
|
|
|
71
71
|
| `_404.tsx` | Not Found ページ |
|
|
72
72
|
| `_error.tsx` | ルートが throw したときのエラーページ |
|
|
73
73
|
| `monthly-report.slide.tsx` | `/monthly-report`(スライドデッキ。詳しくは `agents/slide.md`) |
|
|
74
|
+
| `june-summary.doc.tsx` | `/june-summary`(ドキュメント。詳しくは `agents/doc.md`) |
|
|
74
75
|
| `sales-export.csv` | `/sales-export`(詳しくは `agents/csv.md`) |
|
|
75
76
|
| `data/june.xlsx` | `/data/june`(詳しくは `agents/xlsx.md`) |
|
|
76
77
|
|
|
@@ -89,6 +90,26 @@ export default function MonthlyAnalysis() {
|
|
|
89
90
|
}
|
|
90
91
|
```
|
|
91
92
|
|
|
93
|
+
### ページファイルの規約(`.tsx` / `.slide.tsx` / `.doc.tsx` 共通)
|
|
94
|
+
|
|
95
|
+
**MUST**
|
|
96
|
+
|
|
97
|
+
- ページルートの配下に置く。`components/` などの走査対象外のディレクトリに置いたファイルはページに
|
|
98
|
+
ならず、エラーも出ない。`_` 始まりの名前は予約名(`_layout` / `_404` / `_error`)にだけ使う
|
|
99
|
+
(それ以外の `_` 始まりはページにならない。予約名にサフィックスを付けると `INVALID_PAGE_VARIANT`)
|
|
100
|
+
- URL はサフィックスと拡張子を除いたパスで決まる。同じ URL になる別ファイル(`june.tsx` /
|
|
101
|
+
`june.slide.tsx` / `june.doc.tsx` / `june.csv`)を並べない(`ROUTE_CONFLICT`)。テンプレートの
|
|
102
|
+
未編集の `index.tsx` だけは例外で、`index.slide.tsx` / `index.doc.tsx` が `/` を取れる
|
|
103
|
+
- default export は React の関数コンポーネント(無いと `MISSING_DEFAULT_EXPORT`。関数かどうかは
|
|
104
|
+
検査されない)
|
|
105
|
+
- `definePage({ ... })` にはオブジェクトリテラルを直接渡し、`title` / `description` / `navLabel` は
|
|
106
|
+
文字列リテラルで書く。ビルド時に静的抽出されるので、変数・関数呼び出し・spread・shorthand・
|
|
107
|
+
`${}` を含むテンプレート文字列は**エラーにならず黙ってメタなし**になる
|
|
108
|
+
|
|
109
|
+
**SHOULD**
|
|
110
|
+
|
|
111
|
+
- `definePage` に `title` と `navLabel` を書く(ナビの表示名とブラウザのタブ名になる)
|
|
112
|
+
|
|
92
113
|
### ナビはルート一覧から組む
|
|
93
114
|
|
|
94
115
|
`useRoutes()` がページルート一覧(スキャン順)を返すので、リンク配列を手で持たない。
|
|
@@ -109,7 +130,7 @@ routes.map((r) => (
|
|
|
109
130
|
```
|
|
110
131
|
|
|
111
132
|
`RouteInfo`: `path`(`/sales/:id`)・`to`(`/sales/$id`)・`params`・`dynamic`・`index`・`label`・
|
|
112
|
-
`title`・`description`・`navLabel`・`kind`(`"module"` | `"file"`)・`variant`(`"slide"`)。
|
|
133
|
+
`title`・`description`・`navLabel`・`kind`(`"module"` | `"file"`)・`variant`(`"slide"` | `"doc"`)。
|
|
113
134
|
後ろの 2 つで、ナビをダッシュボード / スライド / データに分けたりアイコンを変えたりできます。
|
|
114
135
|
|
|
115
136
|
### フィルタ状態は URL に置く
|
|
@@ -164,17 +185,41 @@ refetchOnWindowFocus false・networkMode "always")。挙動を変えたいとき
|
|
|
164
185
|
## 組み込み UI / コンポーネントの入口
|
|
165
186
|
|
|
166
187
|
- **プリミティブ**は `@squadbase/vantage/ui` から import する(`Button`・`Loading`・
|
|
167
|
-
`ErrorState`・`Empty`・`Select`・`Checkbox
|
|
188
|
+
`ErrorState`・`Empty`・`Select`・`Checkbox`・`RadioGroup`・`Field`・`Combobox`・`Pagination`・
|
|
189
|
+
`Avatar`・`Kbd`・`HoverCard`・`AlertDialog`・`Drawer`・`Toaster` + `toast.add()` ほか)。
|
|
168
190
|
- **複合パーツ**は `@squadbase/vantage/components` から(`PageShell`・`DashboardCardPreset`・
|
|
169
|
-
`DataTablePreset
|
|
191
|
+
`DataTablePreset`・型付きチャート(下の「グラフ」)・`EChart` ほか)。
|
|
170
192
|
- **どの名前が import 可能か / props の詳細は `vantage docs` で引く。** ガイドとコンポーネント
|
|
171
193
|
リファレンスはパッケージに同梱されていて、オフラインでも読める(→ `AGENTS.md` の
|
|
172
194
|
「ドキュメントを引く」)。**名前が分からないとき**はやりたいことで `vantage search` する
|
|
173
195
|
(→ 同節)。
|
|
174
|
-
- **UI は import して使うのが既定。取り出す(eject)必要はない。** `vantage add ui
|
|
175
|
-
|
|
176
|
-
`
|
|
177
|
-
`add
|
|
196
|
+
- **UI は import して使うのが既定。取り出す(eject)必要はない。** `vantage add ui <name>` は
|
|
197
|
+
ソースを手元にコピーして**改造したいとき専用**のコマンド。`/ui` のプリミティブも
|
|
198
|
+
`/components` の複合パーツも全部取り出せる(名前は kebab-case: `add ui bar-chart`。
|
|
199
|
+
ブロックは `add block sales-overview`。未知名で実行すると候補が一覧表示される)。
|
|
200
|
+
|
|
201
|
+
### 長い表はページングする(縦スクロール箱を作らない)
|
|
202
|
+
|
|
203
|
+
- 行が多い表は `DataTablePreset`(または `DataTable`)に `enablePagination` を付けて**ページング**する
|
|
204
|
+
(既定は 10 行 / ページ。ページングは既定で無効なので、付け忘れると全行が並ぶ)。素の `<table>` を
|
|
205
|
+
手書きして全行を流し込まない。
|
|
206
|
+
- カードの中に `max-h-*` + `overflow-y-auto` の**縦スクロール領域を作らない**。ホイールやキー
|
|
207
|
+
(End / Space)がその箱に吸われ、ページ全体がスクロールしなくなる。高さは内容に任せる。
|
|
208
|
+
- 横に広い表の `overflow-x-auto` は構わない。`SheetGrid`(`.csv` / `.xlsx` のビューア)は
|
|
209
|
+
グリッドとして意図した入れ子スクロールなので対象外。
|
|
210
|
+
|
|
211
|
+
### グラフはまず型付きチャートで描く
|
|
212
|
+
|
|
213
|
+
- 推移は `LineChart` / `AreaChart`、比較は `BarChart`、構成比は `DonutChart`。`data`(行の配列)・
|
|
214
|
+
`index`(x 軸の列)・`categories`(系列の列)を渡すだけで、option は書かない
|
|
215
|
+
(`DonutChart` は `category` / `value`)。
|
|
216
|
+
- 上位 N 件は `BarList`、判定帯や予算消化は `CategoryBar`、達成率は `ProgressCircle`、
|
|
217
|
+
日ごとの状態は `Tracker`。
|
|
218
|
+
- `EChart` + `EChartsOption` は、二軸・散布図・ヒートマップ・注釈線など型付きチャートの props で
|
|
219
|
+
表せないときだけ使う。
|
|
220
|
+
- 色は省略してテーマトークンに任せる。指定するなら `"chart-1"`〜`"chart-5"` か
|
|
221
|
+
`"var(--destructive)"` などの CSS 色。hex の直書きや Tailwind クラスは使わない。
|
|
222
|
+
- 数値の書式(`¥`・`%`・桁区切り)は `valueFormatter` に渡す。
|
|
178
223
|
|
|
179
224
|
### ダークモードは opt-in
|
|
180
225
|
|
|
@@ -4,7 +4,13 @@
|
|
|
4
4
|
スライドデッキを書くときに読んでください。不変条件・ディレクトリ構造は `AGENTS.md` を
|
|
5
5
|
先に読んでいる想定です。
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
書き始める前に `AGENTS.md` の「見た目の規約」(と、あればプロジェクトルートの `DESIGN.md`)に従う。
|
|
8
|
+
スライド固有の規則:
|
|
9
|
+
|
|
10
|
+
- 1 枚に 1 メッセージ。見出しに結論を書く。
|
|
11
|
+
- 色は `--slide-bg` / `--slide-fg` / `--slide-accent` / `--slide-muted` を使う(既定では
|
|
12
|
+
`--background` / `--foreground` / `--primary` / `--muted-foreground` に連動)。
|
|
13
|
+
- 強調色は 1 枚につき 1 か所まで。
|
|
8
14
|
|
|
9
15
|
## スライドは `.slide.tsx` で書く
|
|
10
16
|
|
|
@@ -19,6 +25,7 @@
|
|
|
19
25
|
- 新規プロジェクトでまだ `/` が空いている場合のみ、`index.slide.tsx` を使ってよい。
|
|
20
26
|
|
|
21
27
|
```tsx
|
|
28
|
+
import { definePage } from "@squadbase/vantage"
|
|
22
29
|
import { Slide, SlideDeck } from "@squadbase/vantage/slide"
|
|
23
30
|
|
|
24
31
|
export const page = definePage({ title: "6月度レビュー", navLabel: "6月度" })
|
|
@@ -34,15 +41,87 @@ export default function Deck() {
|
|
|
34
41
|
|
|
35
42
|
**`<Slide>` は `<SlideDeck>` の直接の子に書く。** `SlideDeck` は直下の `<Slide>` 要素だけを数えるので、
|
|
36
43
|
`<Slide>` を自作コンポーネント(`<Slide1 />` など)や Fragment で包むと 1 枚も数えられず「1 / 0」に
|
|
37
|
-
なります(`{items.map((x) => <Slide key={x.id}>…</Slide>)}`
|
|
38
|
-
|
|
44
|
+
なります(`{items.map((x) => <Slide key={x.id}>…</Slide>)}` のような配列はファイル形式としては可。
|
|
45
|
+
1 枚の中で視覚要素を `map` で量産しない方針は `vantage-slide` skill の「繰り返す要素は `map` ではなく
|
|
46
|
+
コンポーネント」)。共通の部品は `<Slide>` の**中**に置くコンポーネントとして切り出します
|
|
47
|
+
(`<Slide><CoverPage /></Slide>`)。
|
|
39
48
|
|
|
40
49
|
1920×1080 の固定キャンバスに絶対 px で書き、画面サイズに合わせて縮小されます。キー / クリックで
|
|
41
50
|
送れ、左のスライド一覧(サムネイル列)は `L` で開閉、`F` で全画面、ツールバーから pptx を
|
|
42
51
|
書き出せます。**書き方の作法は同梱 Skill の
|
|
43
52
|
`vantage-slide`** にあります(キャンバスの縦方向の予算、段階表示、トランジション、モーフ、
|
|
44
|
-
pptx
|
|
53
|
+
pptx が壊れる条件、説明と図表のデータ時点の揃え方)。
|
|
54
|
+
|
|
55
|
+
**分析を共有するデッキでは、本文・数値・図表を同じ対象期間と同じ取得時点の結果に揃え、その期間と
|
|
56
|
+
時点を短く表示する。** 説明文を固定したまま図表だけが最新値へ変わる構成にしない(ライブ更新を
|
|
57
|
+
意図するなら本文も同じ取得結果から導く)。同一時点の結果を保持できない場合は、スナップショットとして
|
|
58
|
+
保存できたとは報告せず、必要な保持の仕組みと保証できない範囲を伝える。
|
|
45
59
|
|
|
46
60
|
`.slide` を付けられるのはルートになるページモジュールだけで、`_layout.slide.tsx` などは
|
|
47
61
|
`INVALID_PAGE_VARIANT` エラーになります。`june.slide.tsx` と `june.tsx` は同じ URL に解決するので
|
|
48
62
|
`ROUTE_CONFLICT` です。
|
|
63
|
+
|
|
64
|
+
## まず block を探す
|
|
65
|
+
|
|
66
|
+
1 枚分の中身は、手で組む前に `@squadbase/vantage/slide` の block から探します(`<Slide>` の**中**に
|
|
67
|
+
置く。ルートは 100% で、`<Slide>` 自体は持たない)。props は `vantage docs <name>`(例:
|
|
68
|
+
`vantage docs slide-kpi-hero`)で引く。
|
|
69
|
+
|
|
70
|
+
| block | 用途 |
|
|
71
|
+
| --- | --- |
|
|
72
|
+
| `SlideCover` | 表紙(タイトル・サブタイトル・期間) |
|
|
73
|
+
| `SlideExecSummary` | 結論を先に述べるエグゼクティブサマリー |
|
|
74
|
+
| `SlideKpiHero` | 主要な KPI 1 つを大きく見せる |
|
|
75
|
+
| `SlideKpiGrid` | 複数の KPI を並べる |
|
|
76
|
+
| `SlideChartInsight` | チャート 1 つと、そこから読み取れること |
|
|
77
|
+
| `SlideScorecardTable` | 指標と目標・達成度を表にしたスコアカード |
|
|
78
|
+
| `SlideNextActions` | 次のアクション(担当・期限つき) |
|
|
79
|
+
| `SlideSection` | 章の扉(`items` を渡すと番号付きのアジェンダ。`current` の章を強調) |
|
|
80
|
+
| `SlideComparison` | A vs B・前後の 2〜3 列比較(各列に見出し・主要数値・箇条) |
|
|
81
|
+
| `SlideChartFull` | チャートを全幅に置き、注記を 1 行添える |
|
|
82
|
+
|
|
83
|
+
**手書きの 1 枚には部品を使う。** block が合わない 1 枚でも、見出し・出典行・列割りは自前で組まず、
|
|
84
|
+
次の部品を使う(どれも `@squadbase/vantage/slide`。1 枚にはならないので `<Slide>` の中に並べる)。
|
|
85
|
+
|
|
86
|
+
| 部品 | 用途 |
|
|
87
|
+
| --- | --- |
|
|
88
|
+
| `SlideHeading` | 見出し(`title`、任意で `eyebrow`)。1 枚の先頭に置く |
|
|
89
|
+
| `SlideSourceLine` | 足元の出典・時点(`source` `asOf`)。`page={{ current, total }}` を渡すとページ番号も出す |
|
|
90
|
+
| `SlideColumns` / `SlideColumn` | 12 列の割り付け(`<SlideColumn span={8}>` と `span={4}` など)。`align` は `start` / `center` / `stretch` |
|
|
91
|
+
| `DeltaText` | 増減の文字(「▲ +3.2%」)。`value` `format` `betterWhen` `comparisonLabel` |
|
|
92
|
+
|
|
93
|
+
`SlideSection` は `Steps` を持たない。順に見せたいときは呼び出し側で `<Steps>` で包む。
|
|
94
|
+
|
|
95
|
+
```tsx
|
|
96
|
+
import { Slide, SlideDeck, SlideCover, SlideExecSummary } from "@squadbase/vantage/slide"
|
|
97
|
+
// <SlideDeck><Slide><SlideCover … /></Slide><Slide><SlideExecSummary … /></Slide></SlideDeck>
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**props の渡し方は block 間で共通。** 数値は `value: number | null` と `format`(整形は block がする。表示を上書きするときだけ `display`。`null` は「—」)。前期比などは `delta: { value, format? }` と `comparisonLabel`(例 `"前年同期比"`)、良し悪しは指標ごとの `betterWhen`(`"up"` が既定、コストなど下がるほど良いものは `"down"`。向きは block が符号から出す)。目標は `target: number`。出典は `source`(文字列)、時点は `asOf` に**日付だけ**(例 `"2026-09-30"`。「時点」は block が付けるので書かない)。時系列は、単一系列なら `{ x, y }[]`(kpi-hero の `trend`。scorecard に `trend` は無い)、複数系列なら `{ categories, series }`(chart-insight の `chart`)。
|
|
101
|
+
|
|
102
|
+
block が合わない**1 枚だけ**を手で書く(デッキ全体を手書きに切り替えない)。import 元は
|
|
103
|
+
`@squadbase/vantage/slide` のままで、block のための新しい import 元はありません。
|
|
104
|
+
|
|
105
|
+
## ファイル形式の規約
|
|
106
|
+
|
|
107
|
+
置き場所・URL・default export・`definePage` の書き方は全ページ共通(`agents/page.md` の
|
|
108
|
+
「ページファイルの規約」)。ここではスライド固有のものだけを挙げます。**中身の値(キャンバス・
|
|
109
|
+
セーフエリア・グリッド・文字サイズ・余白)は `vantage-slide` skill を参照。**
|
|
110
|
+
|
|
111
|
+
**MUST**(破ると黙って壊れるものが多い。`vantage check` が拾うのは名前の誤りだけ)
|
|
112
|
+
|
|
113
|
+
- ファイル名は `<name>.slide.tsx`(`.jsx` も可)。サフィックスは小文字で 1 つだけ。`.slide.ts` は
|
|
114
|
+
`INVALID_PAGE_VARIANT`、`.SLIDE.tsx`・二重サフィックス・`.slide.test.tsx` は黙って通常ページになる
|
|
115
|
+
- default export は `<SlideDeck>` をルートに返す。フレームワークは包まない
|
|
116
|
+
- `<Slide>` は `<SlideDeck>` の直接の子(配列は可。Fragment・自作コンポーネントで包まない)
|
|
117
|
+
- `<Step>` は `<Steps>` の直接の子(包むと常に表示される)
|
|
118
|
+
- スライドの部品は `@squadbase/vantage/slide` から import する
|
|
119
|
+
|
|
120
|
+
**SHOULD**
|
|
121
|
+
|
|
122
|
+
- 1 ファイル = 1 デッキ。ヘルパーコンポーネント・定数も同じ `.slide.tsx` に書く
|
|
123
|
+
- 各 `<Slide>` のルート要素は `width: "100%"; height: "100%"` でキャンバスを埋める
|
|
124
|
+
- canvas に描くチャート(`EChart`)は `data-waitfor="canvas"` で包む(無いと pptx でそのスライドが白紙になりうる)
|
|
125
|
+
- pptx に出る中身をアプリの Context(router / query / テーマ)に依存させない
|
|
126
|
+
- `MorphElement` の `id` はページ内で一意にし、入れ子にしない。遷移先の `<Slide>` で `transition.morph` を有効にする
|
|
127
|
+
- pptx 用などの依存を追加しない(html-to-image / fflate は自動で入る)
|
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
- **複数シートに対応**しています。シートのタブは下端に並び、切り替えて閲覧できます。
|
|
29
29
|
- 数式・グラフ・セル書式は再現されません(値として読めれば十分、という設計)。ブラウザでパースするので
|
|
30
30
|
25MB を超えるファイルはそのページにエラーが出ます —— 大きいデータは `server/api/` から配って
|
|
31
|
-
`DataTable`
|
|
31
|
+
`DataTable` で描いてください。20 万行を超えると先頭
|
|
32
|
+
20 万行だけが表示されます(残りはダウンロードして見る)
|
|
32
33
|
- **ビューアの無い拡張子(`.xls`・`.ods` など)はルートになりません。** `vantage check` の
|
|
33
34
|
`UNSUPPORTED_PAGE_FILE` 警告が知らせます
|