Skip to content

Commit

Permalink
Adjust doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Mati365 committed Aug 20, 2024
1 parent 10d1f1e commit 9a10cb7
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/getting-started/integrations/react.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ The `CKEditorContext` component supports the following properties:
* `config` – The CKEditor 5 context configuration.
* `isLayoutReady` – A property that delays the context creation when set to `false`. It creates the context and the editor children once it is `true` or unset. Useful when the CKEditor 5 annotations or a presence list are used.
* `id` – The context ID. When this property changes, the component restarts the context with its editor and reinitializes it based on the current configuration.
* `onChangeInitializedEditors` – A function called when any editor is initialized or destroyed in the tree. This function is called with dictionary of fully initialized editors and the `contextItemMetadata.name` property set on `CKEditor` component is used as a key of such map. When `contextItemMetadata` property is not present on `CKEditor` component then it's ID will be used as a key in such dictionary. It's possible to add additional data besides `name` to `contextItemMetadata` in `CKEditor` component, that will be forwarded to the `onChangeInitializedEditors`.
* `onChangeInitializedEditors` – This function is called when any editor is initialized or destroyed in the tree. It receives a dictionary of fully initialized editors, where the key is the value of the `contextItemMetadata.name` property set on the `CKEditor` component. If the `contextItemMetadata` property is not present, the editor's ID is used as the key. Additional data can be added to the `contextItemMetadata` in the `CKEditor` component, which will be passed to the `onChangeInitializedEditors` function.
* `onReady` – A function called when the context is initialized but before the editors in the tree are set up. After this function is executed, you can track additions and removals in the context tree using the `context.editors.on('change', () => {})` method.
* `onError` – A function called when the context has crashed during the initialization or during the runtime. It receives two arguments: the error instance and the error details. Error details is an object that contains two properties:
* `{String} phase`: `'initialization'|'runtime'` – Informs when the error has occurred (during the editor or context initialization, or after the initialization).
Expand Down

0 comments on commit 9a10cb7

Please sign in to comment.