Fileverse dDocs
ddocs.new is your privacy-focused, open-source alternative to Google Docs. It is an end-to-end encrypted document editor that is optimized for multiplayer collaboration without compromising on speed or people's control over their data.
𓆏 Features include:
- End-to-end encryption
- Real-time and async collaboration
- Suggestion mode (tracked changes) and commenting
- Markdown and LaTeX support
- MermaidJS diagram support
- Import/export of .docx, .md, .pdf, .html and more.
- Dark mode and color themes
- Offline/online editing (continue writing and opening older docs even with no WiFi)
- Cross-device syncing (desktop and mobile)
- Mobile optimized webapp & PWA
- Private access permissions enabled through zero-knowledge proofs
- Private social recovery of account/files, enabled through zero-knowledge proofs
- Version history
- End-to-end encrypted, programmable API optimised for agents (opt-in)
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
Peer Dependencies
This package requires the following peer dependencies to be installed in your project:
npm install @dnd-kit/core @dnd-kit/sortable @dnd-kit/utilities @fileverse/ui @fileverse/crypto viem framer-motion frimousse
| Package | Version |
|---|---|
@dnd-kit/core |
>=6.3.1 |
@dnd-kit/sortable |
>=10.0.0 |
@dnd-kit/utilities |
>=3.2.2 |
@fileverse/ui |
>=5.0.0 |
@fileverse/crypto |
>=0.0.21 |
viem |
>=2.13.8 |
framer-motion |
>=11.2.10 |
frimousse |
>=0.3.0 |
These are externalized from the bundle to avoid duplication when your app already uses them. If you don't have them installed, npm (v7+) will auto-install them for you.
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> |
Function to update zoom level |
isNavbarVisible |
boolean |
Controls navbar visibility |
setIsNavbarVisible |
React.Dispatch> |
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> |
Function to toggle presentation mode |
sharedSlidesLink |
string |
Link for shared presentation slides |
documentStyling |
DocumentStyling |
Custom styling for document appearance |
fonts |
FontDescriptor[] |
Consumer-provided font catalog (see Custom Fonts) |
Document Styling
The documentStyling prop allows you to customize the visual appearance of your document with three distinct styling areas:
interface ThemeVariantValue {
light: string;
dark: string;
}
interface DocumentStyling {
/**
* Background styling for the outer document area.
* Supports CSS background values including gradients.
* Example: "linear-gradient(135deg, #667eea 0%, #764ba2 100%)"
*/
background?: string | ThemeVariantValue;
/**
* Background color for the editor canvas/content area.
* Should be a solid color value.
* Example: "#ffffff" or "rgb(255, 255, 255)"
*/
canvasBackground?: string | ThemeVariantValue;
/**
* Text color for the editor content.
* Example: "#333333" or "rgb(51, 51, 51)"
*/
textColor?: string | ThemeVariantValue;
/**
* Font family for the editor content.
* Example: "Inter, sans-serif" or "'Times New Roman', serif"
*/
fontFamily?: string;
}
Usage Example
<DdocEditor
documentStyling={{
background: {
light: 'linear-gradient(135deg, #667eea 0%, #764ba2 100%)',
dark: 'linear-gradient(135deg, #2a3145 0%, #3a2f59 100%)',
},
canvasBackground: { light: '#ffffff', dark: '#1e1f22' },
textColor: { light: '#333333', dark: '#e8ebec' },
fontFamily: 'Inter, sans-serif',
}}
// ... other props
/>
Note: Document styling works in both regular editor mode and presentation mode. In presentation mode, only canvasBackground, textColor, and fontFamily are applied to maintain clean slide appearance.
Custom Fonts
The editor ships with a system-font baseline only (Arial, Calibri, Georgia, Times New Roman, etc.) and makes no third-party font requests — there is no Google Fonts @import. To offer additional fonts, pass a fonts catalog. Each font is self-hosted by your app and loaded on demand via the CSS Font Loading API: a font's woff2 is fetched only when it's selected in the picker or when a document (including a