@fileverse-dev/ddoc 1.0.2 → 1.0.4
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 +4 -14
- package/dist/index.es.js +26425 -15889
- package/dist/index.umd.js +89 -86
- package/dist/packages/ddoc/{editor-utils.d.ts → components/editor-utils.d.ts} +1 -1
- package/dist/packages/ddoc/ddoc-editor.d.ts +2 -2
- package/dist/packages/ddoc/extensions/default-extension.d.ts +1 -1
- package/dist/packages/ddoc/navbar/navbar.d.ts +3 -2
- package/dist/packages/ddoc/{props.d.ts → types.d.ts} +5 -8
- package/dist/packages/ddoc/use-ddoc-editor.d.ts +9 -0
- package/dist/style.css +1 -1
- package/package.json +7 -2
- /package/dist/packages/ddoc/{color-selector.d.ts → components/color-selector.d.ts} +0 -0
- /package/dist/packages/ddoc/{editor-bubble-menu.d.ts → components/editor-bubble-menu.d.ts} +0 -0
- /package/dist/packages/ddoc/{editor-toolbar.d.ts → components/editor-toolbar.d.ts} +0 -0
- /package/dist/packages/ddoc/{node-selector.d.ts → components/node-selector.d.ts} +0 -0
- /package/dist/packages/ddoc/{slash-comand.d.ts → components/slash-comand.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -34,6 +34,9 @@ The `DdocProps` interface is a TypeScript interface that defines the properties
|
|
|
34
34
|
| `togglePreviewMode`| `(flag: boolean) => void` | Function to toggle preview mode with a boolean flag. |
|
|
35
35
|
| `onPublish` | `(data: Data) => void` | Function to handle publishing of the page. |
|
|
36
36
|
| `data` (optional) | `Data` | Optional property holding data related to the page. |
|
|
37
|
+
| `enableCollaboration` (optional) | `boolean` | Optional property to enable collaboration
|
|
38
|
+
| `collaborationId` (optional) | `string` | When using enableCollaboration, you need to provide collaborationId, it can be uuid of doc |
|
|
39
|
+
| `toggleCollaboration` (optional) | `(flag: boolean) => void` | Function to toggle collaboration mode with a boolean flag |
|
|
37
40
|
|
|
38
41
|
## Data Interface
|
|
39
42
|
|
|
@@ -53,22 +56,9 @@ The `PluginMetaData` interface defines the structure of the metadata related to
|
|
|
53
56
|
### Properties
|
|
54
57
|
|
|
55
58
|
| Property | Type | Description |
|
|
56
|
-
|
|
57
|
-
| `cover` | `Cover` | Contains information about the cover. |
|
|
59
|
+
|-------------------|-------------|-------------------------------------------------- |
|
|
58
60
|
| `plugin` | `Plugin` | Contains information about the plugin title. |
|
|
59
61
|
|
|
60
|
-
## Cover Interface
|
|
61
|
-
|
|
62
|
-
The `Cover` interface defines the structure of the cover information.
|
|
63
|
-
|
|
64
|
-
### Properties
|
|
65
|
-
|
|
66
|
-
| Property | Type | Description |
|
|
67
|
-
|------------|------------------|-------------------------------------------------------|
|
|
68
|
-
| `image` | `string \| null` | URL of the cover image (can be `null`). |
|
|
69
|
-
| `emoji` | `string \| null` | Emoji associated with the cover (can be `null`). |
|
|
70
|
-
| `name` | `string \| null` | Name of the cover (can be `null`). |
|
|
71
|
-
|
|
72
62
|
## Plugin Interface
|
|
73
63
|
|
|
74
64
|
The `Plugin` interface defines the structure of the plugin information.
|