@lism-css/mcp 0.12.0 → 0.14.0

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.
Files changed (43) hide show
  1. package/README.ja.md +1 -1
  2. package/dist/data/docs-index.json +267 -174
  3. package/dist/data/guides/SKILL.md +95 -54
  4. package/dist/data/guides/base-styles.md +2 -2
  5. package/dist/data/guides/components-core.md +87 -132
  6. package/dist/data/guides/components-ui.md +3 -15
  7. package/dist/data/guides/css-rules.md +110 -24
  8. package/dist/data/guides/naming.md +204 -0
  9. package/dist/data/guides/primitive-class.md +84 -0
  10. package/dist/data/guides/primitives/a--decorator.md +43 -0
  11. package/dist/data/guides/primitives/a--divider.md +62 -0
  12. package/dist/data/guides/primitives/a--icon.md +105 -0
  13. package/dist/data/guides/primitives/a--spacer.md +63 -0
  14. package/dist/data/guides/primitives/is--boxLink.md +97 -0
  15. package/dist/data/guides/primitives/is--container.md +46 -0
  16. package/dist/data/guides/primitives/is--layer.md +71 -0
  17. package/dist/data/guides/primitives/is--wrapper.md +87 -0
  18. package/dist/data/guides/primitives/l--box.md +31 -0
  19. package/dist/data/guides/primitives/l--center.md +55 -0
  20. package/dist/data/guides/primitives/l--cluster.md +38 -0
  21. package/dist/data/guides/primitives/l--columns.md +72 -0
  22. package/dist/data/guides/primitives/l--flex.md +74 -0
  23. package/dist/data/guides/primitives/l--flow.md +134 -0
  24. package/dist/data/guides/primitives/l--fluidCols.md +71 -0
  25. package/dist/data/guides/primitives/l--frame.md +94 -0
  26. package/dist/data/guides/primitives/l--grid.md +68 -0
  27. package/dist/data/guides/primitives/l--sideMain.md +102 -0
  28. package/dist/data/guides/primitives/l--stack.md +56 -0
  29. package/dist/data/guides/primitives/l--switchCols.md +69 -0
  30. package/dist/data/guides/primitives/l--tileGrid.md +61 -0
  31. package/dist/data/guides/property-class.md +12 -11
  32. package/dist/data/guides/set-class.md +11 -26
  33. package/dist/data/guides/tokens.md +26 -9
  34. package/dist/data/guides/utility-class.md +9 -8
  35. package/dist/data/meta.js +2 -2
  36. package/dist/lib/load-markdown.d.ts +3 -2
  37. package/dist/lib/load-markdown.js +23 -5
  38. package/dist/lib/search.js +20 -1
  39. package/dist/tools/get-component.js +119 -30
  40. package/dist/tools/get-guide.js +1 -1
  41. package/dist/tools/search-docs.js +1 -1
  42. package/package.json +1 -1
  43. package/dist/data/guides/module-class.md +0 -162
@@ -3,12 +3,15 @@
3
3
  ## TOC
4
4
 
5
5
  - [CSS Layer 構造](#css-layer-構造)
6
- - [命名規則とプレフィックス](#命名規則とプレフィックス)
6
+ - [プレフィックスとクラス分類](#プレフィックスとクラス分類)
7
+ - [Component Class(`c--`)](#component-classc--)
7
8
  - [カスタムCSS を追加する場合](#カスタムcss-を追加する場合)
8
9
  - [CSS の配置場所](#css-の配置場所)
9
10
 
10
11
  [詳細](https://lism-css.com/docs/css-methodology/)
11
12
 
13
+ > **命名規則の詳細**: CSS変数名・クラス名・Property Class の `{prop}` / `{value}` の省略ルールについては [naming.md](./naming.md) を参照してください。
14
+
12
15
  ---
13
16
 
14
17
  ## CSS Layer 構造
@@ -20,59 +23,142 @@ Lism CSS は CSS Layers による詳細度管理を採用しています。
20
23
  Settings(トークン定義)
21
24
  → @layer lism-base(Reset CSS・トークン・.set--クラス)
22
25
  → @layer reset(リセットCSS)
23
- → @layer lism-modules
24
- → @layer state(.is-- ステートモジュール)
25
- → @layer layout(.l-- レイアウトモジュール)
26
- → @layer atomic(.a-- アトミックモジュール)
27
- .c-- sublayer なし(lism-modules 直下、または lism-custom で定義)
26
+ → @layer lism-primitive
27
+ → @layer trait(.is-- Trait Primitive)
28
+ → @layer layout(.l-- Layout Primitive)
29
+ → @layer atomic(.a-- Atomic Primitive)
30
+ @layer lism-component(.c-- Component Class BEM 構造を持つ UI 部品)
28
31
  → @layer lism-custom(ユーザーカスタマイズ用)
29
32
  → @layer lism-utility(.u-- ユーティリティクラス)
30
33
  → Property Class(レイヤー外 — 最も詳細度が高い)
31
34
  ```
32
35
 
33
36
 
34
- ## 命名規則とプレフィックス
37
+ ## プレフィックスとクラス分類
35
38
 
36
- [詳細](https://lism-css.com/docs/module-class/)
39
+ [詳細](https://lism-css.com/docs/primitives/)
37
40
 
38
41
  クラス名のプレフィックスによって、役割とレイヤーの所属が決まります。
39
42
 
40
43
  | プレフィックス | レイヤー | 役割 | 例 |
41
44
  |--------------|---------|------|-----|
42
45
  | `.set--` | lism-base | ベーススタイル上書き・トークン再定義 | `.set--plain`, `.set--transition` |
43
- | `.is--` | lism-modules | 付け外し可能な状態モジュール | `.is--container`, `.is--wrapper` |
44
- | `.l--` | lism-modules | レイアウト構成モジュール | `.l--grid`, `.l--flex`, `.l--stack` |
45
- | `.a--` | lism-modules | レイアウト最小単位モジュール | `.a--icon`, `.a--divider` |
46
- | `.c--` | lism-modules | 具体的な役割のコンポーネント | `.c--button`, `.c--accordion` |
46
+ | `.is--` | lism-primitive.trait | Trait Primitive(要素の静的特性) | `.is--container`, `.is--wrapper` |
47
+ | `.l--` | lism-primitive.layout | Layout Primitive | `.l--grid`, `.l--flex`, `.l--stack` |
48
+ | `.a--` | lism-primitive.atomic | Atomic Primitive | `.a--icon`, `.a--divider` |
49
+ | `.c--` | lism-component | Component Class(BEM 構造を持つ UI 部品) | `.c--button`, `.c--accordion` |
47
50
  | `.u--` | lism-utility | 用途が明確なユーティリティ | `.u--cbox`, `.u--trim` |
48
51
  | `.-` | レイヤー外 | 単一プロパティ制御(Property Class) | `.-fz:l`, `.-p:20`, `.-d:none` |
49
52
 
50
53
  **併用ルール:**
51
54
  - `.l--` と `.c--` は併用OK(例: `<div class="l--flex c--nav">`)
52
- - 同カテゴリ内の併用は不可(例: `.l--flex` と `.l--grid` は同要素に付けない)
53
- - バリエーション: `.c--button.c--button--outline`
54
- - 子要素: `.c--card_header`, `.c--card_body`
55
+ - 同カテゴリ内の Primitive 併用は不可(例: `.l--flex` と `.l--grid`、`.a--icon` と `.a--divider` は同要素に付けない)
56
+ - `.l--` × `.a--` は非推奨(役割的に同居しない想定)
57
+ - `.is--` 同士は併用OK(Trait は複数併用できる)
58
+ - `.is--` × `.l--` / `.a--` も併用OK
59
+ - `c--` の Block 同士の併用(`.c--xxx.c--yyy`)は基本 NG。ただし以下は許容:
60
+ - Block と自身の Modifier: `.c--button.c--button--outline`
61
+ - Block と他 Block の Element: `.c--xxx.c--yyy_elem`
62
+ - 子要素: `.c--card_header`, `.c--card_body`(`c--` のみ Element を持つ。`_` 一つ区切り)
55
63
 
56
64
  **記述順序:**
57
- class 属性にクラスを直接記述する場合、Property Class(`-` プレフィックス)はモジュールクラスやユーティリティクラスの**後ろ**に書いてください。
65
+ class 属性にクラスを直接記述する場合は、以下の順序で並べてください。
66
+
67
+ ```
68
+ [customClass] [c--] [a--] [l--] [is--] [set--] [u--] [-]
69
+ ```
70
+
71
+ | # | 区分 | 例 |
72
+ |---|---|---|
73
+ | 1 | 独自クラス(`customClass`) | `z--header`, `hoge` |
74
+ | 2 | Component(`c--`) | `c--box`, `c--box--primary` |
75
+ | 3 | Atomic Primitive(`a--`) | `a--icon`, `a--divider` |
76
+ | 4 | Layout Primitive(`l--`) | `l--flex`, `l--columns` |
77
+ | 5 | Trait Primitives(`is--`) | `is--wrapper`, `is--layer` |
78
+ | 6 | Set Class(`set--`) | `set--hov`, `set--transition` |
79
+ | 7 | Utility Class(`u--`) | `u--cbox`, `u--trim` |
80
+ | 8 | Property Class(`-`) | `-p:20`, `-bgc:base-2` |
58
81
 
59
82
  ```html
60
- <!-- OK: モジュールクラス → Property Class -->
61
- <div class="l--flex c--nav -p:20 -g:20">...</div>
62
- <div class="l--box u--cbox -bd -p:20">...</div>
83
+ <!-- OK -->
84
+ <div class="c--nav l--flex -p:20 -g:20">...</div>
63
85
 
64
- <!-- NG: Property Class が先 -->
86
+ <!-- NG: Property Class が先 になっている -->
65
87
  <div class="-p:20 -g:20 l--flex c--nav">...</div>
66
88
  ```
67
89
 
90
+ なお、`class` 属性内の並び順は CSS の適用結果(詳細度・カスケード順)には影響しません。この順序はあくまで可読性と一貫性のための整理です。
91
+
92
+
93
+ ## Component Class(`c--`)
94
+
95
+ `c--` プレフィックスで定義する **Component クラス** は、Primitive を組み合わせて作られた具体的な UI 部品です。`@layer lism-component` に配置され、コアの `lism-css` には含まれず、`@lism-css/ui` パッケージやユーザー定義として提供されます。
96
+
97
+ `c--` クラスは BEM 構造(Block / Modifier / Element)を持つことができ、それぞれ次の形式で定義します。
98
+
99
+ | 分類 | 形式 | 例 |
100
+ |---|---|---|
101
+ | Block | `.c--{name}` | `.c--button`, `.c--card` |
102
+ | Modifier | `.c--{name}--{modifier}` | `.c--button--outline` |
103
+ | Element | `.c--{name}_{element}` | `.c--card_header`, `.c--card_body` |
104
+
105
+ - Modifier は Block と併記して使用: `.c--button.c--button--outline`
106
+ - Element は `_`(アンダースコア)一つ区切り
107
+ - Block 同士の併用(`.c--xxx.c--yyy`)は基本 NG。ただし次は許容される:
108
+ - Block と自身の Modifier: `.c--xxx.c--xxx--variant`
109
+ - Block と他 Block の Element: `.c--xxx.c--yyy_elem`
110
+ - `a--` / `l--` には `variant` の BEM 展開は適用されない**
111
+
112
+ `c--` を使った独自コンポーネントを使う場合でも、他の Primitive クラス(`.l--`, `.is--`)や Property Class(`-{prop}:{value}`)との組み合わせを前提とした設計にすることで CSS の記述量を削減できます。`c--` クラスにスタイルが全くなく、HTML 側での可視性を高める名前付けのためだけに利用しても構いません。
113
+
114
+
115
+ ### 作成例
116
+
117
+ `l--stack` と併用する前提でのカスタムクラス例:
118
+
119
+ ```css
120
+ @layer lism-component {
121
+ .c--myCard {
122
+ gap: var(--s20);
123
+ padding: var(--s30);
124
+ border-radius: var(--bdrs--20);
125
+ box-shadow: var(--bxsh--20);
126
+ border: 1px solid currentColor;
127
+ /* ... */
128
+ }
129
+ }
130
+ ```
131
+
132
+ ```html
133
+ <div class="c--myCard l--stack">
134
+ ...
135
+ </div>
136
+ ```
137
+
138
+ 素の HTML サイトではこのように `c--` クラスに CSS を書いてスタイリングしても問題ありませんが、React などでコンポーネントを作成できる場合は、特別な理由がない限り Property Class を活用してください。
139
+
140
+ ```jsx
141
+ export default function MyCard(props) {
142
+ return <Stack lismClass="c--myCard" g="20" p="30" bdrs="20" bxsh="20" bd {...props} />;
143
+ }
144
+ ```
145
+
146
+ ```css
147
+ @layer lism-component {
148
+ .c--myCard {
149
+ /* 複雑なスタイルがあれば css で書く */
150
+ }
151
+ }
152
+ ```
153
+
68
154
 
69
155
  ## カスタムCSS を追加する場合
70
156
 
71
157
  独自のスタイルを追加する場合は、対象に合った Lism の CSS Layer 内に記述してください。
72
158
 
73
159
  ```css
74
- /* カスタムコンポーネント → lism-modules に追加 */
75
- @layer lism-modules {
160
+ /* カスタムコンポーネント → lism-component に追加 */
161
+ @layer lism-component {
76
162
  .c--my-card {
77
163
  border: 1px solid var(--brand);
78
164
  border-radius: var(--bdrs--20);
@@ -137,8 +223,8 @@ Lism のトークン変数のカスタマイズやベーススタイルの上書
137
223
  - `.astro` ファイル: `import` するか、コンポーネントファイル内の `<style>` タグに記述
138
224
 
139
225
  ```css
140
- /* コンポーネント用CSS は lism-modules 内に定義する */
141
- @layer lism-modules {
226
+ /* コンポーネント用CSS は lism-component 内に定義する */
227
+ @layer lism-component {
142
228
  .c--yourComponent {
143
229
  ...
144
230
  }
@@ -0,0 +1,204 @@
1
+ # 命名規則
2
+
3
+ ## TOC
4
+
5
+ - [CSS変数の命名規則](#css変数の命名規則)
6
+ - [クラスの命名規則](#クラスの命名規則)
7
+ - [`{prop}` の省略ルール](#prop-の省略ルール)
8
+ - [`{value}` の省略ルール](#value-の省略ルール)
9
+
10
+ [詳細](https://lism-css.com/docs/naming/)
11
+
12
+ ---
13
+
14
+ ## CSS変数の命名規則
15
+
16
+ 各ブロックは camelCase で `{varName}` の形式が基本。
17
+
18
+ ### トークン変数
19
+
20
+ | 種類 | 形式 | 例 |
21
+ |------|------|-----|
22
+ | 基本 | `--{prop}--{token}` | `--fz--l`, `--bdrs--20`, `--bxsh--10`, `--sz--s` |
23
+ | カラー | `--{color}` | `--brand`, `--text`, `--text-2`, `--red` |
24
+ | スペーシング | `--s{Token}` | `--s10`, `--s40` |
25
+
26
+ トークンのバリエーション:
27
+
28
+ | 表記 | 条件 | 例 |
29
+ |------|------|-----|
30
+ | `s`, `m`, `l`, `xl`... | ベース値を中心に大小の段階を示す | `--fz--s`, `--fz--l` |
31
+ | `base` | `:root`/`body` の初期値にセットされるもの | `--fz--base`, `--lh--base` |
32
+ | `10`, `20`, `30`... | `0`(`none`)基準で段階的に増加 | `--bdrs--20`, `--bxsh--30` |
33
+ | `-10`, `-20`, `-30`... | `0`(`none`)基準で段階的に減少 | `--o---10`, `--o---20` |
34
+ | セマンティック名 | 上記に当てはまらない場合 | `--ar--og` |
35
+
36
+ ### Property Class 用の変数
37
+
38
+ | 形式 | 説明 | 例 |
39
+ |------|------|-----|
40
+ | `--{prop}` | クラスの `{prop}` 部分と同じ省略名 | `--p`, `--bgc`, `--bdrs`, `--max-sz` |
41
+ | `--{prop}_{bp}` | ブレークポイント値 | `--p_sm`, `--mx_md` |
42
+
43
+ ### その他の変数
44
+
45
+ | 形式 | 用途 | 例 |
46
+ |------|------|-----|
47
+ | `--{target}-{prop}` | 要素・クラスに対するプロパティ(`:root`で上書き可) | `--link-td`, `--headings-ff` |
48
+ | `--{propName}` | プリミティブの主要機能変数 | `--sideW`, `--mainW` |
49
+ | `--_{item}-{propName}` | `c--` の子要素プロパティ | `--_icon-size` |
50
+ | `--_{varName}` | 状態管理用の内部変数 | `--_isHov`, `--_notHov` |
51
+
52
+
53
+ ## クラスの命名規則
54
+
55
+ プレフィックスとクラス分類の対応:
56
+
57
+ - Component: `c--`
58
+ - Atomic Primitives: `a--`
59
+ - Layout Primitives: `l--`
60
+ - Trait Primitives: `is--`
61
+ - Set Class: `set--`
62
+ - Utility Class: `u--`
63
+
64
+ プレフィックスに続く名称は camelCase(例: `c--myComponent`)。
65
+
66
+ Property Class の形式:
67
+
68
+ - 特定の値とセット: `-{prop}:{value}`
69
+ - `--{prop}` 変数を受け取る: `-{prop}`
70
+ - ブレークポイント値を受け取る: `-{prop}_{bp}`
71
+
72
+
73
+ ## `{prop}` の省略ルール
74
+
75
+ 基本は [Emmet](https://docs.emmet.io/cheat-sheet/) 準拠。
76
+
77
+ > **Note**: 「1文字プロパティ」セクション以外の表は **代表例** であり、全プロパティの一覧ではない。記載のないプロパティは本ページのルールに沿って省略する。
78
+
79
+ ### 1文字プロパティ
80
+
81
+ 1文字に省略する主要プロパティは以下の通り(このリストが全て)。
82
+
83
+ | 省略 | プロパティ | 省略 | プロパティ |
84
+ |------|-----------|------|-----------|
85
+ | `p` | `padding` | `i` | `inset` |
86
+ | `m` | `margin` | `t` | `top` |
87
+ | `g` | `gap` | `b` | `bottom` |
88
+ | `c` | `color` | `l` | `left` |
89
+ | `f` | `font` | `r` | `right` |
90
+ | `w` | `width` | `o` | `opacity` |
91
+ | `h` | `height` | `v` | `visibility` |
92
+ | `d` | `display` | `z` | `z-index` |
93
+
94
+ Emmet と異なるのは `o` (`opacity`) のみ。
95
+
96
+ ### プロパティグループ
97
+
98
+ #### 基本形式: 「グループ略称」+「サブプロパティ名の省略形」
99
+
100
+ | CSS プロパティ | Prop |
101
+ |-------------|------|
102
+ | font-size | `fz` |
103
+ | font-weight | `fw` |
104
+ | background-color | `bgc` |
105
+ | background-image | `bgi` |
106
+ | flex | `fx` |
107
+ | flex-shrink | `fxsh` |
108
+ | flex-grow | `fxg` |
109
+ | grid-template-columns | `gtc` |
110
+ | grid-template-rows | `gtr` |
111
+
112
+ #### 方向指定系: 「グループ略称」 + `-` +「方向指定」
113
+
114
+ | 方向 | サフィックス | 例 |
115
+ |------|-----------|-----|
116
+ | physical | `-t` / `-b` / `-l` / `-r` | `bd-t`, `bd-b`, `bd-l`, `bd-r` |
117
+ | inline / block | `-x` / `-y` | `bd-x`, `bd-y` |
118
+ | start / end | `-s` / `-e` | `bd-x-s`, `bd-x-e`, `bd-y-s`, `bd-y-e` |
119
+ | x / y | `-x` / `-y` | `ov-x`, `ov-y` |
120
+
121
+ 例外: `p`, `m` のみ最初のハイフンを省略 → `pt`, `px`, `my`, `mx-s` 等。
122
+
123
+ #### グループ略称の衝突禁止
124
+
125
+ 一つのグループで使用された略称は他のグループで再利用しない。
126
+ NG例: `flex` → `fx` としたうえで `flex-shrink` を `fsh` にする(`fx` グループの一貫性を崩すため)。
127
+
128
+ ### max- / min- プロパティ
129
+
130
+ `max-`, `min-` プレフィックスはハイフンを保持: `max-w`, `min-w`, `max-h`, `min-h`。
131
+
132
+ ### その他のプロパティ
133
+
134
+ 1. 1単語: そのまま使用 or 省略
135
+ 2. ハイフン繋がり、または6文字以上: Emmet形式または認識しやすい範囲で省略
136
+
137
+ | CSS プロパティ | Prop | 分類 |
138
+ |-------------|------|------|
139
+ | float | `float` | そのまま |
140
+ | order | `order` | そのまま |
141
+ | position | `pos` | 省略 |
142
+ | overflow | `ov` | 省略 |
143
+ | inline-size | `sz` | 省略 |
144
+ | block-size | `bsz` | 省略 |
145
+ | aspect-ratio | `ar` | 省略 |
146
+ | writing-mode | `wm` | 省略 |
147
+ | white-space | `whs` | 省略 |
148
+
149
+ ### 1文字プロパティの短縮名の再利用
150
+
151
+ グループを持たない1文字プロパティや、方向プロパティのみをサブプロパティに持つ場合は、衝突しない範囲で再利用可。
152
+
153
+ | 1文字 Prop | 再利用先 | 展開例 |
154
+ |-----------|---------|--------|
155
+ | `t`(`top`) | `text-*` | `ta`(`text-align`) |
156
+ | `l`(`left`) | `line-*` | `lh`(`line-height`) |
157
+ | `w`(`width`) | `writing-*` | `wm`(`writing-mode`) |
158
+ | `p`(`padding`) | `place-*` | `pi`(`place-items`) |
159
+
160
+
161
+ ## `{value}` の省略ルール
162
+
163
+ ### 基本: CSS の実値をそのまま使う
164
+
165
+ `{prop}` は既に省略されているため、`{value}` はそのまま残して組み合わせから推測可能にする。
166
+
167
+ ```
168
+ .-d:none → display: none;
169
+ .-d:inline-flex → display: inline-flex;
170
+ .-pos:relative → position: relative;
171
+ .-ta:center → text-align: center;
172
+ .-fx:1 → flex: 1;
173
+ .-fxd:column → flex-direction: column;
174
+ ```
175
+
176
+ ### トークン値を利用する場合
177
+
178
+ 対応するトークンがある場合は、トークン値(`--{token}--{value}` の `{value}` 部分)を使う:
179
+
180
+ ```
181
+ .-c:text-2 → color: var(--text-2);
182
+ .-fz:l → font-size: var(--fz--l);
183
+ .-p10 → padding: var(--s10);
184
+ .-fw:bold → font-weight: var(--fw--bold);
185
+ .-bdrs:20 → border-radius: var(--bdrs--20);
186
+ ```
187
+
188
+ トークン値が `-{NUM}` のものも、値をそのまま連結した変数名になる。
189
+
190
+ ```
191
+ .-o:-10 → opacity: var(--o---10);
192
+ ```
193
+
194
+ ### 長いキーワード値の省略
195
+
196
+ 6文字以上かつ省略しても意味が通るものは省略可:
197
+
198
+ | 実際の値 | 省略名 | クラスの例 |
199
+ |--------|------------|-----|
200
+ | `uppercase` | `upper` | `-tt:upper` |
201
+ | `lowercase` | `lower` | `-tt:lower` |
202
+ | `fit-content` | `fit` | `-w:fit`, `-h:fit` |
203
+ | `space-between` | `between` | `-ac:between`, `-jc:between` |
204
+ | `currentColor` | `current` | `-bdc:current` |
@@ -0,0 +1,84 @@
1
+ # Primitive クラス
2
+
3
+ Lism CSS では、レイアウトを組み立てる小さな積み木として **Primitive クラス**(`is--` / `l--` / `a--`)を提供します。これらはすべて `@layer lism-primitive` に属します(サブレイヤーは `trait` / `layout` / `atomic`)。
4
+
5
+
6
+ ## TOC
7
+
8
+ - [プレフィックス一覧](#プレフィックス一覧)
9
+ - [Trait Primitive(`is--`)](#trait-primitiveis--)
10
+ - [Layout Primitive(`l--`)](#layout-primitivel--)
11
+ - [Atomic Primitive(`a--`)](#atomic-primitivea--)
12
+
13
+ [詳細](https://lism-css.com/docs/primitives/)
14
+
15
+ ---
16
+
17
+ ## プレフィックス一覧
18
+
19
+ | プレフィックス | 種類 | サブレイヤー | 役割 |
20
+ |--------------|------|------------|------|
21
+ | `is--` | Trait Primitive | `lism-primitive.trait` | 要素に静的な構造的特性を付与する汎用クラス |
22
+ | `l--` | Layout Primitive | `lism-primitive.layout` | レイアウトの構成単位となる Primitive |
23
+ | `a--` | Atomic Primitive | `lism-primitive.atomic` | レイアウトの最小単位(アイコン・区切り線等) |
24
+
25
+ **併用ルール:**
26
+ - `is--` は他のすべての Primitive と併用可能(複数の `is--` 同士もOK)
27
+ - 同カテゴリ内の併用は不可(例: `l--flex` と `l--grid` は同要素に付けない)
28
+ - `a--` / `l--` には `variant` の BEM 展開は適用されない(BEM Modifier は `c--` 専用)
29
+
30
+
31
+ ## Trait Primitive(`is--`)
32
+
33
+ [詳細](https://lism-css.com/docs/primitives/#trait-primitives)
34
+
35
+ 要素に**静的な構造的特性 (trait)** を付与するクラスです。他の Primitive / Component と自由に組み合わせられます。
36
+
37
+ | クラス | 用途 |
38
+ |--------|------|
39
+ | `is--container` | コンテナクエリの基準要素を定義する(`container-type: inline-size`を付与する)。Lism のレスポンシブ機能の判定基準となるラッパーに付与する |
40
+ | `is--wrapper` | 直下の子要素のコンテンツ幅を一括で制限する。`-contentSize:s` / `-contentSize:l` で事前定義したプリセットサイズを指定可能(デフォルト: `--sz--m`)。セクション・ヘッダー・フッター・記事コンテンツなどで、共通したコンテンツ幅を使用する |
41
+ | `is--layer` | 親要素全体に被さる絶対配置レイヤー(`position: absolute; inset: 0;`)。背景画像・カラーオーバーレイ・フィルターレイヤー・コンテンツ等を重ねて表示する |
42
+ | `is--boxLink` | ボックス全体をクリッカブルなリンク領域にする。自身を`a`タグにして利用するか、もしくは自身を`div`にして内部の`a`タグに`is--coverLink`を付与して使う |
43
+ | `is--coverLink` | 親要素全体に被さるクリック領域を持つリンク(`::before` を `inset: 0` で広げる)。`is--boxLink` と併用する |
44
+ | `is--skipFlow` | `l--flow` 直下で使用し、次の兄弟要素のフロー余白をゼロにする。`l--flow`の中にあるが`position:absolute`にしたい要素などに使用する |
45
+ | `is--side` | `l--sideMain` 直下で使用し、サイド側の要素であることを示す |
46
+
47
+ Lism コンポーネントでは `isContainer`, `isLayer` 等の Props として利用できます。(例: `<Lism isContainer>`)
48
+
49
+
50
+ ## Layout Primitive(`l--`)
51
+
52
+ レイアウト構造を定義するメインの Primitive 群です。
53
+
54
+ | クラス | 用途 |
55
+ |--------|-------------|
56
+ | `l--box` | 汎用ボックス |
57
+ | `l--flex` | 横方向の基本的なFlexboxレイアウト |
58
+ | `l--stack` | 縦方向の縦積みFlexboxレイアウト(`flex-direction: column`)。 |
59
+ | `l--cluster` | タグの表示UIなど、複数要素を水平に並べて配置し、数が多ければ折り返すようなレイアウト。(`flex-wrap: wrap; align-items: center`) |
60
+ | `l--grid` | 基本的なGridレイアウト。 |
61
+ | `l--center` | 要素を縦横中央に配置するレイアウト(`place-content: center; place-items: center`) |
62
+ | `l--flow` | 記事コンテンツなどのフローレイアウト。子要素間の余白を `margin-block-start` で管理する。 |
63
+ | `l--frame` | アスペクト比や高さが固定されたメディア要素を配置する。直下のメディア要素に `object-fit: cover` を付与する。 |
64
+ | `l--columns` | `repeat`と`minmax(0, 1fr))`を使ったカラムレイアウト。レスポンシブ対応の`--cols`用のProperty Classでカラム数の切り替え可能。 |
65
+ | `l--tileGrid` | `--cols`だけではなく`--rows`も組み合わせた均等タイルグリッド(`grid-template: repeat(var(--rows,1), minmax(0, 1fr)) / repeat(var(--cols,1), minmax(0, 1fr))`) |
66
+ | `l--fluidCols` | ブレイクポイントに依存せず、自動段組のできる流動カラムレイアウト。`--cols: 16em`のようにして最小維持幅を指定できる。 |
67
+ | `l--sideMain` | 画像とコンテンツ、メインエリアとサイドバーなどの「"Side" + "Main"」に分かれ、横並びと縦並びが切り替わるレイアウト。"Main"が`--mainW`で指定したサイズ以上の横幅を維持できる範囲内で横並びを維持し、下回る場合は縦並びへ自動で切り替わる。横並びの間の"Side"の横幅は`--sideW`で指定する。 |
68
+ | `l--switchCols` | 任意のサイズで一括カラム切り替えができるカラムレイアウト。`--breakSize` で制御 |
69
+
70
+ それぞれ対応するLismコンポーネント(`<Flex>`, `<Stack>`, `<Cluster>` 等)があります。
71
+
72
+
73
+ ## Atomic Primitive(`a--`)
74
+
75
+ レイアウト構成物の最小単位となる Primitive です。
76
+
77
+ | クラス | 用途 |
78
+ |--------|------|
79
+ | `a--icon` | SVG アイコン。`flex-shrink: 0`, デフォルトサイズ `1em` |
80
+ | `a--divider` | 区切り線。`--bdc`, `--bds`, `--bdw` 変数でカスタマイズ |
81
+ | `a--spacer` | 空白要素(`min-height: 1px; min-width: 1px`) |
82
+ | `a--decorator` | 装飾用要素(SCSS定義なし、クラス名のみ出力) |
83
+
84
+ それぞれ対応するコンポーネント(`<Icon>`, `<Divider>`, `<Spacer>`, `<Decorator>`)があります。
@@ -0,0 +1,43 @@
1
+ # a--decorator / `<Decorator>`
2
+
3
+ コンテンツを装飾するための空要素として使うクラス。`<Decorator>` は `<Lism atomic="decorator" aria-hidden="true" />` のエイリアスとして用意されています。
4
+
5
+ ## 基本情報
6
+
7
+ - クラス名: `a--decorator`
8
+ - コンポーネント: `<Decorator>`
9
+ - ドキュメント(人間向け): https://lism-css.com/docs/primitives/a--decorator/
10
+
11
+ ## 専用Props
12
+
13
+ | Prop | 説明 |
14
+ |------|------|
15
+ | `size` | デコレーターのサイズを一括指定。この指定があると `w`(`width`)に値が渡され、自動で `ar="1/1"`(`aspect-ratio:1/1`)が付与される |
16
+
17
+ ## Usage
18
+
19
+ ### 装飾に使用する例(コーナー装飾)
20
+
21
+ `pos="absolute"` と組み合わせて、親の四隅にコーナー枠を配置する例です。`bdc="current"` で文字色に追随します。
22
+
23
+ ```jsx
24
+ <Box p="30" pos="relative">
25
+ <p>本文テキスト...</p>
26
+ <Decorator size="1.25em" pos="absolute" t="0" l="0" bd-x-s bd-y-s bdc="current" />
27
+ <Decorator size="1.25em" pos="absolute" r="0" b="0" bd-x-e bd-y-e bdc="current" />
28
+ </Box>
29
+ ```
30
+
31
+ ```html
32
+ <div class="l--box -p:30 -pos:relative">
33
+ <p>本文テキスト...</p>
34
+ <div class="a--decorator -pos:absolute -t:0 -l:0 -bd-x-s -bd-y-s -bdc:current -ar:1/1 -w" style="--w:1.25em" aria-hidden="true"></div>
35
+ <div class="a--decorator -pos:absolute -r:0 -b:0 -bd-x-e -bd-y-e -bdc:current -ar:1/1 -w" style="--w:1.25em" aria-hidden="true"></div>
36
+ </div>
37
+ ```
38
+
39
+ ## 関連プリミティブ
40
+
41
+ - [a--spacer](./a--spacer.md) — 要素間スペース
42
+ - [a--divider](./a--divider.md) — 区切り線
43
+ - [is--layer](./is--layer.md) — `position: absolute` のオーバーレイ
@@ -0,0 +1,62 @@
1
+ # a--divider / `<Divider>`
2
+
3
+ コンテンツ間に区切り線を描画するクラス。`--bdc` は `var(--divider)` が初期セットされます。`<Divider>` は `<Lism atomic="divider" aria-hidden="true" />` のエイリアスとして用意されています。
4
+
5
+ ## 基本情報
6
+
7
+ - クラス名: `a--divider`
8
+ - コンポーネント: `<Divider>`
9
+ - SCSSソース: https://raw.githubusercontent.com/lism-css/lism-css/main/packages/lism-css/src/scss/primitives/atomic/_divider.scss
10
+ - ドキュメント(人間向け): https://lism-css.com/docs/primitives/a--divider/
11
+
12
+ ## Usage
13
+
14
+ ### 基本的な使い方
15
+
16
+ ```jsx
17
+ <Box bgc="base-2" py="40" ta="center">...Contents...</Box>
18
+ <Divider />
19
+ <Box bgc="base-2" py="40" ta="center">...Contents...</Box>
20
+ ```
21
+
22
+ ```html
23
+ <div class="l--box -bgc:base-2 -py:40 -ta:center">...Contents...</div>
24
+ <div class="a--divider" aria-hidden="true"></div>
25
+ <div class="l--box -bgc:base-2 -py:40 -ta:center">...Contents...</div>
26
+ ```
27
+
28
+ ### スタイルの変更
29
+
30
+ ```jsx
31
+ <Divider bds="dotted" bdw="4px" bdc="blue" />
32
+ ```
33
+
34
+ ```html
35
+ <div class="a--divider" aria-hidden="true" style="--bds: dotted; --bdw: 4px; --bdc: var(--blue)"></div>
36
+ ```
37
+
38
+ ### 縦方向の区切り線
39
+
40
+ Property Class `-wm:vertical-rl`(または `<Divider wm="vertical-rl">`)を指定すると縦方向の区切り線になります。Flex 子要素として使うなら `aslf="stretch"` で高さいっぱいに伸ばせます。
41
+
42
+ ```jsx
43
+ <Flex ai="center" g="20">
44
+ <Box fx="1" bgc="base-2" py="40">...Contents...</Box>
45
+ <Divider wm="vertical-rl" bds="dashed" bdw="2px" aslf="stretch" />
46
+ <Box fx="1" bgc="base-2" py="40">...Contents...</Box>
47
+ </Flex>
48
+ ```
49
+
50
+ ```html
51
+ <div class="l--flex -g:20 -ai:center">
52
+ <div class="-fx:1 -bgc:base-2 -py:40">...Contents...</div>
53
+ <div class="a--divider -wm:vertical-rl -aslf:stretch" style="--bds: dashed; --bdw: 2px" aria-hidden="true"></div>
54
+ <div class="-fx:1 -bgc:base-2 -py:40">...Contents...</div>
55
+ </div>
56
+ ```
57
+
58
+ ## 関連プリミティブ
59
+
60
+ - [a--spacer](./a--spacer.md) — 要素間のスペース確保
61
+ - [a--decorator](./a--decorator.md) — 装飾用空要素
62
+ - [a--icon](./a--icon.md) — アイコン要素