@fileverse-dev/ddoc 1.5.1 → 1.5.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 +15 -13
- package/dist/index.es.js +3222 -3156
- package/dist/index.umd.js +29 -29
- package/dist/packages/ddoc/types.d.ts +7 -0
- package/dist/packages/ddoc/use-ddoc-editor.d.ts +1 -1
- package/package.json +1 -2
- package/dist/packages/ddoc/utils/buildUCANToken.d.ts +0 -2
package/README.md
CHANGED
|
@@ -28,19 +28,21 @@ The `DdocProps` interface is a TypeScript interface that defines the properties
|
|
|
28
28
|
|
|
29
29
|
## Properties
|
|
30
30
|
|
|
31
|
-
| Property | Type
|
|
32
|
-
| ---------------------------------------------- |
|
|
33
|
-
| `isPreviewMode` | `boolean`
|
|
34
|
-
| `handleImageUploadToIpfs`
|
|
35
|
-
| `data` (optional) | `Data`
|
|
36
|
-
| `enableCollaboration` (optional) | `boolean`
|
|
37
|
-
| `
|
|
38
|
-
| `
|
|
39
|
-
| `
|
|
40
|
-
| `
|
|
41
|
-
| `
|
|
42
|
-
| `
|
|
43
|
-
| `
|
|
31
|
+
| Property | Type | Description |
|
|
32
|
+
| ---------------------------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
|
|
33
|
+
| `isPreviewMode` | `boolean` | Indicates whether the page is in preview mode or not. |
|
|
34
|
+
| `handleImageUploadToIpfs` | `(file: File) => Promise<string>` | Required function to upload ddoc editor's image on IPFS |
|
|
35
|
+
| `data` (optional) | `Data` | Optional property holding data related to the page. |
|
|
36
|
+
| `enableCollaboration` (optional) | `boolean` | Optional property to enable collaboration |
|
|
37
|
+
| `onCommentInteraction` (optional) | `(commentInfo: IEditSelectionData) => void` | Optional function that get's called whenever there is a mouse-over and click interaction on a comment |
|
|
38
|
+
| `collaborationId` (optional) | `string` | When using enableCollaboration, you need to provide collaborationId, it can be uuid of doc |
|
|
39
|
+
| `onAutoSave` (optional) | `(flag:boolean) => void` | Function which expose the current editor state every 10 seconds |
|
|
40
|
+
| `onTextSelection` (optional) | `(data: IEditorSelectionData) => void` | Function called when a text is selected on the editor |
|
|
41
|
+
| `renderToolRightSection` (optional) | `({editor}) => JSX.Element` | Function that render the right section of the toolbar. it calls the function with the editor instance |
|
|
42
|
+
| `renderToolLeftSection` (optional) | `({editor}) => JSX.Element` | Accept a react component |
|
|
43
|
+
| `username` (required when using collaboration) | `boolean` | Takes a username which can be used by collaboration cursor |
|
|
44
|
+
| `walletAddress` (optional) | `string ` | Takes a wallet address |
|
|
45
|
+
| `ref` (optional) | `any` | Gets editor instance |
|
|
44
46
|
|
|
45
47
|
## Data Interface
|
|
46
48
|
|