@fileverse-dev/ddoc 2.1.0-patch-5 → 2.1.0-yjs-patch-2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -5
- package/dist/index.es.js +34635 -38104
- package/dist/package/extensions/d-block/dblock-node-view.d.ts +1 -0
- package/dist/package/extensions/d-block/dblock.d.ts +1 -0
- package/dist/package/extensions/default-extension.d.ts +1 -1
- package/dist/package/types.d.ts +3 -1
- package/dist/package/use-ddoc-editor.d.ts +2 -1
- package/dist/package/useZoomLevelListener.d.ts +12 -0
- package/dist/package/utils/isJsonString.d.ts +1 -0
- package/dist/package/utils/template-utils.d.ts +1 -1
- package/dist/style.css +1 -1
- package/package.json +3 -1
package/README.md
CHANGED
|
@@ -45,11 +45,13 @@ The `DdocProps` interface is a TypeScript interface that defines the properties
|
|
|
45
45
|
| `secureImageUploadUrl` (optional) | `string` | Api Url for secure image upload |
|
|
46
46
|
| `initialContent` (optional) | `JSONContent` | Initial content of the editor |
|
|
47
47
|
| `onChange` (optional) | `(changes: JSONContent) => void` | Optional function that gets triggered with the latest content of the editor on every change in the editor |
|
|
48
|
-
| `onCollaboratorChange` (optional) | `(collaborators?: IDocCollabUsers[] ) => void` | Optional function that gets triggered when a user join or leave the doc during collaboration
|
|
49
|
-
| `onError` (optional) | `(errorString: string) => void` | Function to call on error
|
|
50
|
-
| `setCharacterCount` (optional) | `React.Dispatch<SetStateAction<number>>` | Optional. React Set State function to update Character Count
|
|
51
|
-
| `setWordCount` (optional) | `React.Dispatch<SetStateAction<number>>` | Optional. React Set State function to update Word Count
|
|
52
|
-
| `scrollPosition`(optional)
|
|
48
|
+
| `onCollaboratorChange` (optional) | `(collaborators?: IDocCollabUsers[] ) => void` | Optional function that gets triggered when a user join or leave the doc during collaboration |
|
|
49
|
+
| `onError` (optional) | `(errorString: string) => void` | Function to call on error |
|
|
50
|
+
| `setCharacterCount` (optional) | `React.Dispatch<SetStateAction<number>>` | Optional. React Set State function to update Character Count |
|
|
51
|
+
| `setWordCount` (optional) | `React.Dispatch<SetStateAction<number>>` | Optional. React Set State function to update Word Count |
|
|
52
|
+
| `scrollPosition`(optional) | `number` | User cursor position to scroll to on intitalising the content of the editor
|
|
53
|
+
| `enableIndexeddbSync` (optional) | `boolean` | Indicates when to use yjs-indexeddb provider
|
|
54
|
+
| `ddocId` (optional) | `string` | custom ID for the document (this has to be provided to enable yjs-indexeddb provider) |
|
|
53
55
|
| `editorCanvasClassNames`(optional) | `string` | Optional. Extra className for editor-canvas |
|
|
54
56
|
|
|
55
57
|
## Data Interface
|