@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.
- package/README.ja.md +1 -1
- package/dist/data/docs-index.json +267 -174
- package/dist/data/guides/SKILL.md +95 -54
- package/dist/data/guides/base-styles.md +2 -2
- package/dist/data/guides/components-core.md +87 -132
- package/dist/data/guides/components-ui.md +3 -15
- package/dist/data/guides/css-rules.md +110 -24
- package/dist/data/guides/naming.md +204 -0
- package/dist/data/guides/primitive-class.md +84 -0
- package/dist/data/guides/primitives/a--decorator.md +43 -0
- package/dist/data/guides/primitives/a--divider.md +62 -0
- package/dist/data/guides/primitives/a--icon.md +105 -0
- package/dist/data/guides/primitives/a--spacer.md +63 -0
- package/dist/data/guides/primitives/is--boxLink.md +97 -0
- package/dist/data/guides/primitives/is--container.md +46 -0
- package/dist/data/guides/primitives/is--layer.md +71 -0
- package/dist/data/guides/primitives/is--wrapper.md +87 -0
- package/dist/data/guides/primitives/l--box.md +31 -0
- package/dist/data/guides/primitives/l--center.md +55 -0
- package/dist/data/guides/primitives/l--cluster.md +38 -0
- package/dist/data/guides/primitives/l--columns.md +72 -0
- package/dist/data/guides/primitives/l--flex.md +74 -0
- package/dist/data/guides/primitives/l--flow.md +134 -0
- package/dist/data/guides/primitives/l--fluidCols.md +71 -0
- package/dist/data/guides/primitives/l--frame.md +94 -0
- package/dist/data/guides/primitives/l--grid.md +68 -0
- package/dist/data/guides/primitives/l--sideMain.md +102 -0
- package/dist/data/guides/primitives/l--stack.md +56 -0
- package/dist/data/guides/primitives/l--switchCols.md +69 -0
- package/dist/data/guides/primitives/l--tileGrid.md +61 -0
- package/dist/data/guides/property-class.md +12 -11
- package/dist/data/guides/set-class.md +11 -26
- package/dist/data/guides/tokens.md +26 -9
- package/dist/data/guides/utility-class.md +9 -8
- package/dist/data/meta.js +2 -2
- package/dist/lib/load-markdown.d.ts +3 -2
- package/dist/lib/load-markdown.js +23 -5
- package/dist/lib/search.js +20 -1
- package/dist/tools/get-component.js +119 -30
- package/dist/tools/get-guide.js +1 -1
- package/dist/tools/search-docs.js +1 -1
- package/package.json +1 -1
- package/dist/data/guides/module-class.md +0 -162
package/package.json
CHANGED
|
@@ -1,162 +0,0 @@
|
|
|
1
|
-
# モジュールクラス
|
|
2
|
-
|
|
3
|
-
Lism CSS では、クラス名のプレフィックスによってモジュールの種類と CSS Layer の所属が決まります。
|
|
4
|
-
すべてのモジュールクラスは `@layer lism-modules` に属します(`set--` を除く)。
|
|
5
|
-
|
|
6
|
-
## TOC
|
|
7
|
-
|
|
8
|
-
- [プレフィックス一覧](#プレフィックス一覧)
|
|
9
|
-
- [State Module(`is--`)](#state-moduleis--)
|
|
10
|
-
- [Layout Module(`l--`)](#layout-modulel--)
|
|
11
|
-
- [Atomic Module(`a--`)](#atomic-modulea--)
|
|
12
|
-
- [Component(`c--`)](#componentc--)
|
|
13
|
-
|
|
14
|
-
[詳細](https://lism-css.com/docs/module-class/)
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## プレフィックス一覧
|
|
19
|
-
|
|
20
|
-
| プレフィックス | 種類 | 役割 |
|
|
21
|
-
|--------------|------|------|
|
|
22
|
-
| `is--` | State Module | 複数のモジュールに付け外しできる汎用的な状態クラス |
|
|
23
|
-
| `l--` | Layout Module | レイアウトの構成単位となるモジュール |
|
|
24
|
-
| `a--` | Atomic Module | レイアウトの最小単位(アイコン・区切り線等) |
|
|
25
|
-
| `c--` | Component | 具体的な役割を持つコンポーネント |
|
|
26
|
-
|
|
27
|
-
**併用ルール:**
|
|
28
|
-
- `is--` は他のすべてのモジュールと併用可能
|
|
29
|
-
- `l--` と `c--` は併用可能(例: `class="l--flex c--nav"`)
|
|
30
|
-
- 同カテゴリ内の併用は不可(例: `l--flex` と `l--grid` は同要素に付けない)
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
## State Module(`is--`)
|
|
34
|
-
|
|
35
|
-
[詳細](https://lism-css.com/docs/state/)
|
|
36
|
-
|
|
37
|
-
要素に構造的な振る舞い(状態)を付与するクラスです。他のモジュールクラスと自由に組み合わせられます。
|
|
38
|
-
|
|
39
|
-
| クラス | 用途 | 備考 |
|
|
40
|
-
|--------|------|------|
|
|
41
|
-
| `is--container` | コンテナクエリの基準要素にする(`container-type: inline-size`) | Lism のレスポンシブ機能の前提。判定基準にしたいラッパーに付与する |
|
|
42
|
-
| `is--wrapper` | 直下の子要素のコンテンツ幅を制限する | `-contentSize:s` / `-contentSize:l` でプリセットサイズ指定可能。デフォルト: `--sz--m` |
|
|
43
|
-
| `is--layer` | `position: absolute; inset: 0` の絶対配置レイヤー | `overflow: hidden` も適用される |
|
|
44
|
-
| `is--linkBox` | ボックス全体をクリッカブルなリンク領域にする | `position: relative; isolation: isolate` を適用 |
|
|
45
|
-
| `is--vertical` | 縦書きモード(`writing-mode: var(--vertical-mode)`) | `is--vertical@sm`, `is--vertical@md` でブレークポイント指定可能 |
|
|
46
|
-
| `is--skipFlow` | `l--flow` 内で次の兄弟要素のフロー余白をリセット | `is--skipFlow + *` で `--flow: 0px` |
|
|
47
|
-
| `is--side` | `l--sideMain` 内でサイド要素を示す | `l--sideMain` と組み合わせて使用 |
|
|
48
|
-
|
|
49
|
-
### コンポーネントでの対応
|
|
50
|
-
|
|
51
|
-
| JSX Prop | HTML クラス |
|
|
52
|
-
|----------|-----------|
|
|
53
|
-
| `isContainer` | `is--container` |
|
|
54
|
-
| `isWrapper` / `isWrapper='s'` | `is--wrapper` / `is--wrapper -contentSize:s` |
|
|
55
|
-
| `isLayer` | `is--layer` |
|
|
56
|
-
| `isLinkBox` | `is--linkBox` |
|
|
57
|
-
| `isVertical` | `is--vertical` |
|
|
58
|
-
|
|
59
|
-
```jsx
|
|
60
|
-
// Layout 優先の書き方(推奨)
|
|
61
|
-
<Stack isLayer>背景レイヤー</Stack>
|
|
62
|
-
// → <div class="l--stack is--layer">...</div>
|
|
63
|
-
|
|
64
|
-
<Flex isWrapper="l">コンテンツ</Flex>
|
|
65
|
-
// → <div class="l--flex is--wrapper -contentSize:l">...</div>
|
|
66
|
-
```
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
## Layout Module(`l--`)
|
|
70
|
-
|
|
71
|
-
レイアウト構造を定義するメインのモジュール群です。Lism コンポーネントでは `layout` prop が内部で固定されており、対応するクラスが自動出力されます。
|
|
72
|
-
|
|
73
|
-
| クラス | コンポーネント | CSS display | 用途 |
|
|
74
|
-
|--------|-------------|-------------|------|
|
|
75
|
-
| `l--box` | `<Box>` | — | 汎用ボックス |
|
|
76
|
-
| `l--flex` | `<Flex>` | `flex` | Flexbox(横方向)。子要素に `min-width: 0` |
|
|
77
|
-
| `l--stack` | `<Stack>` | `flex` | 縦積み(`flex-direction: column`) |
|
|
78
|
-
| `l--cluster` | `<Cluster>` | `flex` | 折り返し Flex(`flex-wrap: wrap; align-items: center`) |
|
|
79
|
-
| `l--grid` | `<Grid>` | `grid` | CSS Grid。`--gtc`, `--gtr`, `--gta` 変数で制御 |
|
|
80
|
-
| `l--center` | `<Center>` | `grid` | 中央配置(`place-content: center; place-items: center`) |
|
|
81
|
-
| `l--flow` | `<Flow>` | `flow-root` | フローコンテンツ。子要素間に `margin-block-start: var(--flow)` |
|
|
82
|
-
| `l--frame` | `<Frame>` | — | アスペクト比フレーム。直下メディアに `object-fit: cover` |
|
|
83
|
-
| `l--columns` | `<Columns>` | `grid` | 固定カラム数(`grid-template-columns: repeat(var(--cols), minmax(0, 1fr))`) |
|
|
84
|
-
| `l--tileGrid` | `<TileGrid>` | `grid` | 均等タイルグリッド(`grid-template: repeat(var(--rows,1), minmax(0, 1fr)) / repeat(var(--cols,1), minmax(0, 1fr))`) |
|
|
85
|
-
| `l--fluidCols` | `<FluidCols>` | `grid` | 流動カラム(`auto-fit` / `auto-fill`)。`--cols` で最小幅指定 |
|
|
86
|
-
| `l--switchCols` | `<SwitchCols>` | `flex` | ブレークポイントでカラム切り替え。`--breakSize` で制御 |
|
|
87
|
-
| `l--sideMain` | `<SideMain>` | `flex` | サイド+メインの2カラム。`--sideW`, `--mainW` で制御 |
|
|
88
|
-
|
|
89
|
-
### レイアウト固有の Props
|
|
90
|
-
|
|
91
|
-
```jsx
|
|
92
|
-
<Grid gtc="1fr 1fr" gtr="auto">...</Grid>
|
|
93
|
-
<Columns cols={3}>...</Columns> // --cols: 3
|
|
94
|
-
<FluidCols autoFill>...</FluidCols> // --autoMode: auto-fill
|
|
95
|
-
<SwitchCols breakSize="480px">...</SwitchCols> // --breakSize: 480px
|
|
96
|
-
<SideMain sideW="200px" mainW="1fr">...</SideMain>
|
|
97
|
-
<Flow flow="30">...</Flow> // --flow: var(--s30)
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
## Atomic Module(`a--`)
|
|
102
|
-
|
|
103
|
-
レイアウトの最小単位となる単機能モジュールです。
|
|
104
|
-
|
|
105
|
-
| クラス | コンポーネント | 用途 |
|
|
106
|
-
|--------|-------------|------|
|
|
107
|
-
| `a--icon` | `<Icon>` | SVG アイコン。`flex-shrink: 0`, デフォルトサイズ `1em` |
|
|
108
|
-
| `a--divider` | `<Divider>` | 区切り線。`--bdc`, `--bds`, `--bdw` 変数でカスタマイズ |
|
|
109
|
-
| `a--spacer` | `<Spacer>` | 空白要素(`min-height: 1px; min-width: 1px`) |
|
|
110
|
-
| `a--decorator` | `<Decorator>` | 装飾用要素(SCSS定義なし、クラス名のみ出力) |
|
|
111
|
-
|
|
112
|
-
```jsx
|
|
113
|
-
<Icon as={LucideArrowRight} fz="xl" />
|
|
114
|
-
<Media as="img" src="/image.jpg" alt="説明" ar="16/9" />
|
|
115
|
-
<Divider />
|
|
116
|
-
<Spacer h="40" />
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
## Component(`c--`)
|
|
121
|
-
|
|
122
|
-
[詳細](https://lism-css.com/docs/components/)
|
|
123
|
-
|
|
124
|
-
より具体的な役割を持つコンポーネントのクラスです。他のクラスとの組み合わせを前提とした設計になっています。
|
|
125
|
-
|
|
126
|
-
### ユーザー定義コンポーネント
|
|
127
|
-
|
|
128
|
-
独自のコンポーネントを作成する場合は `c--{name}` の命名規則に従います。
|
|
129
|
-
|
|
130
|
-
```css
|
|
131
|
-
@layer lism-modules {
|
|
132
|
-
.c--my-card {
|
|
133
|
-
border: 1px solid var(--brand);
|
|
134
|
-
border-radius: var(--bdrs--20);
|
|
135
|
-
padding: var(--s30);
|
|
136
|
-
}
|
|
137
|
-
.c--my-card_header { ... } /* 子要素 */
|
|
138
|
-
.c--my-card_body { ... }
|
|
139
|
-
}
|
|
140
|
-
```
|
|
141
|
-
|
|
142
|
-
- バリエーション: `.c--button.c--button--outline`
|
|
143
|
-
- 子要素: `.c--card_header`, `.c--card_body`
|
|
144
|
-
|
|
145
|
-
### `@lism-css/ui` で提供されるコンポーネント
|
|
146
|
-
|
|
147
|
-
`@lism-css/ui` パッケージでは、以下の `c--` クラスを持つ UI コンポーネントが利用できます。
|
|
148
|
-
|
|
149
|
-
| クラス | コンポーネント | 用途 |
|
|
150
|
-
|--------|-------------|------|
|
|
151
|
-
| `c--button` | `<Button>` | ボタン(`c--button--outline` バリエーションあり) |
|
|
152
|
-
| `c--badge` | `<Badge>` | ラベル・バッジ(`c--badge--outline` バリエーションあり) |
|
|
153
|
-
| `c--avatar` | `<Avatar>` | ユーザーアイコン |
|
|
154
|
-
| `c--accordion` | `<Accordion>` | 折りたたみパネル(`_item`, `_panel`, `_button`, `_content`, `_icon` 子要素あり) |
|
|
155
|
-
| `c--tabs` | `<Tabs>` | タブ切り替え UI(`_list`, `_tab`, `_panel` 子要素あり) |
|
|
156
|
-
| `c--modal` | `<Modal>` | モーダルダイアログ(`_inner` 子要素あり) |
|
|
157
|
-
| `c--details` | `<Details>` | details/summary(`_summary`, `_icon`, `_body` 子要素あり) |
|
|
158
|
-
| `c--alert` | `<Alert>` | 警告・通知ボックス |
|
|
159
|
-
| `c--callout` | `<Callout>` | 注釈・補足(`_head`, `_icon`, `_title`, `_body` 子要素あり) |
|
|
160
|
-
| `c--chat` | `<Chat>` | チャット風 UI(`_avatar`, `_name`, `_body`, `_content`, `_deco` 子要素あり) |
|
|
161
|
-
| `c--navMenu` | `<NavMenu>` | ナビゲーションメニュー(`_item`, `_link`, `_nest` 子要素あり) |
|
|
162
|
-
| `c--shapeDivider` | `<ShapeDivider>` | 図形区切り線(`_inner`, `_svg` 子要素あり) |
|