@burger-editor/blocks 4.0.0-alpha.2 → 4.0.0-alpha.20
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 +35 -14
- package/dist/index.js +340 -247
- package/package.json +9 -9
- package/types.d.ts +6 -0
- package/LICENSE +0 -21
package/README.md
CHANGED
|
@@ -10,29 +10,38 @@
|
|
|
10
10
|
|
|
11
11
|
```html
|
|
12
12
|
<div data-bge-name="{ブロック名}" data-bge-container="inline:center:wrap">
|
|
13
|
-
<div data-bge-
|
|
14
|
-
<div data-bge-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
<div data-bge-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
<div data-bge-
|
|
23
|
-
|
|
13
|
+
<div data-bge-container-frame>
|
|
14
|
+
<div data-bge-group>
|
|
15
|
+
<div data-bge-item>{アイテムの01HTML}</div>
|
|
16
|
+
<div data-bge-item>{アイテムの02HTML}</div>
|
|
17
|
+
</div>
|
|
18
|
+
<div data-bge-group>
|
|
19
|
+
<div data-bge-item>{アイテムの01HTML}</div>
|
|
20
|
+
<div data-bge-item>{アイテムの02HTML}</div>
|
|
21
|
+
</div>
|
|
22
|
+
<div data-bge-group>
|
|
23
|
+
<div data-bge-item>{アイテムの01HTML}</div>
|
|
24
|
+
<div data-bge-item>{アイテムの02HTML}</div>
|
|
25
|
+
</div>
|
|
24
26
|
</div>
|
|
25
27
|
</div>
|
|
26
28
|
```
|
|
27
29
|
|
|
28
30
|
### ブロックを構成する要素
|
|
29
31
|
|
|
32
|
+
- コンテナ: `data-bge-container`
|
|
33
|
+
- コンテナフレーム: `data-bge-container-frame`
|
|
34
|
+
- グループ: `data-bge-group`
|
|
35
|
+
- アイテム: `data-bge-item`
|
|
36
|
+
|
|
30
37
|
#### コンテナ
|
|
31
38
|
|
|
32
39
|
`data-bge-container`属性はコンテナの性質を表します。ブロックのルート要素にあたります。属性値はコロン区切りで表現し、先頭はコンテナのタイプを表し、その後にオプションが続きます。
|
|
33
40
|
|
|
34
41
|
`data-bge-name`属性はブロックの名前を表します。ブロック選択の際に利用されますが、振る舞いには影響しません（⚠️ つまり、この属性を利用したスタイル変更は推奨されません）。
|
|
35
42
|
|
|
43
|
+
この要素には `container-name: bge-container` が付与されます。これは、CSSコンテナクエリのコンテナ名として利用されます。
|
|
44
|
+
|
|
36
45
|
##### コンテナタイプ
|
|
37
46
|
|
|
38
47
|
アイテムの配置方法を表します。
|
|
@@ -43,9 +52,13 @@
|
|
|
43
52
|
|
|
44
53
|
##### `grid`オプション
|
|
45
54
|
|
|
46
|
-
- `[数値]`: グリッドの列数（ `grid-template-columns: repeat([数値], 1fr);` ） 1〜5
|
|
55
|
+
- `[数値]`: グリッドの列数（ `grid-template-columns: repeat([数値], 1fr);` ） 1〜5の範囲で指定可能。
|
|
56
|
+
- `auto-fit`: 自動列数調整（空白最小）（ `grid-template-columns: repeat(auto-fit, minmax(calc(var(--bge-auto-fit-base-width) / [数値]), 1fr));` ）
|
|
57
|
+
規定幅（CSSカスタムプロパティ`--bge-auto-fit-base-width`）を基準に指定した列数で割った数値に近い幅を保ちながら、コンテナの幅に応じて自動的に列数を調整します。空のトラックは折りたたまれ、既存のアイテムが利用可能なスペースを埋めるように拡張されます。
|
|
58
|
+
- `auto-fill`: 自動列数調整（空白保持）（ `grid-template-columns: repeat(auto-fill, minmax(calc(var(--bge-auto-fit-base-width) / [数値]), 1fr));` ）
|
|
59
|
+
規定幅を基準に自動的に列数を調整しますが、アイテムが不足している場合でも空のトラックが保持され、レイアウト内に空白が生じます。
|
|
47
60
|
|
|
48
|
-
例: `data-bge-container="grid:3"`
|
|
61
|
+
例: `data-bge-container="grid:3"`、`data-bge-container="grid:3:auto-fit"`、`data-bge-container="grid:3:auto-fill"`
|
|
49
62
|
|
|
50
63
|
##### `inline`オプション
|
|
51
64
|
|
|
@@ -74,7 +87,15 @@
|
|
|
74
87
|
|
|
75
88
|
##### 共通オプション
|
|
76
89
|
|
|
77
|
-
- `immutable`:
|
|
90
|
+
- `immutable`: アイテムの増減ができなくなります。また、タイプが`grid`の場合は列数の変更ができなくなります。
|
|
91
|
+
|
|
92
|
+
#### コンテナフレーム
|
|
93
|
+
|
|
94
|
+
コンテナフレームは`data-bge-container-frame`属性をもつ要素で、コンテナの中身をラップします。
|
|
95
|
+
|
|
96
|
+
`grid`や`inline`の性質が実際に適用される要素です。
|
|
97
|
+
|
|
98
|
+
※CSS Containerは自信に再帰的にクエリーや`cq`系単位が使えない仕様があるため、CSS Containerを適用させる「コンテナ」と、コンテナの性質（`grid`や`inline`）を適用させる「コンテナフレーム」に分けています。
|
|
78
99
|
|
|
79
100
|
#### グループ
|
|
80
101
|
|