You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`theme`| string |`light`| Chrome palette: `light`, `dark`, or `auto`. |
22
22
|`upload_url`| string |`null`| Optional URL for Simple Upload Adapter (demo/apps provide POST endpoints). |
23
23
24
-
## Legacy flat YAML
24
+
## Legacy keys and flat YAML
25
25
26
-
If the root has no `configs` key, the extension maps flat keys into a single profile under `configs` using `default_config` (default `default`):
26
+
-**Renamed keys:**`default_config` / `configs` were renamed to `default_profile` / `profiles`. Legacy keys are still accepted via normalization (mapped when the new keys are absent).
27
+
-**Flat layout:** If the root has no `profiles` (nor legacy `configs`) key, the extension maps flat keys into a single profile under `profiles` using `default_profile` (default `default`):
|`config`|`string\|null`| Profile name under `nowo_ckeditor5_editor.configs`. `null`/empty uses `default_config`.|
35
+
|`config`|`string\|null`| Profile name under `nowo_ckeditor5_editor.profiles`. `null`/empty uses `default_profile`. (Form option key remains `config` for BC.)|
35
36
|`editor_config`|`array`| Keys merged over the YAML profile: `toolbar`, `min_height`, `form_theme`, `debug`, `preset`, `theme`, `upload_url`. |
36
37
|`toolbar`| bool | Field-level override. |
37
38
|`min_height`| string | Field-level override. |
@@ -59,4 +60,4 @@ Translations use the domain **`NowoCkeditor5EditorBundle`** (`src/Resources/tran
59
60
60
61
## Parameters exposed to the container
61
62
62
-
The DI extension sets parameters from configuration (including backward-compatible scalars for the **default** profile). Prefer resolving behaviour through `Ckeditor5EditorType` and YAML profiles.
63
+
The DI extension sets `nowo_ckeditor5_editor.default_profile` and `nowo_ckeditor5_editor.profiles`, plus legacy aliases `nowo_ckeditor5_editor.default_config` / `nowo_ckeditor5_editor.configs` (same values), and backward-compatible scalars for the **default** profile. Prefer resolving behaviour through `Ckeditor5EditorType` and YAML profiles.
Copy file name to clipboardExpand all lines: docs/INSTALLATION.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,8 +28,8 @@ Create configuration (recommended — named profiles):
28
28
```yaml
29
29
# config/packages/nowo_ckeditor5_editor.yaml
30
30
nowo_ckeditor5_editor:
31
-
default_config: simple
32
-
configs:
31
+
default_profile: simple
32
+
profiles:
33
33
simple:
34
34
preset: simple
35
35
toolbar: true
@@ -39,7 +39,7 @@ nowo_ckeditor5_editor:
39
39
theme: light
40
40
```
41
41
42
-
You may use **legacy flat** keys at the root (without `configs`): they are normalized into `configs.default`. Prefer explicit `configs` for multiple profiles.
42
+
You may use **legacy flat** keys at the root (without `profiles`): they are normalized into `profiles.default`. Prefer explicit `profiles` for multiple profiles. Legacy YAML keys `default_config` / `configs` are still accepted and mapped to `default_profile` / `profiles`.
43
43
44
44
See [CONFIGURATION.md](CONFIGURATION.md) for the full reference.
See [`CHANGELOG.md`](CHANGELOG.md) (section **1.1.4**).
98
98
99
+
## To 1.2.0 from 1.1.4
100
+
101
+
Minor release: YAML keys **`default_config`** / **`configs`** renamed to **`default_profile`** / **`profiles`** (AuditKit-style). Prefer the new names in app config.
102
+
103
+
**Before (≤ 1.1.4):**
104
+
105
+
```yaml
106
+
nowo_ckeditor5_editor:
107
+
default_config: simple
108
+
configs:
109
+
simple:
110
+
preset: simple
111
+
```
112
+
113
+
**After (1.2.0+):**
114
+
115
+
```yaml
116
+
nowo_ckeditor5_editor:
117
+
default_profile: simple
118
+
profiles:
119
+
simple:
120
+
preset: simple
121
+
```
122
+
123
+
- Legacy keys are still accepted via `beforeNormalization` when the new keys are absent.
124
+
- Container parameters `nowo_ckeditor5_editor.default_config` / `nowo_ckeditor5_editor.configs` remain as aliases of the new parameters.
125
+
- Form option key **`config`** is unchanged.
126
+
- **Composer**: `composer update nowo-tech/ckeditor5-editor-bundle` (with `^1.0` or `^1.2`); then `php bin/console cache:clear`.
127
+
128
+
See [`CHANGELOG.md`](CHANGELOG.md) (section **1.2.0**) and [`CONFIGURATION.md`](CONFIGURATION.md).
129
+
99
130
## To 1.x (first documented stable line)
100
131
101
132
When upgrading from snapshots without semver tags in your project:
-**Configuration**: prefer explicit **`configs`** + **`default_config`** (see [`CONFIGURATION.md`](CONFIGURATION.md)). Legacy flat YAML under `nowo_ckeditor5_editor`is still accepted and normalized.
135
+
- **Configuration**: prefer explicit **`profiles`** + **`default_profile`** (see [`CONFIGURATION.md`](CONFIGURATION.md)). Legacy keys `default_config` / `configs` and flat YAML under `nowo_ckeditor5_editor` are still accepted and normalized.
105
136
- **Bootstrap**: ensure your layout loads the bundle script once per page:
0 commit comments