@fileverse-dev/ddoc 4.8.17-xchacha.0 → 5.0.0-unstable-styles-2

package/README.md

@@ -27,17 +27,23 @@ This repository contains:
 
 ## Usage
 
-### Prequisites
+### Prerequisites
 
-To use dDocs, ensure your project is set up with Tailwind CSS and have a Tailwind configuration file.
+Your app runs Tailwind CSS 3.4 and owns the `@tailwind base/components/utilities` entry. The package ships only editor CSS; preflight, utilities, the `@fileverse/ui` styles, and the KaTeX stylesheet come from your build.
 
 ### Install & import
 
-Add the following imports :
-
 ```javascript
 import { DdocEditor } from '@fileverse-dev/ddoc';
-import '@fileverse-dev/ddoc/styles'; // in App.jsx/App.tsx
+```
+
+Load stylesheets in this order (Vite emits CSS in import order; in Next put the first two in the root layout and the last two in the editor route):
+
+```javascript
+import './globals.css';                 // your tailwind entry
+import '@fileverse/ui/styles/base';     // tokens and base rules
+import 'katex/dist/katex.min.css';      // math; fonts are served as files
+import '@fileverse-dev/ddoc/styles';    // editor CSS
 ```
 
 ### Peer Dependencies
@@ -53,19 +59,41 @@ npm install @dnd-kit/core @dnd-kit/sortable @dnd-kit/utilities @fileverse/ui @fi
 | `@dnd-kit/core`      | `>=6.3.1`   |
 | `@dnd-kit/sortable`  | `>=10.0.0`  |
 | `@dnd-kit/utilities` | `>=3.2.2`   |
-| `@fileverse/ui`      | `>=5.0.0`   |
+| `@fileverse/ui`      | `5.4.0`     |
 | `@fileverse/crypto`  | `>=0.0.21`  |
 | `viem`               | `>=2.13.8`  |
 | `framer-motion`      | `>=11.2.10` |
 | `frimousse`          | `>=0.3.0`   |
 
+During the `unstable-styles` prerelease, install `@fileverse/ui@5.4.0-unstable-styles-1` exactly; the stable release pairs with `5.4.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 :
+```javascript
+module.exports = {
+  presets: [require('@fileverse-dev/ddoc/tailwind')],
+  content: [
+    './src/**/*.{js,ts,jsx,tsx}',
+    './node_modules/@fileverse-dev/ddoc/dist/index.es.js',
+    './node_modules/@fileverse/ui/dist/index.es.js',
+  ],
+};
+```
+
+The preset composes `@fileverse/ui/tailwind` (class-based dark mode, animate plugin, design-system classes) and adds the `mobile: 960px` screen the editor uses.
+
+### Migrating from 4.x
+
+5.0 stops shipping preflight, Tailwind utilities, the ui stylesheet, the KaTeX stylesheet, and the `html`, `body`, and `*` resets. To upgrade:
 
-`@fileverse-dev/ddoc/dist/index.es.js`
+1. Add the preset and the two `content` entries above.
+2. Import `@fileverse/ui/styles/base` and `katex/dist/katex.min.css` yourself, in the order above.
+3. If your shell relied on `html, body { overflow: hidden }` or `body { user-select: none }` from the package, add them to your own global stylesheet.
+4. Remove any workaround that re-declared `mobile:` classes; the preset generates them.
+5. Add `katex` to your own dependencies (`npm install katex@^0.16.11`); the package no longer guarantees it is hoisted.
+6. If you styled anything from the old bundle by class name: `.custom-scrollbar` is now `.ddoc-scrollbar`, and `.highlight-comment-bg`, `.is-active`, `.custom-border-bg`, `.animate-fade-in-out`, `.placeholder-disabled` were removed as unused.
 
 You should now be set to use dDocs!
 

package/dist/headless-editor-utils.es.js

@@ -1,4 +1,4 @@
-import { c8 as s } from "./use-headless-editor-LqOgnUoI.mjs";
+import { c8 as s } from "./use-headless-editor-C3wFDi0t.mjs";
 const n = (e) => {
   const { getYjsConvertor: t, mergeYjsUpdates: r } = s(e);
   return { getYjsConvertor: t, mergeYjsUpdates: r };

package/dist/{index-BXcU4L-P.mjs → index-CVwMVBPt.mjs}

@@ -1,4 +1,4 @@
-import { c9 as Ql, ca as Zl, cb as eh } from "./use-headless-editor-LqOgnUoI.mjs";
+import { c9 as Ql, ca as Zl, cb as eh } from "./use-headless-editor-C3wFDi0t.mjs";
 let An = [], Xr = [];
 (() => {
   let s = "lc,34,7n,7,7b,19,,,,2,,2,,,20,b,1c,l,g,,2t,7,2,6,2,2,,4,z,,u,r,2j,b,1m,9,9,,o,4,,9,,3,,5,17,3,3b,f,,w,1j,,,,4,8,4,,3,7,a,2,t,,1m,,,,2,4,8,,9,,a,2,q,,2,2,1l,,4,2,4,2,2,3,3,,u,2,3,,b,2,1l,,4,5,,2,4,,k,2,m,6,,,1m,,,2,,4,8,,7,3,a,2,u,,1n,,,,c,,9,,14,,3,,1l,3,5,3,,4,7,2,b,2,t,,1m,,2,,2,,3,,5,2,7,2,b,2,s,2,1l,2,,,2,4,8,,9,,a,2,t,,20,,4,,2,3,,,8,,29,,2,7,c,8,2q,,2,9,b,6,22,2,r,,,,,,1j,e,,5,,2,5,b,,10,9,,2u,4,,6,,2,2,2,p,2,4,3,g,4,d,,2,2,6,,f,,jj,3,qa,3,t,3,t,2,u,2,1s,2,,7,8,,2,b,9,,19,3,3b,2,y,,3a,3,4,2,9,,6,3,63,2,2,,1m,,,7,,,,,2,8,6,a,2,,1c,h,1r,4,1c,7,,,5,,14,9,c,2,w,4,2,2,,3,1k,,,2,3,,,3,1m,8,2,2,48,3,,d,,7,4,,6,,3,2,5i,1m,,5,ek,,5f,x,2da,3,3x,,2o,w,fe,6,2x,2,n9w,4,,a,w,2,28,2,7k,,3,,4,,p,2,5,,47,2,q,i,d,,12,8,p,b,1a,3,1c,,2,4,2,2,13,,1v,6,2,2,2,2,c,,8,,1b,,1f,,,3,2,2,5,2,,,16,2,8,,6m,,2,,4,,fn4,,kh,g,g,g,a6,2,gt,,6a,,45,5,1ae,3,,2,5,4,14,3,4,,4l,2,fx,4,ar,2,49,b,4w,,1i,f,1k,3,1d,4,2,2,1x,3,10,5,,8,1q,,c,2,1g,9,a,4,2,,2n,3,2,,,2,6,,4g,,3,8,l,2,1l,2,,,,,m,,e,7,3,5,5f,8,2,3,,,n,,29,,2,6,,,2,,,2,,2,6j,,2,4,6,2,,2,r,2,2d,8,2,,,2,2y,,,,2,6,,,2t,3,2,4,,5,77,9,,2,6t,,a,2,,,4,,40,4,2,2,4,,w,a,14,6,2,4,8,,9,6,2,3,1a,d,,2,ba,7,,6,,,2a,m,2,7,,2,,2,3e,6,3,,,2,,7,,,20,2,3,,,,9n,2,f0b,5,1n,7,t4,,1r,4,29,,f5k,2,43q,,,3,4,5,8,8,2,7,u,4,44,3,1iz,1j,4,1e,8,,e,,m,5,,f,11s,7,,h,2,7,,2,,5,79,7,c5,4,15s,7,31,7,240,5,gx7k,2o,3k,6o".split(",").map((e) => e ? parseInt(e, 36) : 1);

package/dist/index.d.ts

@@ -15,9 +15,8 @@ export { buildVersionDiffSnapshot } from './package/components/tabs/utils/versio
 export type { DdocExportModalProps, ExportFormatOption, ExportTabOption, } from './package/components/export-modal';
 export type { VersionTabSnapshot } from './package/components/tabs/utils/version-diff-snapshot';
 export { Editor } from '@tiptap/react';
-export type { CollaborationProps, CollabConnectionConfig, CollabSessionMeta, CollabServices, CollabCallbacks, CollabState, CollabError, CollabErrorCode, CollabStatus, WireFormat, WireTelemetryEvent, } from './package/sync-local/types';
+export type { CollaborationProps, CollabConnectionConfig, CollabSessionMeta, CollabServices, CollabCallbacks, CollabState, CollabError, CollabErrorCode, CollabStatus, } from './package/sync-local/types';
 export { encryptForRoomKey, decryptForRoomKey, } from './package/sync-local/crypto/room-key';
-export { WIRE_TAG, isXChaChaCipher } from './package/sync-local/crypto';
 export { fetchSessionState, seedSession, } from './package/sync-local/session-tools';
 export type { CommentMutationMeta, SuggestionType } from './package/types';
 export type { IComment } from './package/extensions/comment/comment.ts';