mirror/slate
1
0
Fork 0
mirror of https://github.com/ianstormtaylor/slate.git synced 2025-08-16 04:04:06 +02:00
Code Issues Releases Wiki Activity

Added comments to with-history and with-react to help fix TypeScript errors

Browse Source
This commit is contained in:
Sunny Hirai
2021-03-29 01:01:25 -07:00
parent 6b94fb17c8
commit 0434182166
2 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/slate-history/src/with-history.ts
View File

@@ -5,6 +5,11 @@ import { HistoryEditor } from './history-editor'
/** /**
* The `withHistory` plugin keeps track of the operation history of a Slate * The `withHistory` plugin keeps track of the operation history of a Slate
* editor as operations are applied to it, using undo and redo stacks. * editor as operations are applied to it, using undo and redo stacks.
*
* If you are using TypeScript, you must extend Slate's CustomTypes to use
* this plugin.
*
* See https://docs.slatejs.org/concepts/11-typescript to learn how.
*/ */
export const withHistory = <T extends Editor>(editor: T) => { export const withHistory = <T extends Editor>(editor: T) => {

5
packages/slate-react/src/plugin/with-react.ts
View File

@@ -8,6 +8,11 @@ import { isDOMText, getPlainText } from '../utils/dom'
/** /**
* `withReact` adds React and DOM specific behaviors to the editor. * `withReact` adds React and DOM specific behaviors to the editor.
*
* If you are using TypeScript, you must extend Slate's CustomTypes to use
* this plugin.
*
* See https://docs.slatejs.org/concepts/11-typescript to learn how.
*/ */
export const withReact = <T extends Editor>(editor: T) => { export const withReact = <T extends Editor>(editor: T) => {