@burger-editor/client 4.0.0-alpha.61 → 4.0.0-alpha.63
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 +25 -3
- package/dist/client.js +1282 -1279
- package/dist/client.js.map +1 -1
- package/dist/engine-state.svelte.d.ts +42 -0
- package/dist/engine-state.svelte.d.ts.map +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/initial-insertion-button.svelte.d.ts +1 -0
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -7,13 +7,13 @@ BurgerEditorのクライアント側UIパッケージです。Svelteベースの
|
|
|
7
7
|
## インストール
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
|
-
|
|
10
|
+
yarn add @burger-editor/client @burger-editor/core @burger-editor/blocks
|
|
11
11
|
```
|
|
12
12
|
|
|
13
13
|
または
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
|
|
16
|
+
npm install @burger-editor/client @burger-editor/core @burger-editor/blocks
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## 公開API
|
|
@@ -34,7 +34,7 @@ function createBurgerEditorClient(
|
|
|
34
34
|
|
|
35
35
|
#### パラメータ
|
|
36
36
|
|
|
37
|
-
`options` は `BurgerEditorEngineOptions` から `ui` と `blockMenu`
|
|
37
|
+
`options` は `BurgerEditorEngineOptions` から `ui` と `blockMenu` を除いたオプションです。client は内部で `ui`, `blockMenu`, `initialInsertionButton`, `defineCustomElement` を Svelte 実装で上書きするため、これらを手動で指定する必要はありません。以下の主要なプロパティがあります：
|
|
38
38
|
|
|
39
39
|
**必須プロパティ:**
|
|
40
40
|
|
|
@@ -71,6 +71,28 @@ Promise<{
|
|
|
71
71
|
|
|
72
72
|
- `engine`: BurgerEditorエンジンのインスタンス
|
|
73
73
|
|
|
74
|
+
### `version`
|
|
75
|
+
|
|
76
|
+
パッケージのバージョン文字列定数です。
|
|
77
|
+
|
|
78
|
+
### `attachDraftSwitcher(engine)`
|
|
79
|
+
|
|
80
|
+
下書き切り替えUIを手動でアタッチする関数です。`engine.hasDraft()` が `true` の場合にのみ UI を生成します。
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import { attachDraftSwitcher } from '@burger-editor/client';
|
|
84
|
+
|
|
85
|
+
attachDraftSwitcher(engine);
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### `Migrator`
|
|
89
|
+
|
|
90
|
+
`@burger-editor/migrator` パッケージからの re-export です。
|
|
91
|
+
|
|
92
|
+
### `getConfig()` (非推奨)
|
|
93
|
+
|
|
94
|
+
> **⚠️ @deprecated**: この関数は非推奨です。各プラットフォームで Config の型が異なるため、直接使用しないでください。
|
|
95
|
+
|
|
74
96
|
## 使用例
|
|
75
97
|
|
|
76
98
|
以下は基本的な使用例です：
|