@squadbase/vantage-template 0.1.1-dev2.7fae7eb → 0.1.1-dev2.b6e5836
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-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 +36 -24
- 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-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 +177 -4
- package/base-template/DESIGN.md +7 -6
- 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 +54 -9
- package/base-template/agents/slide.md +83 -3
- package/base-template/agents/xlsx.md +2 -1
- package/base-template/bun.lock +76 -66
- 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 +10 -10
- package/base-template/src/index.tsx +8 -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/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
|
|
@@ -16,7 +16,7 @@ CLI は雛形を出すだけで、規約の遵守はこちらの責任。**追
|
|
|
16
16
|
```bash
|
|
17
17
|
vantage add page <name> # ルートページ(.tsx)
|
|
18
18
|
vantage add api <name> # server/api/**.ts の API モジュール
|
|
19
|
-
vantage add ui <name> #
|
|
19
|
+
vantage add ui <name> # /ui・/components の部品ソースを components/ui/ にコピー(src/ があればその中)
|
|
20
20
|
vantage add block <name> # registry からブロックを components/blocks/ にコピー(同上)
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -121,15 +121,17 @@ vantage add ui data-table # → components/ui/data-table.tsx(編集可能
|
|
|
121
121
|
vantage add block sales-overview # → components/blocks/sales-overview.tsx
|
|
122
122
|
```
|
|
123
123
|
|
|
124
|
-
-
|
|
125
|
-
|
|
126
|
-
未知の名前を渡すと利用可能な名前一覧を出して失敗する。
|
|
127
|
-
- コピーが要らない大半のプリミティブは `@squadbase/vantage/ui` から、複合パーツは
|
|
128
|
-
`@squadbase/vantage/components` から**そのまま import**するのが基本(コピー不要)。
|
|
124
|
+
- **基本はコピーせず import する。** プリミティブは `@squadbase/vantage/ui` から、複合パーツと
|
|
125
|
+
チャートは `@squadbase/vantage/components` から**そのまま import**する。
|
|
129
126
|
```tsx
|
|
130
127
|
import { Button, Loading, ErrorState } from "@squadbase/vantage/ui"
|
|
131
|
-
import { DashboardCardPreset, DataTablePreset,
|
|
128
|
+
import { DashboardCardPreset, DataTablePreset, LineChart } from "@squadbase/vantage/components"
|
|
132
129
|
```
|
|
130
|
+
- `add ui` は**改造したいときだけ**使う。`/ui` と `/components` の部品はすべて kebab-case 名で
|
|
131
|
+
コピーできる(`add ui bar-chart`・`add ui combobox`)。未知の名前を渡すと利用可能な名前一覧を
|
|
132
|
+
出して失敗する。
|
|
133
|
+
- グラフは型付きチャート(`LineChart`・`BarChart` など)から選ぶ。選び方は `agents/page.md` の
|
|
134
|
+
「グラフはまず型付きチャートで描く」。
|
|
133
135
|
- **props は `vantage docs <name>` で確認してから書く**(`vantage docs button`・
|
|
134
136
|
`vantage docs parts/data-table`。名前が分からなければ `vantage search <やりたいこと>` で
|
|
135
137
|
探してから `vantage docs` に渡す)。
|
|
@@ -14,7 +14,7 @@ description: Vantage(@squadbase/vantage)ダッシュボードアプリを一か
|
|
|
14
14
|
|
|
15
15
|
## 全体の流れ
|
|
16
16
|
|
|
17
|
-
1. **骨組み** — `
|
|
17
|
+
1. **骨組み** — `pnpm dev` が上がるところまで
|
|
18
18
|
2. **ルートを決める** — ページファイルを置き、`vantage routes` で URL を確認
|
|
19
19
|
3. **データを繋ぐ** — 外部 API か、自前の `server/api` か
|
|
20
20
|
4. **仕上げ** — `check` → `build` → `preview`
|
|
@@ -52,7 +52,7 @@ exit 1 になる。
|
|
|
52
52
|
```
|
|
53
53
|
|
|
54
54
|
`index.tsx` はデフォルトエクスポートの React コンポーネント 1 つ(これが `/` になる)。あとは
|
|
55
|
-
`
|
|
55
|
+
`pnpm install && pnpm dev` で http://localhost:5173 が上がる。
|
|
56
56
|
|
|
57
57
|
**既存アプリに合流したときは、作る前に現状を読む:**
|
|
58
58
|
|
|
@@ -75,6 +75,10 @@ vantage add skill # 配置済みの skill(このファイルの仲間)と、そ
|
|
|
75
75
|
- 共通の枠(ヘッダ・サイドバー)は `_layout.tsx`、Not Found と例外は `_404.tsx` / `_error.tsx`。
|
|
76
76
|
- 一覧 → 詳細を作るなら、**動的パラメータの「3 つの綴り」を先に決めてから**両方のファイルを
|
|
77
77
|
書く。後から変えると静かにマッチしなくなる。
|
|
78
|
+
- **ページになるのは tsx だけではない。** `.csv` / `.xlsx` を `src/` に置けば表として読めるページに
|
|
79
|
+
なり、`<name>.slide.tsx` はスライドデッキになる(どちらもナビに同格で並ぶ)。ダッシュボード・
|
|
80
|
+
スライド・データを 1 つのアプリに並べたいときは、まずこの 2 つで足りないか考える —— 表を出すために
|
|
81
|
+
ページを書く必要は無い。スライドの書き方は `vantage-slide` スキル。
|
|
78
82
|
|
|
79
83
|
## Step 3 — データを繋ぐ
|
|
80
84
|
|
|
@@ -105,10 +109,10 @@ vantage add skill # 配置済みの skill(このファイルの仲間)と、そ
|
|
|
105
109
|
## Step 4 — 仕上げ
|
|
106
110
|
|
|
107
111
|
```bash
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
+
pnpm check # エラーが残っていないか(exit 1 なら残っている)
|
|
113
|
+
pnpm routes # 公開される URL の最終確認
|
|
114
|
+
pnpm build # dist/ に client(+ server)+ vantage-manifest.json
|
|
115
|
+
pnpm preview # 本番ビルドをローカルで動かす
|
|
112
116
|
```
|
|
113
117
|
|
|
114
118
|
`vantage-manifest.json` の `mode` は `server/` の有無から自動で決まる(手で書かない)。
|
|
@@ -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,21 +76,30 @@ 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>", ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, sans-serif;
|
|
81
|
-
}
|
|
82
82
|
:root {
|
|
83
|
-
--
|
|
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;
|
|
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
|
}
|
|
86
87
|
```
|
|
87
88
|
|
|
89
|
+
欧文の Web フォントだけを先頭に足すときも、日本語の system face(`"Hiragino Sans"` 〜 `Meiryo`)は
|
|
90
|
+
必ず残す。消すとカナ・漢字がブラウザ任せのフォールバックになり、細く表示される。
|
|
91
|
+
`ui-sans-serif` / `system-ui` は日本語の face より**後ろ**に置く。日本語の Windows ではどちらも
|
|
92
|
+
Yu Gothic UI(UI のリサイズを避けるために字幅を詰めた書体)に解決され、カナがここで決まって
|
|
93
|
+
半角風に見える。macOS の Chrome は `-apple-system` を解釈しないので `BlinkMacSystemFont` も並べる。
|
|
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` に上の並びで書く。
|
|
88
97
|
日本語の Web フォントは face が 100 を超えるので原則使わない(pptx 書き出しも壊れる。
|
|
89
98
|
`vantage-slide` の `references/tokens.md` 参照)。
|
|
90
99
|
|
|
100
|
+
長い表(ダッシュボード): カードに `max-h-*` + `overflow-y-auto` の縦スクロール領域を作らず、
|
|
101
|
+
ページング付きの `DataTablePreset`(`enablePagination`)にする(ホイールや End キーがページに届かなくなるため)。
|
|
102
|
+
|
|
91
103
|
`DESIGN.md`: `references/format.md` の書式で書く。**色コードを書かない**(トークン名だけ)。
|
|
92
104
|
150 行を超えない(超えると `vantage check` が `DESIGN_MD_TOO_LONG` を出す)。ロゴなどの素材は
|
|
93
105
|
`public/brand/logo.svg` のように `public/` 配下のパスで「ブランド素材」行に書く。
|
|
@@ -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` を普通の系列色に使わない。
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: vantage-pitfalls
|
|
3
|
-
description: Vantage(@squadbase/vantage)アプリを書くときに静かに壊れる落とし穴のリファレンス。Base UI は Radix ではない(asChild 無し・render プロップ)、Select の value/label、クライアントから server/ を import
|
|
3
|
+
description: Vantage(@squadbase/vantage)アプリを書くときに静かに壊れる落とし穴のリファレンス。Base UI は Radix ではない(asChild 無し・render プロップ)、Select の value/label、クライアントから server/ を import しない、チャートの色指定と EChart の配色・高さ、動的パラメータの3綴り同期、PUBLIC_ env、HttpError、csv/xlsx ページの URL 衝突とサイズ上限、スライドの data-waitfor など。Vantage の UI コンポーネントやルーティングが思った通りに動かないとき、ビルドやスタイルが静かに欠落するときに参照する。
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Vantage アプリの落とし穴リファレンス
|
|
@@ -59,6 +59,10 @@ Base UI の `SelectValue` は選択中の **value をそのまま描き**、`Sel
|
|
|
59
59
|
|
|
60
60
|
## チャート:`EChart` の配色はトークン追従。上書きは `option.color`
|
|
61
61
|
|
|
62
|
+
ふつうの推移・比較・構成比は型付きチャート(`LineChart`・`BarChart` など。→ `agents/page.md`)で
|
|
63
|
+
描く。その `colors` に渡すのはトークン名 `"chart-1"`〜`"chart-5"` か CSS 色で、Tailwind クラス
|
|
64
|
+
(`"bg-blue-500"` など)は効かない。以下は `EChart` を直接使うときの話。
|
|
65
|
+
|
|
62
66
|
系列色は `--chart-1..5`、軸・凡例・ツールチップは文字色/境界色のトークンから組まれる
|
|
63
67
|
(init 時にトークンの実値を解決している)。ライト / ダークの切り替えにも、`styles.css` の
|
|
64
68
|
書き換えやテーマプリセットの適用にも追従する。
|
|
@@ -90,6 +94,11 @@ Base UI の `SelectValue` は選択中の **value をそのまま描き**、`Sel
|
|
|
90
94
|
- 表示ルート `/sales/:customerId`
|
|
91
95
|
- リンク `to="/sales/$customerId"` + `params={{ customerId }}` / 取り出し `useParams().customerId`
|
|
92
96
|
|
|
97
|
+
## 日本語アプリは `lang` を指定する
|
|
98
|
+
|
|
99
|
+
ルート `src/_layout.tsx` に `export const lang = "ja"`(リテラル)が無いと `<html lang="en">` のままで、
|
|
100
|
+
スライドの見出しが文節の途中で折れる。内容が日本語なら必ず指定する。
|
|
101
|
+
|
|
93
102
|
## ページ:`definePage` の値はリテラルで書く
|
|
94
103
|
|
|
95
104
|
title/description/navLabel は**ビルド時に静的抽出**される。変数・関数呼び出し・テンプレート補間を
|
|
@@ -153,6 +162,46 @@ import { type ColumnDef } from "@squadbase/vantage/components"
|
|
|
153
162
|
const columns: ColumnDef<Row>[] = [ … ] // 注釈しないと accessorKey が string に広がり弾かれる
|
|
154
163
|
```
|
|
155
164
|
|
|
165
|
+
## データファイルページ:同名の tsx と衝突する / ブラウザでパースされる
|
|
166
|
+
|
|
167
|
+
`src/` に置いた `.csv` / `.xlsx` はページになる。ここで静かに壊れるのは 3 つ。
|
|
168
|
+
|
|
169
|
+
- **`sales.csv` と `sales.tsx` はどちらも `/sales`** に解決するので `ROUTE_CONFLICT` エラー。
|
|
170
|
+
`.slide.tsx` も同じ(`june.slide.tsx` と `june.tsx`)。
|
|
171
|
+
- **パースはブラウザで走る。** 25MB を超えるファイルはそのページがエラー表示になる
|
|
172
|
+
(`vantage check` が `FILE_PAGE_TOO_LARGE` で先に警告する)。大きいデータは `server/api/` から
|
|
173
|
+
配って `DataTable` で描く。
|
|
174
|
+
- **ビューアの無い拡張子(`.xls`・`.ods`・`.tsv` など)はルートにならない。** 404 ですらなく、
|
|
175
|
+
ナビにも `vantage routes` にも出ない。`vantage check` の `UNSUPPORTED_PAGE_FILE` 警告が
|
|
176
|
+
唯一の告知点なので、「置いたのに出てこない」ときはまず `check` を見る。
|
|
177
|
+
|
|
178
|
+
ビューアは**表計算ソフトの見た目の読み取り専用グリッド**(列は A / B / C、左に行番号、1 行目は
|
|
179
|
+
固定、シートのタブは下端)。**ソート・フィルタ・ページネーションは持たない** —— 並べ替えや
|
|
180
|
+
絞り込みが要るなら `server/api/` から配って `DataTable` で描く。数式・グラフ・セル書式は
|
|
181
|
+
再現されない(値として読めれば十分、という設計)。
|
|
182
|
+
|
|
183
|
+
## スライド:`data-waitfor` を忘れるとチャートが白紙で書き出される
|
|
184
|
+
|
|
185
|
+
`.slide.tsx` の pptx 書き出しはスライドを画像として焼く。**canvas に描くもの(`EChart`)は
|
|
186
|
+
描き終わりを待たせないと、描画前に撮られてそのスライドだけ白紙になる**:
|
|
187
|
+
|
|
188
|
+
```tsx
|
|
189
|
+
<div data-waitfor="canvas">
|
|
190
|
+
<EChart option={option} style={{ width: 1400, height: 600 }} />
|
|
191
|
+
</div>
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
ほかに 2 つ。
|
|
195
|
+
|
|
196
|
+
- **`@squadbase/vantage/ui` のプリミティブをスライドに置かない。** UI キットは rem と Tailwind で
|
|
197
|
+
組まれているので、1920×1080 を縮小投影すると `text-sm` のボタンが実効 8px 程度になって読めない。
|
|
198
|
+
スライドは絶対 px のインラインスタイルで書く。
|
|
199
|
+
- **dev サーバーを起動したあとに最初の `.slide.tsx` を新規作成した場合、初回の pptx 書き出しで
|
|
200
|
+
1 回だけリロードが入る。** 書き出し用の依存はプロジェクトがデッキを持つときだけ宣言される仕組みで、
|
|
201
|
+
その判定は dev の起動時に 1 度しか走らないため。`vantage dev` を再起動すれば解消する。
|
|
202
|
+
|
|
203
|
+
書き方の作法(キャンバスの縦方向の予算、段階表示、トランジション、モーフ)は `vantage-slide` スキル。
|
|
204
|
+
|
|
156
205
|
## 生成物:`.vantage/` と `dist/` は触らない
|
|
157
206
|
|
|
158
207
|
どちらも gitignore 済みの生成物。編集しても次のコマンドで上書きされる。`.vantage/` は任意の CLI
|