@fileverse-dev/ddoc NPM

Ddoc Editor

ddocs.new is your onchain, privacy-first alternative to G*gle Dcs: peer-to-peer, end-to-end encrypted, and decentralized. It enables secure, real-time, and async collaboration without compromising user privacy.

This repository contains:

/package – The core package code.
Example & demo source code to showcase dDocs functionalities.

Usage

Prequisites

To use dDocs, ensure your project is set up with Tailwind CSS and have a Tailwind configuration file.

Install & import

Add the following imports :

import { DdocEditor } from '@fileverse-dev/ddoc';
import '@fileverse-dev/ddoc/styles'; // in App.jsx/App.tsx

Update Tailwind Config

In your tailwind config, add this line to content array :

@fileverse-dev/ddoc/dist/index.es.js

You should now be set to use dDocs!

dDocProps Interface

The DdocProps interface is a TypeScript interface that defines the properties for a page-related component. It includes properties for handling preview mode, managing publishing data, and optionally storing metadata and content associated with the page.

Core Props

Property	Type	Description
`initialContent`	`JSONContent`	Initial content of the editor
`onChange`	`(changes: JSONContent, chunk?: any) => void`	Callback triggered on editor content changes
`ref`	`React.RefObject`	Reference to access editor instance
`isPreviewMode`	`boolean`	Controls if editor is in preview/read-only mode
`editorCanvasClassNames`	`string`	Additional CSS classes for editor canvas
`ignoreCorruptedData`	`boolean`	Whether to ignore corrupted data during loading
`onInvalidContentError`	`(error: any) => void`	Callback for handling invalid content errors

Collaboration Props

Property	Type	Description
`enableCollaboration`	`boolean`	Enables real-time collaboration features
`collaborationId`	`string`	Unique ID for collaboration session (required when collaboration enabled)
`username`	`string`	User's display name for collaboration
`setUsername`	`(username: string) => void`	Function to update username
`walletAddress`	`string`	User's wallet address
`onCollaboratorChange`	`(collaborators?: IDocCollabUsers[]) => void`	Callback when collaborators change
`enableIndexeddbSync`	`boolean`	Enables IndexedDB sync for offline support
`ddocId`	`string`	Unique document ID (required for IndexedDB sync)

UI/UX Props

Property	Type	Description
`zoomLevel`	`string`	Current zoom level of the editor
`setZoomLevel`	`React.Dispatch<SetStateAction<string>>`	Function to update zoom level
`isNavbarVisible`	`boolean`	Controls navbar visibility
`setIsNavbarVisible`	`React.Dispatch<SetStateAction<boolean>>`	Function to toggle navbar visibility
`renderNavbar`	`() => JSX.Element`	Custom navbar renderer
`renderThemeToggle`	`() => JSX.Element`	Custom theme toggle renderer
`isPresentationMode`	`boolean`	Controls presentation mode
`setIsPresentationMode`	`React.Dispatch<SetStateAction<boolean>>`	Function to toggle presentation mode
`sharedSlidesLink`	`string`	Link for shared presentation slides

Comments & Collaboration Props

Property	Type	Description
`initialComments`	`IComment[]`	Initial comments to display
`setInitialComments`	`(comments: IComment[]) => void`	Function to update comments
`onCommentReply`	`(id: string, reply: IComment) => void`	Callback for comment replies
`onNewComment`	`(comment: IComment) => void`	Callback for new comments
`commentDrawerOpen`	`boolean`	Controls comment drawer visibility
`setCommentDrawerOpen`	`(isOpen: boolean) => void`	Function to toggle comment drawer
`onResolveComment`	`(commentId: string) => void`	Callback when resolving comments
`onUnresolveComment`	`(commentId: string) => void`	Callback when unresolving comments
`onDeleteComment`	`(commentId: string) => void`	Callback when deleting comments
`disableInlineComment`	`boolean`	Disables inline commenting feature

Authentication Props

Property	Type	Description
`isConnected`	`boolean`	User connection status
`isLoading`	`boolean`	Authentication loading state
`connectViaUsername`	`(username: string) => Promise<void>`	Username-based authentication
`connectViaWallet`	`() => Promise<void>`	Wallet-based authentication
`isDDocOwner`	`boolean`	Indicates if user owns the document

Utility Props

Property	Type	Description
`setCharacterCount`	`React.Dispatch<SetStateAction<number>>`	Updates character count
`setWordCount`	`React.Dispatch<SetStateAction<number>>`	Updates word count
`ensResolutionUrl`	`string`	URL for ENS name resolution
`secureImageUploadUrl`	`string`	URL for secure image uploads
`onError`	`(error: string) => void`	General error handler
`onInlineComment`	`() => void`	Callback for inline comments
`onMarkdownExport`	`() => void`	Callback for markdown export
`onMarkdownImport`	`() => void`	Callback for markdown import
`onPdfExport`	`() => void`	Callback for pdf export
`onSlidesShare`	`() => void`	Callback for slides sharing
`onComment`	`() => void`	General comment callback

Pro Features

Property	Type	Description
`showTOC`	`boolean`	Controls table of contents visibility
`setShowTOC`	`React.Dispatch<SetStateAction<boolean>>`	Function to toggle TOC
`proExtensions`	`{ TableOfContents: any, [key: string]: any }`	Pro feature extensions

AI Writer Props

Property	Type	Description
`activeModel`	`CustomModel`	Currently selected AI model for text generation
`maxTokens`	`number`	Maximum token limit for AI-generated content
`isAIAgentEnabled`	`boolean`	Toggle for AI agent functionality

Steps to run this example locally

npm i
npm run dev

It will open up a vite server, that will have the Ddoc Editor.

⚠️ This repository is currently undergoing rapid development, with frequent updates and changes. We recommend not to use in production yet.

Pro Extensions Setup

Configure your .npmrc with the appropriate registry and authentication token:
Install the corresponding extension packages:
Use the extension in your DdocEditor component:

proExtensions={{
  TableOfContents
}}

@_ueberdosis/prosemirror-tables @aarkue/tiptap-math-extension @fileverse-dev/md2slides @fileverse/ui @radix-ui/react-focus-scope @radix-ui/react-popover @tippyjs/react @tiptap/core @tiptap/extension-bullet-list @tiptap/extension-character-count @tiptap/extension-code-block-lowlight @tiptap/extension-collaboration @tiptap/extension-collaboration-cursor @tiptap/extension-color @tiptap/extension-document @tiptap/extension-dropcursor @tiptap/extension-font-family @tiptap/extension-gapcursor @tiptap/extension-highlight @tiptap/extension-link @tiptap/extension-list-item @tiptap/extension-placeholder @tiptap/extension-subscript @tiptap/extension-superscript @tiptap/extension-task-item @tiptap/extension-task-list @tiptap/extension-text-align @tiptap/extension-text-style @tiptap/extension-typography @tiptap/extension-underline @tiptap/pm @tiptap/react @tiptap/starter-kit @tiptap/suggestion base64-js classnames copy-to-clipboard date-fns dompurify embla-carousel-react emojibase-data framer-motion highlight.js js-base64 katex lowlight markdown-it-footnote ollama platform prosemirror-model prosemirror-state react react-dom react-tweet react-uuid tailwindcss-animate tippy.js tiptap-markdown turndown usehooks-ts vaul viem vite-plugin-dts y-indexeddb y-prosemirror y-webrtc yjs

7 months ago

5 months ago

7 months ago

8 months ago

8 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

5 months ago

2.1.9-list-fix-patch-1

7 months ago

5 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

6 months ago

7 months ago

6 months ago

2.1.9-headingLinks-patch-1

7 months ago

2.2.2

6 months ago

2.2.5

6 months ago

2.1.9-headingLinks-patch-3

7 months ago

2.2.4

6 months ago

2.1.9-headingLinks-patch-2

7 months ago

2.2.7

6 months ago

2.1.9-headingLinks-patch-5

7 months ago

2.2.6

6 months ago

2.1.9-headingLinks-patch-4

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

9 months ago

10 months ago

8 months ago

9 months ago

7 months ago

7 months ago

7 months ago

7 months ago

6 months ago

11 months ago

5 months ago

2.1.7-collapse-heading-patch-2

7 months ago

2.1.7-collapse-heading-patch-3

7 months ago

2.2.9

5 months ago

2.1.5-patch-1

7 months ago

2.2.8

6 months ago

2.2.5-fixSlides-patch-2

6 months ago

2.2.5-fixSlides-patch-1

6 months ago

2.1.5-patch-2

7 months ago

2.1.4-patch-9.1

7 months ago

2.1.4-patch-9.2

7 months ago

2.2.2-optimize-patch-1

6 months ago

2.1.3-patch-29.3

8 months ago

2.1.3-patch-15

9 months ago

2.1.3-patch-16

9 months ago

2.1.7-soucemaps-patch-1

7 months ago

9 months ago

10 months ago

9 months ago

10 months ago

9 months ago

10 months ago

9 months ago

10 months ago

8 months ago

9 months ago

8 months ago

9 months ago

9 months ago

9 months ago

8 months ago

11 months ago

8 months ago

11 months ago

8 months ago

11 months ago

8 months ago

11 months ago

9 months ago

10 months ago

12 months ago

9 months ago

11 months ago

12 months ago

9 months ago

9 months ago

10 months ago

12 months ago

9 months ago

6 months ago

9 months ago

9 months ago

9 months ago

11 months ago

11 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

11 months ago

11 months ago

12 months ago

12 months ago

11 months ago

11 months ago

2.1.7-text-color-fix-patch-1

7 months ago

8 months ago

8 months ago

8 months ago

8 months ago

8 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

2.2.9-disabled-reminder-1

5 months ago

7 months ago

7 months ago

7 months ago

6 months ago

7 months ago

11 months ago

7 months ago

11 months ago

7 months ago

11 months ago

11 months ago

6 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

9 months ago

2.1.7-linkPreview-patch-1

7 months ago

9 months ago

6 months ago

6 months ago

6 months ago

6 months ago

10 months ago

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

5 months ago

5 months ago

12 months ago

12 months ago

10 months ago

12 months ago

5 months ago

10 months ago

10 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

5 months ago

10 months ago

12 months ago

12 months ago

12 months ago

6 months ago

6 months ago

11 months ago

6 months ago

11 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

9 months ago

9 months ago

9 months ago

2.2.9-update-image-arch-3

5 months ago

2.2.9-update-image-arch-1

5 months ago

2.2.9-update-image-arch-2

5 months ago

2.2.2-patch-tec-235.1

6 months ago

2.2.1-alpha-10

6 months ago

2.2.2-patch-tec-235.2

6 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

6 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

11 months ago

6 months ago

6 months ago

6 months ago

6 months ago

9 months ago

9 months ago

9 months ago

5 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

6 months ago

11 months ago

12 months ago

7 months ago

5 months ago

5 months ago

5 months ago

11 months ago

11 months ago

5 months ago

5 months ago

5 months ago

5 months ago

2.2.8-testInfra-patch-1

6 months ago

2.2.8-byom-11

5 months ago

2.2.8-byom-10

6 months ago

2.2.8-grammarlySupport-patch-1

6 months ago

2.1.1-ws-patch-1

9 months ago

2.1.5-collapse-heading-patch-1

7 months ago

11 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

2.2.0-headingFix-patch-1

7 months ago

2.2.0-scrollbarFix-patch-1

7 months ago

2.2.0-scrollbarFix-patch-2

7 months ago

2.2.0-scrollbarFix-patch-3

7 months ago

2.2.0-scrollbarFix-patch-4

7 months ago

12 months ago

12 months ago

5 months ago

5 months ago

8 months ago

1 year ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago