@squadbase/vantage-template 0.1.1-dev1.6b30e42 → 0.1.1-dev1.6ed50bb
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 +1 -1
- package/base-template/.squadbase/skills/vantage-add-feature/SKILL.md +5 -0
- package/base-template/.squadbase/skills/vantage-design/SKILL.md +25 -27
- package/base-template/.squadbase/skills/vantage-design/references/extract.md +10 -13
- package/base-template/.squadbase/skills/vantage-design/references/format.md +12 -173
- package/base-template/.squadbase/skills/vantage-design/references/presets.md +0 -10
- package/base-template/.squadbase/skills/vantage-pitfalls/SKILL.md +5 -0
- package/base-template/.squadbase/skills/vantage-slide/SKILL.md +54 -36
- package/base-template/AGENTS.md +48 -19
- package/base-template/agents/api.md +7 -0
- package/base-template/agents/doc.md +48 -0
- package/base-template/agents/page.md +59 -2
- package/base-template/agents/slide.md +77 -3
- package/base-template/bun.lock +25 -25
- package/base-template/package.json +2 -2
- package/base-template/src/_layout.tsx +7 -0
- package/base-template/src/components/user-card.tsx +1 -1
- package/base-template/src/index.tsx +1 -1
- package/dist/index.js +14 -14
- package/package.json +2 -2
- package/base-template/DESIGN.md +0 -109
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ npx @squadbase/vantage-template <command> [options]
|
|
|
14
14
|
|
|
15
15
|
#### `init`
|
|
16
16
|
|
|
17
|
-
Initialize a new Vantage project in the current directory. Copies the base template — `src/index.tsx`, `src/_layout.tsx`, `src/_404.tsx`, `src/_error.tsx`, `src/styles.css`, `server/api/`, `tsconfig.json`, `squadbase.yml`,
|
|
17
|
+
Initialize a new Vantage project in the current directory. Copies the base template — `src/index.tsx`, `src/_layout.tsx`, `src/_404.tsx`, `src/_error.tsx`, `src/styles.css`, `server/api/`, `tsconfig.json`, `squadbase.yml`, plus the agent guidance in `AGENTS.md` (and `agents/`, when the framework ships per-type knowledge files) and `.squadbase/skills/` — and installs dependencies.
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
20
|
npx @squadbase/vantage-template init
|
|
@@ -112,6 +112,11 @@ if (q.isError) return <ErrorState message={q.error.message} /> // HttpError の
|
|
|
112
112
|
const rows = useApiQuery<Row[]>("/api/customers", { search: { segment } })
|
|
113
113
|
```
|
|
114
114
|
|
|
115
|
+
絞り込み(期間・セグメント)を持つページでは、この `ErrorState` の早期 return をデータを描く
|
|
116
|
+
子コンポーネントの中に置く。ページの先頭に置くと、失敗したときに絞り込みの欄ごと消えて条件を
|
|
117
|
+
直せなくなる。期間は `DateRangePicker` で選ばせる(→ `agents/page.md` の「絞り込みの欄は、
|
|
118
|
+
読み込み中も失敗したときも出し続ける」)。
|
|
119
|
+
|
|
115
120
|
書き込みは `useApiMutation(path, { method: "POST" })` — 変数がそのまま JSON ボディになる。
|
|
116
121
|
|
|
117
122
|
## UI コンポーネント / ブロックを追加する
|
|
@@ -1,28 +1,31 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: vantage-design
|
|
3
|
-
description: Vantage(@squadbase/vantage)
|
|
3
|
+
description: Vantage(@squadbase/vantage)アプリのテーマ(色・チャートの色・書体・角丸)を、`styles.css` とテーマコマンドで作る / 更新する手順。配色・ブランドカラー・テーマ・チャートの色・フォント・角丸・トーンを変えたいとき、既存サイトやロゴ・資料に合わせたいとき、プロジェクト作成時の初期デザイン(テーマ neutral / ocean / forest / sunset / violet / rose / mono)を決めるときに使う。「色を変えて」「ブランドに合わせて」「このサイトに合わせて」「落ち着いた感じに」「フォントを変えて」「テーマを作って」、"change the colors", "match our brand", "match this website", "theme", "color palette", "font", "design system" で起動。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
#
|
|
6
|
+
# テーマと styles.css を更新する
|
|
7
7
|
|
|
8
|
-
Vantage
|
|
8
|
+
Vantage アプリの色・書体・角丸の値と色の割り当ては、SquadKit のテーマだけが持つ。
|
|
9
9
|
|
|
10
|
-
|
|
|
11
|
-
| --- | --- |
|
|
12
|
-
| `
|
|
13
|
-
| `styles.css`(ページと同じ側。通常 `src/styles.css`)
|
|
10
|
+
| 手段 | 何を決めるか |
|
|
11
|
+
| --- | --- |
|
|
12
|
+
| ThemeDialog / `theme <id>` / `chart <preset>`(CLI) | 出発点のテーマとチャートの配色 |
|
|
13
|
+
| `styles.css`(ページと同じ側。通常 `src/styles.css`)の `/* squadkit-theme:end */` より後ろ | ブランド色・書体など、テーマに無い値の上書き |
|
|
14
14
|
|
|
15
|
-
|
|
16
|
-
|
|
15
|
+
デザイン変更の依頼(「もっと落ち着いた色に」など)は、**テーマの切り替えかスタイルシートの上書きで完結させる。**
|
|
16
|
+
`DESIGN.md` へは記録しない。今のテーマ名は `styles.css` の `/* theme: <name> */` マーカーから読む。
|
|
17
|
+
ページ単位の `className` 修正で済ませない。
|
|
17
18
|
|
|
18
|
-
|
|
19
|
+
見た目の規則(意味トークンの使い分け・カードで包む・KPI → チャート → 表など)は `AGENTS.md` の
|
|
20
|
+
「見た目の規約」節が正本。ここでは手順だけを扱い、規則は重複させない。
|
|
21
|
+
任意の `DESIGN.md`(ユーザー固有の意図を書くファイル)は、ユーザーが望んだときだけ扱う(`references/format.md`)。
|
|
19
22
|
|
|
20
23
|
## リファレンス
|
|
21
24
|
|
|
22
25
|
| ファイル | 読む場面 |
|
|
23
26
|
| --- | --- |
|
|
24
|
-
| `references/format.md` | `DESIGN.md`
|
|
25
|
-
| `references/extract.md` | URL・画像・pptx/pdf
|
|
27
|
+
| `references/format.md` | ユーザーが任意の `DESIGN.md` を望んだとき(位置づけと優先順位) |
|
|
28
|
+
| `references/extract.md` | URL・画像・pptx/pdf・言葉から色と書体を取り出すとき |
|
|
26
29
|
| `references/presets.md` | テーマ(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)の選び方と `theme` コマンド。旧プリセット id の読み替え |
|
|
27
30
|
| `scripts/contrast.mjs` | 文字色と背景色のコントラスト比を確かめるとき |
|
|
28
31
|
|
|
@@ -30,24 +33,23 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
30
33
|
|
|
31
34
|
### 1. 入力を集める
|
|
32
35
|
|
|
33
|
-
- 何に合わせるのか(URL
|
|
36
|
+
- 何に合わせるのか(URL・ロゴ画像・資料・言葉)を確認し、
|
|
34
37
|
`references/extract.md` の該当する節の手順で色・書体・トーンを取り出す。
|
|
35
|
-
- 既存の `
|
|
38
|
+
- 既存の `styles.css` を読み、マーカーから今のテーマ名を確かめる。今回触らない上書きは残す。
|
|
39
|
+
- プロジェクトルートに `DESIGN.md` があれば読む(ユーザー所有。書き換えない)。色の割り当てはテーマが優先。
|
|
36
40
|
- スライド(`*.slide.tsx`)があるかを `ls` / `vantage routes` で確認しておく。
|
|
37
41
|
|
|
38
42
|
### 2. 提案して確認を取る
|
|
39
43
|
|
|
40
44
|
書き込む前に、次の 2 つをユーザーに見せて確認を取る。
|
|
41
45
|
|
|
42
|
-
- **役割 → トークンの対応表**(
|
|
46
|
+
- **役割 → トークンの対応表**(主色・背景の段階・文字・チャート 5 色・書体。良い/悪い/注意/情報/中立はテーマの意味トークンに任せる)。
|
|
43
47
|
各行に「何に合わせてその色にしたか」を 1 語添える。
|
|
44
|
-
- **トーンの説明**(2〜3
|
|
48
|
+
- **トーンの説明**(2〜3 行)。
|
|
45
49
|
|
|
46
50
|
テーマで足りる場合はテーマ id(`references/presets.md`)で提案してよい。旧プリセット id(`default` / `calm` / `vivid` / `mono`)で頼まれたら新 id に読み替える。
|
|
47
51
|
|
|
48
|
-
### 3. styles.css
|
|
49
|
-
|
|
50
|
-
`styles.css`:
|
|
52
|
+
### 3. テーマを当て、styles.css を書く
|
|
51
53
|
|
|
52
54
|
- **テーマ範囲・チャート範囲のマーカーの中は手で編集しない。** 色・角丸・書体の出発点は 7 テーマ
|
|
53
55
|
(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)から選び、コマンドで当てる:
|
|
@@ -100,10 +102,6 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
100
102
|
長い表(ダッシュボード): カードに `max-h-*` + `overflow-y-auto` の縦スクロール領域を作らず、
|
|
101
103
|
ページング付きの `DataTablePreset`(`enablePagination`)にする(ホイールや End キーがページに届かなくなるため)。
|
|
102
104
|
|
|
103
|
-
`DESIGN.md`: `references/format.md` の書式で書く。**色コードを書かない**(トークン名だけ)。
|
|
104
|
-
150 行を超えない(超えると `vantage check` が `DESIGN_MD_TOO_LONG` を出す)。ロゴなどの素材は
|
|
105
|
-
`public/brand/logo.svg` のように `public/` 配下のパスで「ブランド素材」行に書く。
|
|
106
|
-
|
|
107
105
|
### 4. コントラストを確かめる
|
|
108
106
|
|
|
109
107
|
主な文字色 / 背景色の組を、**ライトとダークの両方で**確かめる。
|
|
@@ -133,11 +131,11 @@ node <このスキルの場所>/scripts/contrast.mjs '<文字色>' '<背景色>'
|
|
|
133
131
|
npx vantage check
|
|
134
132
|
```
|
|
135
133
|
|
|
136
|
-
`HARDCODED_COLOR`(ページ内の色コード)
|
|
134
|
+
`HARDCODED_COLOR`(ページ内の色コード)などが出たらその場で直す。
|
|
137
135
|
|
|
138
136
|
### 7. 完了を報告する
|
|
139
137
|
|
|
140
|
-
報告には、更新したファイル(`
|
|
138
|
+
報告には、更新したファイル(`styles.css` など)と当てたテーマ名に加えて次を**必ず**入れる。
|
|
141
139
|
|
|
142
140
|
- プレビューページのパスと URL(`src/design-preview.tsx` → `/design-preview`)。
|
|
143
141
|
- 「ホームなど既存の画面は一部の色しか使っていないので、変更が見えないことがある。配色はプレビュー
|
|
@@ -145,5 +143,5 @@ npx vantage check
|
|
|
145
143
|
|
|
146
144
|
## 会話中の指示との関係
|
|
147
145
|
|
|
148
|
-
- 会話中の個別の指示(「このグラフだけ赤で」)
|
|
149
|
-
- 同じ指示が 2 回以上出たら、`
|
|
146
|
+
- 会話中の個別の指示(「このグラフだけ赤で」)はテーマより優先する。そのページだけ直せばよい。
|
|
147
|
+
- 同じ指示が 2 回以上出たら、`styles.css` の上書きへ反映することを提案する(この手順の 2 から)。
|
|
@@ -44,7 +44,7 @@ grep -oE 'font-family:[^;]+' /tmp/site.css | sort | uniq -c | sort -rn | head
|
|
|
44
44
|
- SPA で HTML がほぼ空のときは、`<script>` より先に CSS の `<link>` を探す。それも無ければ
|
|
45
45
|
ユーザーにスクリーンショットかブランドカラーを聞く(推測で埋めない)。
|
|
46
46
|
- 取得できない(認証・ボット対策)ときは、その旨を伝えてスクリーンショットをもらう。
|
|
47
|
-
- ロゴを使うなら `public/brand/`
|
|
47
|
+
- ロゴを使うなら `public/brand/` に保存する。
|
|
48
48
|
|
|
49
49
|
## 画像・ロゴ
|
|
50
50
|
|
|
@@ -83,12 +83,10 @@ grep -oE 'font-family:[^;]+' /tmp/site.css | sort | uniq -c | sort -rn | head
|
|
|
83
83
|
|
|
84
84
|
## 外部の DESIGN.md(Stitch などが書いたもの)
|
|
85
85
|
|
|
86
|
-
外部の DESIGN.md
|
|
87
|
-
Vantage
|
|
88
|
-
書き直す**。
|
|
86
|
+
外部の DESIGN.md が値(hex・px・フォント名)を持っているときは、値だけを拾って**テーマ側**へ移す。
|
|
87
|
+
Vantage に `DESIGN.md` は作らない。
|
|
89
88
|
|
|
90
|
-
1. 値を拾う: primary / secondary / surface / background / on-* / error
|
|
91
|
-
フォント、角丸。
|
|
89
|
+
1. 値を拾う: primary / secondary / surface / background / on-* / error、フォント、角丸。
|
|
92
90
|
2. 対応づける:
|
|
93
91
|
|
|
94
92
|
| 外部の名前 | Vantage のトークン |
|
|
@@ -98,15 +96,14 @@ Vantage の `DESIGN.md` は値を持たないので、**値を `styles.css` へ
|
|
|
98
96
|
| background / surface / surface-container | `--background` / `--card` / `--muted` |
|
|
99
97
|
| on-background / on-surface / on-surface-variant | `--foreground` / `--card-foreground` / `--muted-foreground` |
|
|
100
98
|
| outline | `--border` |
|
|
101
|
-
| error | `--destructive` |
|
|
102
|
-
| success / warning |
|
|
99
|
+
| error | `--destructive`(意味トークンの negative) |
|
|
100
|
+
| success / warning | テーマの意味トークン(positive / warning)に任せる。チャートの色には割り当てない |
|
|
103
101
|
| radius / corner | `--radius` |
|
|
104
102
|
| display / headline font | `--slide-font-display`(+ ページの見出しなら `--font-sans`) |
|
|
105
103
|
| body font | `--font-sans`(ページ本文)と `--slide-font-body` |
|
|
106
104
|
|
|
107
105
|
3. `styles.css` のマーカーブロックの外に、`:root` と `.dark, [data-theme="dark"]` の両方で書く
|
|
108
|
-
(チャート色・書体の書き方は SKILL.md の手順 3)
|
|
109
|
-
|
|
110
|
-
4. `DESIGN.md`
|
|
111
|
-
|
|
112
|
-
5. 元のファイルは消さずに残すか(例: `docs/design-source.md`)、ユーザーに確認して削除する。
|
|
106
|
+
(チャート色・書体の書き方は SKILL.md の手順 3)。外部にダークの値が無ければ、ライトの色相を保って
|
|
107
|
+
明度だけ反転した値を作り、コントラストを確かめる。
|
|
108
|
+
4. 外部のトーン・Do/Don't・コンポーネントのルールは、ユーザーが望んだときだけ任意の `DESIGN.md`
|
|
109
|
+
(`format.md`)に要約して残す。値は書かない。
|
|
@@ -1,173 +1,12 @@
|
|
|
1
|
-
# DESIGN.md
|
|
2
|
-
|
|
3
|
-
`DESIGN.md`
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
- **150 行以内。** 超えると `vantage check` が `DESIGN_MD_TOO_LONG` を警告する。エージェントが
|
|
14
|
-
毎回全文を読むファイルなので、網羅より判断に効くルールを優先する。
|
|
15
|
-
- **YAML frontmatter は付けない。** 先頭は下の「冒頭のコメント」から始める。
|
|
16
|
-
- **会話中の指示が優先。** `DESIGN.md` は既定値であって、個別の依頼を拒む根拠にしない。
|
|
17
|
-
- ロゴ・画像は `public/` 配下のパスで参照する(`public/brand/logo.svg`)。画像を埋め込まない。
|
|
18
|
-
|
|
19
|
-
## 節の順番と見出し
|
|
20
|
-
|
|
21
|
-
見出しは日本語 + 英語の括弧書き(外部の DESIGN.md — Stitch など — の節と対応づけやすくするため)。
|
|
22
|
-
この順番を崩さない。無い情報の節は消さずに「特になし」と書く。
|
|
23
|
-
|
|
24
|
-
| # | 見出し | 書くこと |
|
|
25
|
-
| --- | --- | --- |
|
|
26
|
-
| 0 | 冒頭のコメント(`<!-- … -->`) | 何のファイルか / 値は styles.css / 会話の指示が優先 / 「このサイトに合わせて」で更新できること / upgrade が触らないこと |
|
|
27
|
-
| 1 | `## 全体のトーン (Overview)` | 2〜4 行のトーン。最後に「ブランド素材:」行(任意。`public/` のパス) |
|
|
28
|
-
| 2 | `## 色 (Colors)` | 役割 → トークンの表。行は **主色 / 強調 / 良い / 悪い / 注意 / 背景の段階 / 境界 / 文字**。専用トークンが無い役割は「専用トークンなし」+ 代替 |
|
|
29
|
-
| 3 | `## チャート (Charts)` | 系列の順番(`--chart-1..5` とその色味)、1 系列だけ強調するときの色、良い / 悪いの色、禁止の組み合わせ、プリセット名 |
|
|
30
|
-
| 4 | `## 書体 (Typography)` | 見出し / 本文 / 数字 / スライドの書体(`--slide-font-display` / `--slide-font-body`)と、サイズの段階(Tailwind クラス・`--slide-size-*`) |
|
|
31
|
-
| 5 | `## レイアウトと密度 (Layout)` | カード・余白(`gap-*`)・`--radius`・並べ方・密度 |
|
|
32
|
-
| 6 | `## 成果物の種類ごとの規則 (Per-artifact)` | `### ダッシュボード` と `### スライド` の小節(他の種類があれば小節を足す) |
|
|
33
|
-
| 7 | `## Do / Don't` | 3 つずつ程度 |
|
|
34
|
-
|
|
35
|
-
外部の DESIGN.md の対応: Overview / Colors / Typography / Layout(Spacing・Elevation 含む)/
|
|
36
|
-
Components → 「成果物の種類ごとの規則」/ Do's and Don'ts。値は `styles.css` へ移す
|
|
37
|
-
(→ `extract.md` の「外部の DESIGN.md」)。
|
|
38
|
-
|
|
39
|
-
## 使えるトークン
|
|
40
|
-
|
|
41
|
-
| 系統 | トークン |
|
|
42
|
-
| --- | --- |
|
|
43
|
-
| 面と文字 | `--background` `--foreground` `--card` `--card-foreground` `--popover` `--popover-foreground` |
|
|
44
|
-
| 主色など | `--primary` `--primary-foreground` `--secondary` `--secondary-foreground` `--accent` `--accent-foreground` `--muted` `--muted-foreground` `--destructive` `--destructive-foreground` |
|
|
45
|
-
| 境界 | `--border` `--input` `--ring` |
|
|
46
|
-
| チャート | `--chart-1` 〜 `--chart-5` |
|
|
47
|
-
| 形 | `--radius` |
|
|
48
|
-
| サイドバー | `--sidebar` `--sidebar-foreground` `--sidebar-primary` … |
|
|
49
|
-
| スライド | `--slide-bg` `--slide-fg` `--slide-accent` `--slide-muted` `--slide-radius` `--slide-font-display` `--slide-font-body` `--slide-size-hero` `--slide-size-body` |
|
|
50
|
-
|
|
51
|
-
- `--muted` `--accent` `--secondary` `--border` は背景・境界用。文字色の役割に割り当てない。
|
|
52
|
-
- 良い / 注意の専用トークンは無い。`--chart-*` の中から割り当てるか、「専用トークンなし」と書く。
|
|
53
|
-
- ページ本文の書体は `--font-sans`(`styles.css` の `body` が `font-family: var(--font-sans)` で参照する。
|
|
54
|
-
テーマを当てると `--font-sans` もテーマの値になる。変えるときはテーマ範囲のマーカーの後ろで上書きする)。
|
|
55
|
-
- `--slide-bg` などは既定で `--background` などの別名。`.dark` に書き直す必要は無い。
|
|
56
|
-
|
|
57
|
-
## 雛形(中立の既定テーマ)
|
|
58
|
-
|
|
59
|
-
ベーステンプレート(`packages/vantage-template/template/DESIGN.md`)と**同じ内容**。どちらかを
|
|
60
|
-
直したらもう片方も合わせること。既定テーマ(無彩色の `--primary`、チャートは `blue` プリセット)を
|
|
61
|
-
そのまま説明しているので、新規に作るときはこれを写して、変えた役割の行だけを書き換える。
|
|
62
|
-
|
|
63
|
-
````markdown
|
|
64
|
-
<!--
|
|
65
|
-
DESIGN.md — このアプリの「見た目の意図」を書くファイルです。
|
|
66
|
-
|
|
67
|
-
- 実際の色・角丸・書体の値は src/styles.css にあります。ここにはトークン名(--primary など)と
|
|
68
|
-
使い分けのルールだけを書き、色コードは書きません。
|
|
69
|
-
- エージェントはページ・スライド・コンポーネントを書く前にこのファイルを読みます。
|
|
70
|
-
会話の中での指示はこのファイルより優先されます。
|
|
71
|
-
- 「このサイトに合わせて」「色を落ち着いた感じに」と頼めば、このファイルと styles.css を
|
|
72
|
-
まとめて更新します。
|
|
73
|
-
- このファイルはあなたのものです。`vantage upgrade` が書き換えることはありません。
|
|
74
|
-
-->
|
|
75
|
-
|
|
76
|
-
# デザイン
|
|
77
|
-
|
|
78
|
-
## 全体のトーン (Overview)
|
|
79
|
-
|
|
80
|
-
- 落ち着いた無彩色のベースに、データだけが色を持つ業務ダッシュボード。
|
|
81
|
-
- 装飾より読みやすさを優先する。影・グラデーション・アニメーションは最小限。
|
|
82
|
-
- 数字が主役。1 画面で伝えたいことを 1 つに絞り、補足は小さく添える。
|
|
83
|
-
- ブランド素材: なし(ロゴを使う場合は `public/brand/logo.svg` のように `public/` 配下のパスで書く)
|
|
84
|
-
|
|
85
|
-
## 色 (Colors)
|
|
86
|
-
|
|
87
|
-
色は必ずトークン(Tailwind のセマンティッククラス)で指定する。素のパレット(`bg-blue-600` など)や
|
|
88
|
-
色コードを直接書かない。
|
|
89
|
-
|
|
90
|
-
| 役割 | トークン | 使う場所 |
|
|
91
|
-
| --- | --- | --- |
|
|
92
|
-
| 主色 (Primary) | `--primary` / `--primary-foreground` | 主要ボタン、選択中の状態。既定は無彩色 |
|
|
93
|
-
| 強調 (Accent) | `--chart-1` | 1 つだけ目立たせたい数値・系列・リンク的な強調 |
|
|
94
|
-
| 良い (Positive) | `--chart-2` | 前期比のプラスなど、良い変化の小さな印 |
|
|
95
|
-
| 悪い (Negative) | `--destructive` | 前期比のマイナス、エラー、削除操作 |
|
|
96
|
-
| 注意 (Warning) | 専用トークンなし | 文言とアイコンで示し、色は `--muted-foreground` |
|
|
97
|
-
| 背景の段階 | `--background` → `--card` → `--muted` | ページ → カード → カード内の区画・ホバー |
|
|
98
|
-
| 境界 | `--border` / `--input` / `--ring` | 罫線、入力欄、フォーカス |
|
|
99
|
-
| 文字 | `--foreground` / `--muted-foreground` | 本文 / 補足・ラベル・単位 |
|
|
100
|
-
|
|
101
|
-
- `--muted`・`--accent`・`--secondary`・`--border` は背景・境界用。文字色に使わない。
|
|
102
|
-
- 増減(▲▼・前期比)は向きで色を分ける: 増加・プラスは `--chart-2`(または `--primary`)、
|
|
103
|
-
減少・マイナスは `--destructive`。下向きの矢印やマイナスを `--primary` で塗らない。
|
|
104
|
-
- ライトとダークの両方がトークンで決まるので `dark:` を並べない。
|
|
105
|
-
|
|
106
|
-
## チャート (Charts)
|
|
107
|
-
|
|
108
|
-
- 系列の順番は `--chart-1` → `--chart-2` → `--chart-3` → `--chart-4` → `--chart-5`
|
|
109
|
-
(現在はプリセット `blue`: 青 → ティール → フクシア → バイオレット → グレー)。
|
|
110
|
-
- 1 系列だけを目立たせるときは、その系列を `--chart-1`、残りをすべて `--chart-5`(グレー)にする。
|
|
111
|
-
- 良い / 悪いを色で塗り分けるときは `--chart-2` / `--destructive`。色だけに頼らず ▲▼ や符号も添える。
|
|
112
|
-
- 系列は 5 つまで。それ以上はグループ化するか「その他」にまとめる。
|
|
113
|
-
- 禁止: 同じチャートで `--destructive` を普通の系列色として使う(悪い値に見える)。
|
|
114
|
-
- 禁止: 隣り合う系列に `--chart-3` と `--chart-4` を並べて細い線で描く(見分けにくい)。
|
|
115
|
-
- 配色を丸ごと変えるときは `npx @squadbase/vantage-template theme <id>` を使う
|
|
116
|
-
(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)。チャートだけ別の配色にするときは
|
|
117
|
-
`chart <preset>`(`blue` / `ocean` / `sunset` / `forest` / `berry` / `mono`)。
|
|
118
|
-
|
|
119
|
-
## 書体 (Typography)
|
|
120
|
-
|
|
121
|
-
| 用途 | 指定 | 備考 |
|
|
122
|
-
| --- | --- | --- |
|
|
123
|
-
| 見出し・本文 | 日本語を含むシステムフォント(`--font-sans`) | Web フォントは使わない |
|
|
124
|
-
| 数字 | 同上 + `tabular-nums` | 桁がそろうように必ず付ける |
|
|
125
|
-
| スライドの見出し | `--slide-font-display` | 既定は日本語を含むシステムフォント |
|
|
126
|
-
| スライドの本文 | `--slide-font-body` | 既定は見出しと同じ |
|
|
127
|
-
|
|
128
|
-
サイズの段階(ダッシュボード):
|
|
129
|
-
|
|
130
|
-
- ページ見出し: `text-2xl font-bold`
|
|
131
|
-
- カード見出し・ラベル: `text-sm font-medium text-muted-foreground`
|
|
132
|
-
- KPI の数値: `text-3xl font-semibold tabular-nums`
|
|
133
|
-
- 本文・表: `text-sm`
|
|
134
|
-
- 注釈・出典: `text-xs text-muted-foreground`
|
|
135
|
-
|
|
136
|
-
スライドのサイズは `--slide-size-hero`(表紙・大きな数字)と `--slide-size-body`(本文)を基準にする。
|
|
137
|
-
|
|
138
|
-
## レイアウトと密度 (Layout)
|
|
139
|
-
|
|
140
|
-
- 情報はカード(`bg-card` + `border-border`)で区切る。角丸は `--radius` に従う(個別に変えない)。
|
|
141
|
-
- グリッドの間隔は `gap-4`。セクション間は `gap-6` 程度。
|
|
142
|
-
- KPI は 1 行に 2〜4 枚。その下にチャート、最後に明細の表。
|
|
143
|
-
- 密度は「中」。余白を削って詰め込むより、ページを分ける。
|
|
144
|
-
|
|
145
|
-
## 成果物の種類ごとの規則 (Per-artifact)
|
|
146
|
-
|
|
147
|
-
### ダッシュボード
|
|
148
|
-
|
|
149
|
-
- 先頭に KPI カード、次にトレンドのチャート、最後に明細の表。
|
|
150
|
-
- 各 KPI には比較対象(前月比・目標比など)を 1 つ添える。
|
|
151
|
-
- チャートのタイトルは結論を書く(「売上推移」より「売上は 3 か月連続で増加」)。
|
|
152
|
-
|
|
153
|
-
### スライド
|
|
154
|
-
|
|
155
|
-
- 1 枚に 1 メッセージ。見出しに結論を書く。
|
|
156
|
-
- 色は `--slide-bg` / `--slide-fg` / `--slide-accent` / `--slide-muted` を使う
|
|
157
|
-
(既定では `--background` / `--foreground` / `--primary` / `--muted-foreground` に連動)。
|
|
158
|
-
- 強調色は 1 枚につき 1 か所まで。
|
|
159
|
-
|
|
160
|
-
## Do / Don't
|
|
161
|
-
|
|
162
|
-
Do:
|
|
163
|
-
|
|
164
|
-
- トークンと Tailwind のセマンティッククラスで色を指定する。
|
|
165
|
-
- 数値には単位と比較対象を付ける。
|
|
166
|
-
- 色の意味(良い / 悪い / 強調)をアプリ全体でそろえる。
|
|
167
|
-
|
|
168
|
-
Don't:
|
|
169
|
-
|
|
170
|
-
- 色コードや素のパレットクラスを直接書く。
|
|
171
|
-
- 1 画面で強調色を何か所にも使う。
|
|
172
|
-
- 3D チャート・円グラフの多用・装飾目的のグラデーション。
|
|
173
|
-
````
|
|
1
|
+
# 任意の DESIGN.md
|
|
2
|
+
|
|
3
|
+
`DESIGN.md` は、プロジェクトルートに置く**ユーザー所有の任意のファイル**。新規プロジェクトには作らない。
|
|
4
|
+
ユーザーが望んだときだけ、ユーザー固有の意図(密度・スライドの見出し方針・ブランド素材など)を書く。
|
|
5
|
+
|
|
6
|
+
- 色・書体・角丸の値と色の割り当ては書かない。テーマ(`styles.css`、ThemeDialog、CLI の `theme` / `chart`)が持つ。
|
|
7
|
+
デザイン変更の依頼を `DESIGN.md` に記録しない。
|
|
8
|
+
- 見た目の規則は `AGENTS.md` の「見た目の規約」節が正本。`DESIGN.md` はそれに**加えて**従われる。
|
|
9
|
+
色の割り当てが食い違うときはテーマを優先する。
|
|
10
|
+
- 既存の `DESIGN.md` は消さない。`vantage upgrade` も `vantage add agents` も書き換えない。
|
|
11
|
+
- 150 行以内(超えると `vantage check` が `DESIGN_MD_TOO_LONG` を警告する)。YAML frontmatter は付けない。
|
|
12
|
+
- ロゴ・画像は `public/` 配下のパスで参照する(`public/brand/logo.svg`)。
|
|
@@ -48,13 +48,3 @@ npx @squadbase/vantage-template theme ocean --reset-chart # chart コマンド
|
|
|
48
48
|
**`/* squadkit-theme:end */`(チャート範囲があればその終端)より後ろ**に、変えたいトークンだけ
|
|
49
49
|
`:root` と `.dark, [data-theme="dark"]` の**両方**に書く。前に書くとテーマに負ける。
|
|
50
50
|
`scripts/contrast.mjs` で `--primary-foreground` / `--primary` をライトとダークで確かめる。
|
|
51
|
-
|
|
52
|
-
## DESIGN.md
|
|
53
|
-
|
|
54
|
-
`format.md` の雛形から作り、選んだテーマに合わせて次の行だけ書き換える。
|
|
55
|
-
|
|
56
|
-
- 「全体のトーン」: 上の表のトーンを 2〜3 行に。
|
|
57
|
-
- 主色の行: テーマの主色の色味(「青」「橙」など。**色コードは書かない**)。
|
|
58
|
-
- チャートの色味: テーマの `--chart-1..5` の並び(適用後の `styles.css` を見る)。
|
|
59
|
-
- 良い / 悪い / 注意: 専用トークンは無い。`--chart-*` から割り当てるか「専用トークンなし」と書く。
|
|
60
|
-
`--destructive` を普通の系列色に使わない。
|
|
@@ -94,6 +94,11 @@ Base UI の `SelectValue` は選択中の **value をそのまま描き**、`Sel
|
|
|
94
94
|
- 表示ルート `/sales/:customerId`
|
|
95
95
|
- リンク `to="/sales/$customerId"` + `params={{ customerId }}` / 取り出し `useParams().customerId`
|
|
96
96
|
|
|
97
|
+
## 日本語アプリは `lang` を指定する
|
|
98
|
+
|
|
99
|
+
ルート `src/_layout.tsx` に `export const lang = "ja"`(リテラル)が無いと `<html lang="en">` のままで、
|
|
100
|
+
スライドの見出しが文節の途中で折れる。内容が日本語なら必ず指定する。
|
|
101
|
+
|
|
97
102
|
## ページ:`definePage` の値はリテラルで書く
|
|
98
103
|
|
|
99
104
|
title/description/navLabel は**ビルド時に静的抽出**される。変数・関数呼び出し・テンプレート補間を
|
|
@@ -43,9 +43,8 @@ export default function JuneDeck() {
|
|
|
43
43
|
|
|
44
44
|
- **1 ファイル = 1 デッキ = 1 ルート。** `export default` は `<SlideDeck>` を返す React コンポーネント
|
|
45
45
|
(通常のページと同じ契約なので、`vantage check` も `vantage routes` も特別扱いをしません)。
|
|
46
|
-
-
|
|
47
|
-
|
|
48
|
-
テンプレート補間は不可)。ナビの表示名はこれで決まります。
|
|
46
|
+
- **ファイル形式の MUST / SHOULD(`<Slide>` は `<SlideDeck>` の直下、`<Step>` は `<Steps>` の直下、
|
|
47
|
+
`definePage` はリテラル など)は `agents/slide.md` と `agents/page.md` が正本**です。ここでは繰り返しません。
|
|
49
48
|
- **`.slide` を付けられるのはルートになるページモジュールだけ。** `_layout.slide.tsx` や
|
|
50
49
|
`deck.slide.ts` は `INVALID_PAGE_VARIANT` エラーになります。
|
|
51
50
|
- **`june.slide.tsx` と `june.tsx` は同じ URL** になるので `ROUTE_CONFLICT` です。どちらかを消すこと。
|
|
@@ -56,10 +55,24 @@ export default function JuneDeck() {
|
|
|
56
55
|
スライド専用のコンポーネントを `components/` に切り出すと、デッキ 1 本を読むのに 2 ファイル
|
|
57
56
|
追わせることになります。
|
|
58
57
|
|
|
58
|
+
## まず block を探す
|
|
59
|
+
|
|
60
|
+
1 枚分の中身は、手で組む前に `@squadbase/vantage/slide` の block(`SlideCover` `SlideExecSummary`
|
|
61
|
+
`SlideKpiHero` `SlideKpiGrid` `SlideChartInsight` `SlideScorecardTable` `SlideNextActions` `SlideSection` `SlideComparison` `SlideChartFull`)に
|
|
62
|
+
合うものがないか探します。`<Slide>` の**中**に置き、props は `vantage docs <name>`(例:
|
|
63
|
+
`vantage docs slide-cover`)で引く。一覧は `agents/slide.md` が正本です。
|
|
64
|
+
- props は block 間で共通: `value: number | null` + `format`(上書きだけ `display`)、`delta: { value, format? }` + `betterWhen` + `comparisonLabel`、`target: number`、`source` は文字列、`asOf` は日付だけ(「時点」は block が付ける)。
|
|
65
|
+
|
|
66
|
+
- block は `@squadbase/vantage/slide` から import する。**新しい import 元は増えない**(下の
|
|
67
|
+
「import してよいもの」と矛盾しない)。`vantage add` でコピーするものでもない。
|
|
68
|
+
- block が合わない**1 枚だけ**を、この下の規約で手書きする。デッキ全体を手書きに切り替えない。
|
|
69
|
+
- デッキ以外のファイルは作らない。block を使っても、デッキは 1 ファイルのままで、独自の
|
|
70
|
+
ヘルパーコンポーネントは同じ `.slide.tsx` に書く。
|
|
71
|
+
|
|
59
72
|
## import してよいもの
|
|
60
73
|
|
|
61
74
|
- `@squadbase/vantage/slide` — `SlideDeck` `Slide` `Steps` `Step` `MorphElement` `useSlideNumber`
|
|
62
|
-
`useIsActiveSlide` `SlideCanvas`
|
|
75
|
+
`useIsActiveSlide` `SlideCanvas`、1 枚分の block(`SlideCover` ほか上の 10 個)、手書きの 1 枚に使う部品(`SlideHeading` `SlideSourceLine` `SlideColumns` `SlideColumn` `DeltaText`)と、その型
|
|
63
76
|
- `@squadbase/vantage` — `definePage`
|
|
64
77
|
- `@squadbase/vantage/components` の `EChart` — **チャートを載せるときはこれ**(→「チャート」)
|
|
65
78
|
- `lucide-react` のアイコン
|
|
@@ -77,21 +90,25 @@ export default function JuneDeck() {
|
|
|
77
90
|
- 各スライドのルート要素はキャンバスを埋める(`width: "100%"; height: "100%"`)
|
|
78
91
|
- インライン `style={{ … }}` を使う。読み込んだ CSS はグローバルです
|
|
79
92
|
|
|
80
|
-
|
|
93
|
+
以下の値がスライドの規約です。ヒーローと本文は `var(--slide-size-hero)` /
|
|
94
|
+
`var(--slide-size-body)` としても読めます(→ `references/tokens.md`)。
|
|
95
|
+
|
|
96
|
+
### タイプスケール
|
|
81
97
|
|
|
82
98
|
| 要素 | サイズ |
|
|
83
99
|
| --- | --- |
|
|
84
|
-
| ヒーロータイトル |
|
|
85
|
-
| セクション見出し |
|
|
86
|
-
| ページ見出し |
|
|
87
|
-
| 本文 |
|
|
88
|
-
| キャプション / ラベル |
|
|
100
|
+
| ヒーロータイトル | 168px |
|
|
101
|
+
| セクション見出し | 88px |
|
|
102
|
+
| ページ見出し | 64px |
|
|
103
|
+
| 本文 | 36px |
|
|
104
|
+
| キャプション / ラベル | 24px |
|
|
89
105
|
|
|
90
|
-
###
|
|
106
|
+
### 余白とグリッド
|
|
91
107
|
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
-
|
|
108
|
+
- セーフエリア: キャンバス端から **左右 160px・上下 120px**。中身はこの内側の **1600 × 840px** に置き、文字を端に触れさせない
|
|
109
|
+
- グリッド: 内容幅 1600px を **12 列**(列幅 104px・溝 32px)に割る
|
|
110
|
+
- line-height: 見出し 1.2、本文 1.6
|
|
111
|
+
- 要素間: 32 / 48 / 64px のどれか
|
|
95
112
|
|
|
96
113
|
### 縦方向の予算 — 中身は 1080px に収まらなければならない
|
|
97
114
|
|
|
@@ -99,33 +116,32 @@ export default function JuneDeck() {
|
|
|
99
116
|
計算して収まることを確かめること。**これがスライドが壊れる原因の第 1 位**で、確かめない限り
|
|
100
117
|
溢れていると思ってください。
|
|
101
118
|
|
|
102
|
-
**使える高さ** = `1080 −
|
|
103
|
-
先に padding を決めて、その予算の中で設計します。
|
|
119
|
+
**使える高さ** = `1080 − 上下のセーフエリア(120px × 2)` = **840px**。この予算の中で設計します。
|
|
104
120
|
|
|
105
121
|
**要素の高さ** = `文字サイズ × line-height × 行数`。2 行に折り返す箇条書きは 2 行と数えます。
|
|
106
|
-
次の要素を足す前に、その下の gap(32
|
|
122
|
+
次の要素を足す前に、その下の gap(32 / 48 / 64px)を加算してください。
|
|
107
123
|
|
|
108
|
-
**計算例 — 本文 1
|
|
124
|
+
**計算例 — 本文 1 枚(予算 840px):**
|
|
109
125
|
|
|
110
126
|
| 要素 | 高さ |
|
|
111
127
|
| --- | --- |
|
|
112
|
-
|
|
|
128
|
+
| ページ見出し: 64px × 1.2 × 1 行 | 76.8px |
|
|
113
129
|
| gap | 64px |
|
|
114
|
-
| 本文:
|
|
130
|
+
| 本文: 36px × 1.6 × 3 行 | 172.8px |
|
|
115
131
|
| gap | 48px |
|
|
116
|
-
| 箇条書き 5 行:
|
|
117
|
-
| 箇条書き間の gap 4 つ:
|
|
118
|
-
| **合計** | **
|
|
132
|
+
| 箇条書き 5 行: 36px × 1.6 × 1 行 | 288px(5 × 57.6px) |
|
|
133
|
+
| 箇条書き間の gap 4 つ: 32px | 128px |
|
|
134
|
+
| **合計** | **777.6px ✅ 840 に収まる** |
|
|
119
135
|
|
|
120
|
-
|
|
136
|
+
箇条書きを 6 つにすると 867.2px で溢れます。**書く前に毎ページこの検算をすること。**
|
|
121
137
|
|
|
122
138
|
**ページ単位の規則:**
|
|
123
139
|
|
|
124
140
|
- 「見出し + 本文」か「見出し + 5 つ以内の短い箇条書き」のどちらか。両方は載せない
|
|
125
141
|
- 箇条書きは選んだ文字サイズで 1 行に収まること。折り返すなら短くするか別ページに割る
|
|
126
|
-
- ヒーロータイトル(
|
|
127
|
-
- セクション見出し(
|
|
128
|
-
-
|
|
142
|
+
- ヒーロータイトル(168px)はタイトル + サブタイトル 1 行 + アイブロウまで。それ以外は載せない
|
|
143
|
+
- セクション見出し(88px)のページにはほとんど何も足さない
|
|
144
|
+
- 収めるためにセーフエリアを削る・タイプスケールより小さい文字にする・本文の line-height を 1.6 未満に
|
|
129
145
|
詰める、をやりたくなったら**ページを 2 枚に割る**。予算が厳しいときは分割が常に正解
|
|
130
146
|
|
|
131
147
|
**`overflow: auto/scroll`・負のマージン・transform で溢れを隠さないこと。** キャンバスは固定で、
|
|
@@ -139,7 +155,7 @@ export default function JuneDeck() {
|
|
|
139
155
|
それ以外はプレーンな const にする(→ `references/tokens.md`)
|
|
140
156
|
- **書体** — ディスプレイ 1 + 本文 1。指定がなければシステムスタック。見出しは太く(800–900)、
|
|
141
157
|
本文は通常(400–500)
|
|
142
|
-
- **レイアウトグリッド** —
|
|
158
|
+
- **レイアウトグリッド** — セーフエリアと 12 列グリッド(→「余白とグリッド」)を全ページで貫く。左揃えは編集的、中央揃えは儀礼的
|
|
143
159
|
- **美学のコミットメント** — 1 つ選ぶ: ミニマル / マキシマル / エディトリアル / レトロ /
|
|
144
160
|
ブルータリスト / ソフト・パステル / ネオン / 紙・印刷。混ぜない
|
|
145
161
|
|
|
@@ -152,12 +168,12 @@ export default function JuneDeck() {
|
|
|
152
168
|
// ✅ 各カードが独自の JSX ノードを持つ
|
|
153
169
|
const Card = ({ label, value }: { label: string; value: string }) => (
|
|
154
170
|
<div style={{ flex: 1 }}>
|
|
155
|
-
<div style={{ fontSize:
|
|
156
|
-
<div style={{ fontSize:
|
|
171
|
+
<div style={{ fontSize: 24, opacity: 0.6 }}>{label}</div>
|
|
172
|
+
<div style={{ fontSize: 88, fontWeight: 800 }}>{value}</div>
|
|
157
173
|
</div>
|
|
158
174
|
)
|
|
159
175
|
|
|
160
|
-
<div style={{ display: "flex", gap:
|
|
176
|
+
<div style={{ display: "flex", gap: 64 }}>
|
|
161
177
|
<Card label="売上" value="¥5.2億" />
|
|
162
178
|
<Card label="解約率" value="1.4%" />
|
|
163
179
|
</div>
|
|
@@ -169,6 +185,8 @@ const Card = ({ label, value }: { label: string; value: string }) => (
|
|
|
169
185
|
|
|
170
186
|
これは**視覚要素が繰り返すとき**の話で、データが繰り返すときの話ではありません。純粋な
|
|
171
187
|
テキストの箇条書き(`<ul><li>`)は各 `<li>` が既に独立した JSX ノードなので、そのままで正しい。
|
|
188
|
+
`<SlideDeck>` の直下に `<Slide>` を配列で渡すこと自体はファイル形式として可能です(`agents/slide.md`)が、
|
|
189
|
+
1 枚ごとの文言・図を変えるスライドは 1 枚ずつ書きます。
|
|
172
190
|
|
|
173
191
|
## ページ番号
|
|
174
192
|
|
|
@@ -250,8 +268,8 @@ pptx 書き出しのために描き終わりを待たせる必要があります
|
|
|
250
268
|
- [ ] `export default` が `<SlideDeck>` を返している
|
|
251
269
|
- [ ] `<Slide>` が `<SlideDeck>` の直下にある
|
|
252
270
|
- [ ] 各スライドのルート要素が `100% × 100%` を埋めている
|
|
253
|
-
- [ ]
|
|
254
|
-
- [ ] **全ページで(文字サイズ × line-height × 行数)+ gap
|
|
271
|
+
- [ ] 文字がセーフエリア(左右 160px・上下 120px)の内側にある
|
|
272
|
+
- [ ] **全ページで(文字サイズ × line-height × 行数)+ gap ≤ 840px。** 際どいなら分割
|
|
255
273
|
- [ ] 箇条書きが 2 行目に折り返していない
|
|
256
274
|
- [ ] 配色とタイプスケールが全ページで一貫している
|
|
257
275
|
- [ ] 1 ページ 1 メッセージ
|
|
@@ -267,11 +285,11 @@ pptx 書き出しのために描き終わりを待たせる必要があります
|
|
|
267
285
|
## アンチパターン
|
|
268
286
|
|
|
269
287
|
- ❌ 文字の壁。1 ページ 40 語を超えたら分割する
|
|
270
|
-
- ❌
|
|
288
|
+
- ❌ キャンバス全面を本文で使う。セーフエリア(左右 160px・上下 120px)を守る
|
|
271
289
|
- ❌ 縦に 1080px を溢れさせる。切れた中身は見えない — 分割する
|
|
272
290
|
- ❌ `overflow: auto` / `scroll` / `hidden` で溢れを「隠す」。バグを隠しただけ
|
|
273
|
-
- ❌
|
|
274
|
-
- ❌
|
|
291
|
+
- ❌ 詰め込むためにタイプスケールより小さい文字にする・セーフエリアを削る
|
|
292
|
+
- ❌ 本文を 36px 未満にする。プロジェクタで読めない
|
|
275
293
|
- ❌ `@squadbase/vantage/ui` のプリミティブをスライドに置く(縮小されて読めなくなる)
|
|
276
294
|
- ❌ 依存を追加する。使えるのは `@squadbase/vantage/*` と `lucide-react` と標準 Web API だけ
|
|
277
295
|
- ❌ スライド用のコンポーネントを別ファイルに切り出す
|