@squadbase/vantage-template 0.1.1-dev1.7a4f5d9 → 0.1.1-dev1.934feaa
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 +11 -1
- package/base-template/.squadbase/skills/vantage-design/SKILL.md +27 -25
- package/base-template/.squadbase/skills/vantage-design/references/extract.md +16 -14
- package/base-template/.squadbase/skills/vantage-design/references/format.md +6 -5
- package/base-template/.squadbase/skills/vantage-design/references/presets.md +60 -110
- package/base-template/.squadbase/skills/vantage-slide/SKILL.md +54 -36
- package/base-template/AGENTS.md +2 -2
- package/base-template/DESIGN.md +7 -6
- package/base-template/agents/doc.md +48 -0
- package/base-template/agents/page.md +22 -1
- package/base-template/agents/slide.md +70 -2
- package/base-template/bun.lock +4 -4
- package/base-template/package.json +2 -2
- package/base-template/src/styles.css +105 -20
- package/dist/index.js +956 -0
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -52,11 +52,21 @@ npx @squadbase/vantage-template add funnel --force # Overwrite existing fil
|
|
|
52
52
|
|
|
53
53
|
`add` replaces the entry page, so it warns before overwriting it, and it lists leftover files from a previously applied template (it never deletes them — you may have edited them). A project with pages on *both* sides — `src/` present but `index.tsx` / `_layout.tsx` / `styles.css` still at the root — is refused with the list of files to move into `src/` first: Vantage ignores the root ones, so `vantage check` already fails there with `SRC_DIR_SPLIT`.
|
|
54
54
|
|
|
55
|
+
#### `theme <theme-id>`
|
|
56
|
+
|
|
57
|
+
Apply a SquadKit theme (`neutral`, `ocean`, `forest`, `sunset`, `violet`, `rose`, `mono`; the old `default` / `calm` / `vivid` / `mono` are accepted too). Rewrites a marked range of the project's `styles.css` with the theme's colors, radius and font for both light and dark mode, leaving everything else intact. Re-running with the same theme changes nothing. Overrides you write *after* the range win over the theme.
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
npx @squadbase/vantage-template theme ocean
|
|
61
|
+
npx @squadbase/vantage-template theme forest --dry-run
|
|
62
|
+
npx @squadbase/vantage-template theme sunset --reset-chart # drop a `chart` preset so the theme's chart colors apply
|
|
63
|
+
```
|
|
64
|
+
|
|
55
65
|
#### `chart <preset-name>`
|
|
56
66
|
|
|
57
67
|
Switch the chart color preset. Rewrites a marked block of `--chart-1`–`--chart-5` inside the project's `styles.css` (under `src/` when that layout is in use), leaving any other overrides in that file intact. Re-running replaces the block rather than stacking.
|
|
58
68
|
|
|
59
|
-
A new project starts on the `
|
|
69
|
+
A new project starts on the `neutral` theme and has no chart range; this command (or `init --chart`) adds one, which takes precedence over the theme's chart colors. `theme <id> --reset-chart` removes it again.
|
|
60
70
|
|
|
61
71
|
```bash
|
|
62
72
|
npx @squadbase/vantage-template chart ocean
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: vantage-design
|
|
3
|
-
description: Vantage(@squadbase/vantage)アプリの見た目の意図 `DESIGN.md` と、実際の値を持つ `styles.css` をまとめて作る / 更新する手順。配色・ブランドカラー・テーマ・チャートの色・フォント・角丸・トーンを変えたいとき、既存サイトやロゴ・資料・外部の DESIGN.md に合わせたいとき、プロジェクト作成時の初期デザイン(
|
|
3
|
+
description: Vantage(@squadbase/vantage)アプリの見た目の意図 `DESIGN.md` と、実際の値を持つ `styles.css` をまとめて作る / 更新する手順。配色・ブランドカラー・テーマ・チャートの色・フォント・角丸・トーンを変えたいとき、既存サイトやロゴ・資料・外部の DESIGN.md に合わせたいとき、プロジェクト作成時の初期デザイン(テーマ neutral / ocean / forest / sunset / violet / rose / mono)を決めるときに使う。「色を変えて」「ブランドに合わせて」「このサイトに合わせて」「落ち着いた感じに」「フォントを変えて」「テーマを作って」「DESIGN.md を作って」、"change the colors", "match our brand", "match this website", "theme", "color palette", "font", "design system", "DESIGN.md" で起動。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# DESIGN.md と styles.css をまとめて更新する
|
|
@@ -23,7 +23,7 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
23
23
|
| --- | --- |
|
|
24
24
|
| `references/format.md` | `DESIGN.md` を書く / 直すとき(書式・節の順番・雛形) |
|
|
25
25
|
| `references/extract.md` | URL・画像・pptx/pdf・言葉・外部 DESIGN.md から色と書体を取り出すとき |
|
|
26
|
-
| `references/presets.md` |
|
|
26
|
+
| `references/presets.md` | テーマ(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)の選び方と `theme` コマンド。旧プリセット id の読み替え |
|
|
27
27
|
| `scripts/contrast.mjs` | 文字色と背景色のコントラスト比を確かめるとき |
|
|
28
28
|
|
|
29
29
|
## 手順
|
|
@@ -43,29 +43,32 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
43
43
|
各行に「何に合わせてその色にしたか」を 1 語添える。
|
|
44
44
|
- **トーンの説明**(2〜3 行。`DESIGN.md` の「全体のトーン」にそのまま入る文)。
|
|
45
45
|
|
|
46
|
-
|
|
46
|
+
テーマで足りる場合はテーマ id(`references/presets.md`)で提案してよい。旧プリセット id(`default` / `calm` / `vivid` / `mono`)で頼まれたら新 id に読み替える。
|
|
47
47
|
|
|
48
48
|
### 3. styles.css と DESIGN.md を同じステップで書く
|
|
49
49
|
|
|
50
50
|
`styles.css`:
|
|
51
51
|
|
|
52
|
-
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
(`
|
|
58
|
-
|
|
59
|
-
-
|
|
52
|
+
- **テーマ範囲・チャート範囲のマーカーの中は手で編集しない。** 色・角丸・書体の出発点は 7 テーマ
|
|
53
|
+
(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)から選び、コマンドで当てる:
|
|
54
|
+
`npx @squadbase/vantage-template theme <id>`(プロジェクトルートで実行。`--dry-run` で書き込まずに
|
|
55
|
+
結果を見られる)。``/* squadkit-theme — regenerated by `theme`; edits here are lost */`` 〜
|
|
56
|
+
`/* squadkit-theme:end */` の間はコマンドが丸ごと書き換える生成物で、手で直した値は次の適用で消える。
|
|
57
|
+
旧プリセット id(`default` → `neutral` / `calm` → `ocean` / `vivid` → `sunset` / `mono`)もコマンドが受ける。
|
|
58
|
+
- チャートの 5 色はテーマが持つ。テーマと別の配色にしたいときだけ
|
|
59
|
+
`npx @squadbase/vantage-template chart <preset>`(`blue` / `ocean` / `sunset` / `forest` / `berry` / `mono`)を使う。
|
|
60
|
+
``/* vantage-template:chart-preset … */`` 〜 `/* vantage-template:chart-preset:end */` の間が置き換わり、
|
|
61
|
+
テーマのチャート色より優先される。テーマに揃え直すには `theme <id> --reset-chart`。
|
|
62
|
+
- プリセットに無いチャート色(ブランド色を `--chart-1` にしたいなど)は、**マーカーブロックの後ろ**に
|
|
60
63
|
別の `:root { --chart-1: …; }` と `.dark, [data-theme="dark"] { --chart-1: …; }` を足して上書きする
|
|
61
|
-
(後に書いた方が勝つ)
|
|
62
|
-
- `--primary` / `--primary-foreground` / `--radius`
|
|
63
|
-
(
|
|
64
|
-
|
|
65
|
-
(`var(--color-sky-600)`)で書く。
|
|
66
|
-
-
|
|
67
|
-
(
|
|
68
|
-
|
|
64
|
+
(後に書いた方が勝つ)。上書きするのは変えたい番号だけにし、残りはテーマに任せる。
|
|
65
|
+
- `--primary` / `--primary-foreground` / `--radius` などテーマに無い値・ブランド色の上書きも、
|
|
66
|
+
**マーカーブロックの後ろ**(ファイル末尾)に書く。マーカーより前に書いた値はテーマに負ける。
|
|
67
|
+
色は `:root` と `.dark, [data-theme="dark"]` の**両方**に書く。片方だけだとダークモードでテーマの値に
|
|
68
|
+
戻る。値は `oklch()` か Tailwind のパレット変数(`var(--color-sky-600)`)で書く。
|
|
69
|
+
- 書体は既定でシステムフォント。**ページの書体は `--font-sans`**(`styles.css` の `body` が
|
|
70
|
+
`font-family: var(--font-sans)` で参照する。テーマ範囲も `--font-sans` を持つので、書体を変えるには
|
|
71
|
+
マーカーブロックの後ろで `:root { --font-sans: …; }` を上書きする)。スライドの書体は `:root` の
|
|
69
72
|
`--slide-font-display`(見出し)/ `--slide-font-body`(本文)で決まる。Web フォントを使うときの
|
|
70
73
|
レシピ:
|
|
71
74
|
1. Google Fonts の CSS
|
|
@@ -73,13 +76,11 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
73
76
|
から使う subset の `@font-face` ブロックだけを `styles.css` の先頭に貼る。
|
|
74
77
|
**`@import url(...)` は使わない** ― `styles.css` はテーマの後ろに連結されるので
|
|
75
78
|
「@import rules must precede all rules」の警告とともにビルドで捨てられる。
|
|
76
|
-
2.
|
|
79
|
+
2. マーカーブロックの後ろに次を書く(フォールバックは `theme.css` の既定と同じ並び):
|
|
77
80
|
|
|
78
81
|
```css
|
|
79
|
-
body {
|
|
80
|
-
font-family: "<Font>", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Hiragino Sans", "Hiragino Kaku Gothic ProN", "Noto Sans JP", Meiryo, ui-sans-serif, system-ui, sans-serif;
|
|
81
|
-
}
|
|
82
82
|
:root {
|
|
83
|
+
--font-sans: "<Font>", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Hiragino Sans", "Hiragino Kaku Gothic ProN", "Noto Sans JP", Meiryo, ui-sans-serif, system-ui, sans-serif;
|
|
83
84
|
--slide-font-display: "<Font>", -apple-system, BlinkMacSystemFont, "Segoe UI", "Hiragino Kaku Gothic ProN", "Hiragino Sans", "Yu Gothic", Meiryo, system-ui, sans-serif;
|
|
84
85
|
--slide-font-body: var(--slide-font-display);
|
|
85
86
|
}
|
|
@@ -90,8 +91,9 @@ Vantage アプリの見た目は 2 つのファイルで決まる。
|
|
|
90
91
|
`ui-sans-serif` / `system-ui` は日本語の face より**後ろ**に置く。日本語の Windows ではどちらも
|
|
91
92
|
Yu Gothic UI(UI のリサイズを避けるために字幅を詰めた書体)に解決され、カナがここで決まって
|
|
92
93
|
半角風に見える。macOS の Chrome は `-apple-system` を解釈しないので `BlinkMacSystemFont` も並べる。
|
|
93
|
-
既存アプリの `styles.css` に `
|
|
94
|
-
|
|
94
|
+
既存アプリの `styles.css` の `body` に `font-family` が直書きされている(`var(--font-sans)` ではない)、
|
|
95
|
+
または `ui-sans-serif, system-ui, …` が先頭にある、`"Yu Gothic UI"` が残っているときは、
|
|
96
|
+
`body { font-family: var(--font-sans); }` に直し、書体は `--font-sans` に上の並びで書く。
|
|
95
97
|
日本語の Web フォントは face が 100 を超えるので原則使わない(pptx 書き出しも壊れる。
|
|
96
98
|
`vantage-slide` の `references/tokens.md` 参照)。
|
|
97
99
|
|
|
@@ -7,12 +7,13 @@
|
|
|
7
7
|
3. **書体**(見出しと本文の `font-family`。システムフォントで足りるか)
|
|
8
8
|
4. **トーン**(2〜3 語: 「落ち着いた」「明るい」「堅い」…)
|
|
9
9
|
|
|
10
|
-
チャートの 5
|
|
11
|
-
`npx @squadbase/vantage-template
|
|
12
|
-
配慮が済んでいる)
|
|
10
|
+
チャートの 5 色は、主色から直接作るより**主色に最も近いテーマ**を選び、
|
|
11
|
+
`npx @squadbase/vantage-template theme <id>` で適用する方が安全(5 色の明度差・色覚多様性への
|
|
12
|
+
配慮が済んでいる)。テーマと別のチャート配色が要るときは `chart <preset>`。`styles.css` の
|
|
13
|
+
`squadkit-theme` / `vantage-template:chart-preset` のマーカーブロックの中は
|
|
13
14
|
**手で編集しない**(次の適用で消える)。主色を `--chart-1` に入れたいときだけ、マーカーブロックの
|
|
14
15
|
**後ろ**に `:root` と `.dark, [data-theme="dark"]` の `--chart-1` 上書きを足し、残り 4 色は
|
|
15
|
-
プリセットに任せる。`--primary` や `--radius`
|
|
16
|
+
プリセットに任せる。`--primary` や `--radius` はマーカーブロックの後ろに書く。
|
|
16
17
|
|
|
17
18
|
## URL(既存サイトに合わせる)
|
|
18
19
|
|
|
@@ -36,7 +37,7 @@ grep -oE 'font-family:[^;]+' /tmp/site.css | sort | uniq -c | sort -rn | head
|
|
|
36
37
|
3. **ボタン・リンクの色**: `a {` `.btn` `button` `[class*=primary]` のセレクタの `color` /
|
|
37
38
|
`background-color`。出現回数の多い有彩色が主色。
|
|
38
39
|
4. **背景**: `body` / `html` の `background`。暗ければ「暗い基調」。
|
|
39
|
-
5. **書体**: `body` の `font-family
|
|
40
|
+
5. **書体**: `body` の `font-family`(書き込み先は `--font-sans`)。Google Fonts の `<link>` があればその family 名。
|
|
40
41
|
|
|
41
42
|
注意:
|
|
42
43
|
|
|
@@ -66,18 +67,19 @@ grep -oE 'font-family:[^;]+' /tmp/site.css | sort | uniq -c | sort -rn | head
|
|
|
66
67
|
|
|
67
68
|
## 言葉だけ(「落ち着いた感じに」)
|
|
68
69
|
|
|
69
|
-
形容詞を `presets.md` の
|
|
70
|
+
形容詞を `presets.md` の 7 テーマに寄せ、そのうえで主色だけを調整する。
|
|
70
71
|
|
|
71
72
|
| 言われたこと | 出発点 |
|
|
72
73
|
| --- | --- |
|
|
73
|
-
| 落ち着いた・信頼感・堅い・経営向け・青系 | `
|
|
74
|
-
| 明るい・元気・勢い・暖かい・営業向け | `
|
|
74
|
+
| 落ち着いた・信頼感・堅い・経営向け・青系 | `ocean` |
|
|
75
|
+
| 明るい・元気・勢い・暖かい・営業向け | `sunset` |
|
|
75
76
|
| シンプル・モノクロ・印刷する・資料に貼る | `mono` |
|
|
76
|
-
| 特に無し・標準・おまかせ | `
|
|
77
|
-
| 自然・環境・緑 | `
|
|
78
|
-
|
|
|
77
|
+
| 特に無し・標準・おまかせ | `neutral` |
|
|
78
|
+
| 自然・環境・緑 | `forest` |
|
|
79
|
+
| 華やか・ポップ・紫 | `violet` |
|
|
80
|
+
| 華やか・ポップ・ピンク | `rose` |
|
|
79
81
|
|
|
80
|
-
当てはまらない言葉は、2 案(例: `
|
|
82
|
+
当てはまらない言葉は、2 案(例: `ocean` と `neutral`)を並べて選んでもらう。
|
|
81
83
|
|
|
82
84
|
## 外部の DESIGN.md(Stitch などが書いたもの)
|
|
83
85
|
|
|
@@ -99,8 +101,8 @@ Vantage の `DESIGN.md` は値を持たないので、**値を `styles.css` へ
|
|
|
99
101
|
| error | `--destructive` |
|
|
100
102
|
| success / warning | 専用トークンなし → `--chart-*` のどれかに割り当てて `DESIGN.md` に書く |
|
|
101
103
|
| radius / corner | `--radius` |
|
|
102
|
-
| display / headline font | `--slide-font-display`(+ ページの見出しなら
|
|
103
|
-
| body font |
|
|
104
|
+
| display / headline font | `--slide-font-display`(+ ページの見出しなら `--font-sans`) |
|
|
105
|
+
| body font | `--font-sans`(ページ本文)と `--slide-font-body` |
|
|
104
106
|
|
|
105
107
|
3. `styles.css` のマーカーブロックの外に、`:root` と `.dark, [data-theme="dark"]` の両方で書く
|
|
106
108
|
(チャート色・書体の書き方は SKILL.md の手順 3)。外部の DESIGN.md に
|
|
@@ -50,8 +50,8 @@ Components → 「成果物の種類ごとの規則」/ Do's and Don'ts。値は
|
|
|
50
50
|
|
|
51
51
|
- `--muted` `--accent` `--secondary` `--border` は背景・境界用。文字色の役割に割り当てない。
|
|
52
52
|
- 良い / 注意の専用トークンは無い。`--chart-*` の中から割り当てるか、「専用トークンなし」と書く。
|
|
53
|
-
-
|
|
54
|
-
|
|
53
|
+
- ページ本文の書体は `--font-sans`(`styles.css` の `body` が `font-family: var(--font-sans)` で参照する。
|
|
54
|
+
テーマを当てると `--font-sans` もテーマの値になる。変えるときはテーマ範囲のマーカーの後ろで上書きする)。
|
|
55
55
|
- `--slide-bg` などは既定で `--background` などの別名。`.dark` に書き直す必要は無い。
|
|
56
56
|
|
|
57
57
|
## 雛形(中立の既定テーマ)
|
|
@@ -112,14 +112,15 @@ DESIGN.md — このアプリの「見た目の意図」を書くファイルで
|
|
|
112
112
|
- 系列は 5 つまで。それ以上はグループ化するか「その他」にまとめる。
|
|
113
113
|
- 禁止: 同じチャートで `--destructive` を普通の系列色として使う(悪い値に見える)。
|
|
114
114
|
- 禁止: 隣り合う系列に `--chart-3` と `--chart-4` を並べて細い線で描く(見分けにくい)。
|
|
115
|
-
- 配色を丸ごと変えるときは `npx @squadbase/vantage-template
|
|
116
|
-
(`
|
|
115
|
+
- 配色を丸ごと変えるときは `npx @squadbase/vantage-template theme <id>` を使う
|
|
116
|
+
(`neutral` / `ocean` / `forest` / `sunset` / `violet` / `rose` / `mono`)。チャートだけ別の配色にするときは
|
|
117
|
+
`chart <preset>`(`blue` / `ocean` / `sunset` / `forest` / `berry` / `mono`)。
|
|
117
118
|
|
|
118
119
|
## 書体 (Typography)
|
|
119
120
|
|
|
120
121
|
| 用途 | 指定 | 備考 |
|
|
121
122
|
| --- | --- | --- |
|
|
122
|
-
| 見出し・本文 | 日本語を含むシステムフォント(
|
|
123
|
+
| 見出し・本文 | 日本語を含むシステムフォント(`--font-sans`) | Web フォントは使わない |
|
|
123
124
|
| 数字 | 同上 + `tabular-nums` | 桁がそろうように必ず付ける |
|
|
124
125
|
| スライドの見出し | `--slide-font-display` | 既定は日本語を含むシステムフォント |
|
|
125
126
|
| スライドの本文 | `--slide-font-body` | 既定は見出しと同じ |
|
|
@@ -1,110 +1,60 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
-
|
|
49
|
-
|
|
50
|
-
- `--primary`
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
}
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
- `DESIGN.md` の差分: 「全体のトーン」を上の文に。チャートの色味を「スカイ → シアン → インディゴ →
|
|
65
|
-
ティール → スレート」に。良い = `--chart-4`(ティール)。1 系列の強調は `--chart-1` + 残り `--chart-5`。
|
|
66
|
-
禁止: `--chart-1` と `--chart-2` を隣り合う細い線で並べる(どちらも明るい青系)。
|
|
67
|
-
|
|
68
|
-
## `vivid`
|
|
69
|
-
|
|
70
|
-
- トーン: 明るく勢いのある暖色。KPI とトレンドを大きく見せ、強調色をはっきり使う。
|
|
71
|
-
- チャート: `sunset`(オレンジ → アンバー → ローズ → イエロー → ストーン)。
|
|
72
|
-
- `--primary`(オレンジ 600 は白文字で 4.5:1 に届かないので 700 を使う):
|
|
73
|
-
|
|
74
|
-
```css
|
|
75
|
-
:root {
|
|
76
|
-
--primary: var(--color-orange-700);
|
|
77
|
-
--primary-foreground: oklch(0.985 0 0);
|
|
78
|
-
}
|
|
79
|
-
.dark,
|
|
80
|
-
[data-theme="dark"] {
|
|
81
|
-
--primary: var(--color-orange-400);
|
|
82
|
-
--primary-foreground: oklch(0.205 0 0);
|
|
83
|
-
}
|
|
84
|
-
```
|
|
85
|
-
|
|
86
|
-
- `DESIGN.md` の差分: トーンを上の文に。主色の行を「濃いオレンジ」に。良い = 専用色なし(▲ と
|
|
87
|
-
`--foreground`)、悪い = `--destructive`。禁止: `--chart-3`(ローズ)と `--destructive` を同じ
|
|
88
|
-
チャートに置く(悪い値と区別できない)。1 系列の強調は `--chart-1` + 残り `--chart-5`。
|
|
89
|
-
|
|
90
|
-
## `mono`
|
|
91
|
-
|
|
92
|
-
- トーン: 白黒と灰色だけ。色で意味を運ばず、太さ・順番・ラベルで読ませる。
|
|
93
|
-
- チャート: `mono`(ジンク 900 → 200。ダークでは反転)。
|
|
94
|
-
- `--primary`(チャートの両端と同じジンク):
|
|
95
|
-
|
|
96
|
-
```css
|
|
97
|
-
:root {
|
|
98
|
-
--primary: var(--color-zinc-900);
|
|
99
|
-
--primary-foreground: oklch(0.985 0 0);
|
|
100
|
-
}
|
|
101
|
-
.dark,
|
|
102
|
-
[data-theme="dark"] {
|
|
103
|
-
--primary: var(--color-zinc-200);
|
|
104
|
-
--primary-foreground: oklch(0.205 0 0);
|
|
105
|
-
}
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
- `DESIGN.md` の差分: トーンを上の文に。強調 = `--chart-1`(最も濃い灰)。良い = 専用色なし(▲ と
|
|
109
|
-
符号)、悪い = `--destructive`(**画面で唯一の有彩色**として使う)。チャートは系列を 3 つまでにし、
|
|
110
|
-
それ以上は直接ラベルを付ける。禁止: 隣り合う `--chart-4` と `--chart-5`(明度差が小さい)。
|
|
1
|
+
# 初期デザイン(テーマ)
|
|
2
|
+
|
|
3
|
+
プロジェクトの見た目の出発点は、SquadKit の 7 テーマから選ぶ。**テーマ id はプロジェクト作成の
|
|
4
|
+
ワークフローが参照するので変えないこと。** テーマは主色・背景・文字・境界・チャート 5 色・角丸・書体を
|
|
5
|
+
まとめて持つ(ライトとダークの両方)。
|
|
6
|
+
|
|
7
|
+
| id | トーン | 向く場面 |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| `neutral` | 既定。Vantage の素の見た目(青の主色と無彩色の面) | 迷ったとき・おまかせ |
|
|
10
|
+
| `ocean` | 青を基調にした落ち着いた信頼感。角丸はやや小さめ | 報告書・経営向け |
|
|
11
|
+
| `forest` | 緑を基調にした自然な印象。丸ゴシック系の書体、角丸はやや小さめ | 環境・ヘルスケア・自然 |
|
|
12
|
+
| `sunset` | 橙を基調にした温かみ。角丸はやや大きめ | 営業・マーケティング |
|
|
13
|
+
| `violet` | 紫を基調にしたやわらかい印象。角丸は大きめ | 華やかさ・ポップ |
|
|
14
|
+
| `rose` | 赤紫からピンクの落ち着いた色。角丸は大きめ(`--destructive` の赤とは別の色) | 華やかさ・ポップ |
|
|
15
|
+
| `mono` | 無彩色寄り。チャートも彩度を抑え、角丸は最小。等幅フォント | 印刷・資料への貼り付け |
|
|
16
|
+
|
|
17
|
+
## 当てる
|
|
18
|
+
|
|
19
|
+
プロジェクトルートで次を実行する。`--dry-run` で書き込まずに結果を見られる。
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx @squadbase/vantage-template theme <id>
|
|
23
|
+
npx @squadbase/vantage-template theme ocean --reset-chart # chart コマンドで選んだ配色を捨て、テーマのチャート色に揃える
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
- `styles.css` の ``/* squadkit-theme — regenerated by `theme`; edits here are lost */`` 〜
|
|
27
|
+
`/* squadkit-theme:end */` の範囲(テーマ範囲)だけを差し替える。**範囲の中は手で編集しない**。
|
|
28
|
+
マーカーが無いファイルには自動で足される。同じ id を再実行しても変わらない。
|
|
29
|
+
- テーマ範囲はファイル先頭の `:root` より後ろに置かれ、同じ詳細度なら後ろが勝つ。
|
|
30
|
+
先頭の `:root` に手書きした `--primary` などはテーマに負ける。
|
|
31
|
+
- `chart <preset>` の範囲(`--chart-*` だけ)はテーマ範囲の**後ろ**に置かれ、テーマのチャート色に勝つ。
|
|
32
|
+
チャートの配色もテーマに任せるなら `--reset-chart` で外す。
|
|
33
|
+
|
|
34
|
+
## 旧プリセット id の読み替え
|
|
35
|
+
|
|
36
|
+
古い呼び出しの `default` / `calm` / `vivid` / `mono` は、`theme` コマンドがそのまま受けて次の id として扱う。
|
|
37
|
+
|
|
38
|
+
| 旧 | 新 |
|
|
39
|
+
| --- | --- |
|
|
40
|
+
| `default` | `neutral` |
|
|
41
|
+
| `calm` | `ocean` |
|
|
42
|
+
| `vivid` | `sunset` |
|
|
43
|
+
| `mono` | `mono` |
|
|
44
|
+
|
|
45
|
+
## テーマに無い値(ブランド色など)
|
|
46
|
+
|
|
47
|
+
テーマの `--primary` を変えたい、特定の色だけブランドに合わせたい、というときは、テーマを当てたうえで
|
|
48
|
+
**`/* squadkit-theme:end */`(チャート範囲があればその終端)より後ろ**に、変えたいトークンだけ
|
|
49
|
+
`:root` と `.dark, [data-theme="dark"]` の**両方**に書く。前に書くとテーマに負ける。
|
|
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` を普通の系列色に使わない。
|
|
@@ -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
|
- ❌ スライド用のコンポーネントを別ファイルに切り出す
|
package/base-template/AGENTS.md
CHANGED
|
@@ -95,8 +95,8 @@ root/
|
|
|
95
95
|
| `@squadbase/vantage/ui` | shadcn/ui(Base UI バリアント)プリミティブ(`Button`・`Loading`・`ErrorState`・`Empty` ほか) |
|
|
96
96
|
| `@squadbase/vantage/components` | 複合パーツ(`PageShell`・`DashboardCardPreset`・`DataTablePreset`、KPI の `KpiCard`・`Delta`、型付きチャート `LineChart`・`BarChart`・`AreaChart`・`DonutChart`・`BarList` ほか、`EChart`、書式の `formatValue`) |
|
|
97
97
|
| `@squadbase/vantage/table` | `FilePageView`・`TableViewer`(データファイルページの表ビューア) |
|
|
98
|
-
| `@squadbase/vantage/slide` | `SlideDeck`・`Slide`・`Steps`・`Step`・`MorphElement`・`useSlideNumber`・`useIsActiveSlide`(スライド専用。1920×1080 の固定キャンバス) |
|
|
99
|
-
| `@squadbase/vantage/doc` | `Document`(ドキュメント専用。中の素の HTML 要素に見出し・表などのスタイルが当たる) |
|
|
98
|
+
| `@squadbase/vantage/slide` | `SlideDeck`・`Slide`・`Steps`・`Step`・`MorphElement`・`useSlideNumber`・`useIsActiveSlide`、1 枚分の block `SlideCover`・`SlideExecSummary`・`SlideKpiHero`・`SlideKpiGrid`・`SlideChartInsight`・`SlideScorecardTable`・`SlideNextActions`・`SlideSection`・`SlideComparison`・`SlideChartFull`、手書きの 1 枚に使う部品 `SlideHeading`・`SlideSourceLine`・`SlideColumns`・`SlideColumn`・`DeltaText`(スライド専用。1920×1080 の固定キャンバス) |
|
|
99
|
+
| `@squadbase/vantage/doc` | `Document`、ドキュメント用の block `DocReportHeader`・`DocExecutiveSummary`・`DocKpiScorecard`・`DocFigure`・`DocDataTable`・`DocCallout`・`DocKeyFindings`・`DocActionItems`・`DocNotesAndSources`、部品 `DeltaText`(ドキュメント専用。中の素の HTML 要素に見出し・表などのスタイルが当たる) |
|
|
100
100
|
| `@squadbase/vantage/markdown` | `MarkdownRenderer`(Shiki を隔離するための専用サブパス) |
|
|
101
101
|
| `@squadbase/vantage/server` | `ApiContext`・`ApiHandler`・`HttpError`・`isHttpError`・`json`(server/ 側でのみ使う) |
|
|
102
102
|
|