From a122f202bf99b0ae239151f7b46c58342842bfb9 Mon Sep 17 00:00:00 2001 From: Josh Gillies <319694+joshgillies@users.noreply.github.com> Date: Wed, 22 Jan 2025 17:56:38 +1100 Subject: [PATCH 1/4] add missing `editor.api.isEditor` method --- .changeset/fast-years-heal.md | 5 +++++ packages/slate/src/create-editor.ts | 2 ++ packages/slate/src/interfaces/editor/editor-api.ts | 3 +++ 3 files changed, 10 insertions(+) create mode 100644 .changeset/fast-years-heal.md diff --git a/.changeset/fast-years-heal.md b/.changeset/fast-years-heal.md new file mode 100644 index 0000000000..849708b4e7 --- /dev/null +++ b/.changeset/fast-years-heal.md @@ -0,0 +1,5 @@ +--- +'@udecode/slate': patch +--- + +add missing `editor.api.isEditor` method diff --git a/packages/slate/src/create-editor.ts b/packages/slate/src/create-editor.ts index 500032e92a..cdac418ae6 100644 --- a/packages/slate/src/create-editor.ts +++ b/packages/slate/src/create-editor.ts @@ -17,6 +17,7 @@ import type { Editor, Value } from './interfaces/editor/editor-type'; import { type EditorApi, type LegacyEditorMethods, + NodeApi, RangeApi, } from './interfaces'; import { blur } from './internal/dom-editor/blur'; @@ -297,6 +298,7 @@ export const createEditor = ({ isCollapsed: () => RangeApi.isCollapsed(editor.selection), isComposing: bindFirst(isComposing, editor), isEditorEnd: bindFirst(isEditorEnd, editor), + isEditor: (value) => NodeApi.isEditor(value), isExpanded: () => RangeApi.isExpanded(editor.selection), isFocused: bindFirst(isFocused, editor), isMerging: bindFirst(HistoryApi.isMerging, editor as any) as any, diff --git a/packages/slate/src/interfaces/editor/editor-api.ts b/packages/slate/src/interfaces/editor/editor-api.ts index 48a8d06d83..38ad473784 100644 --- a/packages/slate/src/interfaces/editor/editor-api.ts +++ b/packages/slate/src/interfaces/editor/editor-api.ts @@ -458,6 +458,9 @@ export type EditorApi = { /** Check if the selection is collapsed */ isCollapsed: () => boolean; + /** Check if a value is an `Editor` object. */ + isEditor: (value: any) => boolean; + /** Check if selection is at editor end */ isEditorEnd: () => boolean; From bbb4cf07f7bd6a791df95809680dfb0ca5b6af31 Mon Sep 17 00:00:00 2001 From: Josh Gillies <319694+joshgillies@users.noreply.github.com> Date: Wed, 22 Jan 2025 19:21:52 +1100 Subject: [PATCH 2/4] remove editor.api.isEditor update breaking changes doc --- .changeset/fast-years-heal.md | 2 +- packages/slate/src/create-editor.ts | 2 -- packages/slate/src/interfaces/editor/editor-api.ts | 3 --- 3 files changed, 1 insertion(+), 6 deletions(-) diff --git a/.changeset/fast-years-heal.md b/.changeset/fast-years-heal.md index 849708b4e7..dab53e9a10 100644 --- a/.changeset/fast-years-heal.md +++ b/.changeset/fast-years-heal.md @@ -2,4 +2,4 @@ '@udecode/slate': patch --- -add missing `editor.api.isEditor` method +update migration guide for `isEditor` -> `NodeApi.isEditor` diff --git a/packages/slate/src/create-editor.ts b/packages/slate/src/create-editor.ts index cdac418ae6..500032e92a 100644 --- a/packages/slate/src/create-editor.ts +++ b/packages/slate/src/create-editor.ts @@ -17,7 +17,6 @@ import type { Editor, Value } from './interfaces/editor/editor-type'; import { type EditorApi, type LegacyEditorMethods, - NodeApi, RangeApi, } from './interfaces'; import { blur } from './internal/dom-editor/blur'; @@ -298,7 +297,6 @@ export const createEditor = ({ isCollapsed: () => RangeApi.isCollapsed(editor.selection), isComposing: bindFirst(isComposing, editor), isEditorEnd: bindFirst(isEditorEnd, editor), - isEditor: (value) => NodeApi.isEditor(value), isExpanded: () => RangeApi.isExpanded(editor.selection), isFocused: bindFirst(isFocused, editor), isMerging: bindFirst(HistoryApi.isMerging, editor as any) as any, diff --git a/packages/slate/src/interfaces/editor/editor-api.ts b/packages/slate/src/interfaces/editor/editor-api.ts index 38ad473784..48a8d06d83 100644 --- a/packages/slate/src/interfaces/editor/editor-api.ts +++ b/packages/slate/src/interfaces/editor/editor-api.ts @@ -458,9 +458,6 @@ export type EditorApi = { /** Check if the selection is collapsed */ isCollapsed: () => boolean; - /** Check if a value is an `Editor` object. */ - isEditor: (value: any) => boolean; - /** Check if selection is at editor end */ isEditorEnd: () => boolean; From f2a7067c7c36dac4f83c2c6bce1fc3dd9c2ad2c2 Mon Sep 17 00:00:00 2001 From: Josh Gillies <319694+joshgillies@users.noreply.github.com> Date: Wed, 22 Jan 2025 19:25:00 +1100 Subject: [PATCH 3/4] update breaking changes doc --- BREAKING_CHANGES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BREAKING_CHANGES.md b/BREAKING_CHANGES.md index 9120762d8c..184c6c2585 100644 --- a/BREAKING_CHANGES.md +++ b/BREAKING_CHANGES.md @@ -423,7 +423,6 @@ For older changelogs, see https://github.com/udecode/plate/blob/main/docs - `isComposing` -> `editor.api.isComposing` - `isDocumentEnd` -> `editor.api.isEditorEnd` - `isEdgePoint` -> `editor.api.isEdge` - - `isEditor` -> `editor.api.isEditor` - `isEditorEmpty` -> `editor.api.isEmpty()` - `isEditorFocused` -> `editor.api.isFocused` - `isEditorNormalizing` -> `editor.api.isNormalizing` @@ -523,6 +522,7 @@ For older changelogs, see https://github.com/udecode/plate/blob/main/docs - `hasSingleChild` -> `NodeApi.hasSingleChild` - `isAncestor` -> `NodeApi.isAncestor` - `isDescendant` -> `NodeApi.isDescendant` + - `isEditor` -> `NodeApi.isEditor` - `isNode` -> `NodeApi.isNode` - `isNodeList` -> `NodeApi.isNodeList` - `nodeMatches` -> `NodeApi.matches` From 25563132440327f5657a8de75dadb0987c5fbe49 Mon Sep 17 00:00:00 2001 From: Josh Gillies <319694+joshgillies@users.noreply.github.com> Date: Wed, 22 Jan 2025 19:40:22 +1100 Subject: [PATCH 4/4] remove changeset --- .changeset/fast-years-heal.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 .changeset/fast-years-heal.md diff --git a/.changeset/fast-years-heal.md b/.changeset/fast-years-heal.md deleted file mode 100644 index dab53e9a10..0000000000 --- a/.changeset/fast-years-heal.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -'@udecode/slate': patch ---- - -update migration guide for `isEditor` -> `NodeApi.isEditor`