Revert "docs"

udecode · May 8, 2021 · dfbde8b · dfbde8b
1 parent 38b65a6
commit dfbde8b
Show file tree

Hide file tree

Showing 16 changed files with 57 additions and 105 deletions.
diff --git a/.changeset/core-major-1.md b/.changeset/core-major-1.md
diff --git a/.changeset/core-major-2.md b/.changeset/core-major-2.md
diff --git a/.changeset/core-major-3.md b/.changeset/core-major-3.md
diff --git a/.changeset/core-major-eight-poems-travel.md b/.changeset/core-major-eight-poems-travel.md
@@ -0,0 +1,25 @@
+---
+
+"@udecode/slate-plugins-core": major
+------------------------------------
+
+- renamed:
+  - `useTSlate` to `useEditorState`
+  - `useTSlateStatic` to `useEditorRef`
+  - `useStoreEditor` to `useStoreEditorRef`
+- removed:
+  - `useEditorId` in favor of `useEditorRef().id`
+  - `useEditorOptions` in favor of `useEditorRef().options`
+  - `useSlatePluginOptions` in favor of
+    `getSlatePluginOptions(useEditorRef(), pluginKey)`
+  - `useSlatePluginType` in favor of
+    `getSlatePluginType(useEditorRef(), pluginKey)`
+  - `pipeOnDOMBeforeInput` in favor of `pipeHandler`
+  - `pipeOnKeyDown` in favor of `pipeHandler`
+- types:
+  - renamed:
+    - `SlatePluginsState` to `SlatePluginsStates`
+    - `State` to `SlatePluginsState`
+  - removed:
+    - `OnDOMBeforeInput` in favor of
+    - `OnKeyDown` in favor of `KeyboardHandler`
diff --git a/.changeset/core-minor-1.md b/.changeset/core-minor-1.md
diff --git a/.changeset/core-minor-10.md b/.changeset/core-minor-10.md
diff --git a/.changeset/core-minor-11.md b/.changeset/core-minor-11.md
diff --git a/.changeset/core-minor-2.md b/.changeset/core-minor-2.md
diff --git a/.changeset/core-minor-3.md b/.changeset/core-minor-3.md
diff --git a/.changeset/core-minor-4.md b/.changeset/core-minor-4.md
diff --git a/.changeset/core-minor-5.md b/.changeset/core-minor-5.md
diff --git a/.changeset/core-minor-6.md b/.changeset/core-minor-6.md
diff --git a/.changeset/core-minor-7.md b/.changeset/core-minor-7.md
diff --git a/.changeset/core-minor-8.md b/.changeset/core-minor-8.md
diff --git a/.changeset/core-minor-9.md b/.changeset/core-minor-9.md
diff --git a/.changeset/core-minor-eight-poems-travel.md b/.changeset/core-minor-eight-poems-travel.md
@@ -0,0 +1,32 @@
+---
+"@udecode/slate-plugins-core": minor
+---
+
+- `useEditableProps` (used by `SlatePlugins`):
+  - new fields returned: all handler props from the plugins (if defined)
+  - new core plugins with the following fields:
+    - `onFocus: setEventEditorId('focus', id)`
+    - `onBlur: setEventEditorId('blur', id)`
+    - You can add your own handlers in a plugin
+- `EditorStateEffect`: a new component used by `SlatePlugins` to update
+  the editor state.
+- `setEventEditorId`: a new action. Set an editor id by event key.
+- `eventEditorStore`, `useEventEditorStore`: a new store. Store where
+  the keys are event names and the values are editor ids.
+- `useEventEditorId`: a new selector. Get the editor id by `event`
+  key.
+- `useStoreEditorSelection`: a new selector. Get the editor selection
+  which is updated on editor change.
+- `useStoreEditorState`: a new selector. Get editor state which is
+  updated on editor change. Similar to `useSlate`.
+- `SlatePlugin`: the previous plugin could implement the following
+  handlers: `onChange`, `onDOMBeforeInput` and `onKeyDown`. The plugins
+  now implement all DOM handlers: clipboard, composition, focus, form,
+  image, keyboard, media, mouse, selection, touch, pointer, ui, wheel
+  animation and transition events.
+- `SlatePluginsState` (store interface):
+  - a new field `keyChange` incremented by
+    `SlatePlugins` on `useSlate` update.
+  - a new field `selection = editor.selection` updated on `useSlate`
+    update.
+- `pipeHandler`: a new function. Generic pipe for handlers.