documint 0.0.5 → 0.0.7

package/README.md

@@ -8,12 +8,12 @@ A canvas-based, batteries-included markdown editor for React.
 
 - **Markdown in, markdown out** — Documents are parsed from markdown and serialized back to markdown. Full support for CommonMark, GFM tables, task lists, strikethrough, and fenced code blocks with language hints.
 
+- **Rich semantic editing** — Context-sensitive behavior that adapts to what you're editing. Enter splits a paragraph but adds a new row in a table. Backspace at the start of a list item dedents it. Tab indents a list but inserts a column in a table. The editor understands the structure of your document, so every gesture does the right thing.
+
 - **Subtle, delightful animations** — A typing trail highlights newly inserted text. Deleted text fades out before disappearing. List markers pop into place. Punctuation pulses with a soft ring on keystroke. Small details that make editing feel fun.
 
 - **Mobile-native editing** — Responsive layout with full support for iOS and Android gestures: auto-capitalization, auto-correct, auto-scroll on keyboard appearance, shake-to-undo, and selection handles all work as expected.
 
-- **Rich semantic editing** — Context-sensitive behavior that adapts to what you're editing. Enter splits a paragraph but adds a new row in a table. Backspace at the start of a list item dedents it. Tab indents a list but inserts a column in a table. The editor understands the structure of your document, so every gesture does the right thing.
-
 - **Context-aware toolbars ("leaves")** — Floating toolbars that appear based on what you're interacting with: text formatting options on selection, link editing on links, column/row controls on tables, and block insertion (headings, lists, quotes, tables) on empty lines.
 
 - **Configurable themes and keybindings** — Ships with built-in light and dark themes, follows the system theme by default, and lets you customize every theme value or start from presets like mint, midnight, and sunrise. Keybindings are configurable too — remap formatting shortcuts, navigation, and list operations to match your users' expectations.

package/dist/index.d.ts

@@ -106,7 +106,11 @@ export type Anchor = {
 	prefix?: string;
 	suffix?: string;
 };
-type EditorCommand = "dedent" | "deleteBackward" | "indent" | "insertLineBreak" | "moveListItemDown" | "moveListItemUp" | "moveToDocumentEnd" | "moveToDocumentStart" | "moveToLineEnd" | "moveToLineStart" | "redo" | "selectAll" | "toggleBold" | "toggleInlineCode" | "toggleItalic" | "toggleStrikethrough" | "toggleUnderline" | "undo";
+export type DocumintStorage = {
+	readFile(path: string): Promise<Blob | null>;
+	writeFile(file: File): Promise<string>;
+};
+type EditorCommand = "dedent" | "deleteBackward" | "indent" | "insertLineBreak" | "moveListItemDown" | "moveListItemUp" | "moveToDocumentEnd" | "moveToDocumentStart" | "moveToLineEnd" | "moveToLineStart" | "redo" | "selectAll" | "toggleBold" | "toggleCode" | "toggleItalic" | "toggleStrikethrough" | "toggleUnderline" | "undo";
 export type EditorTheme = {
 	activeBlockBackground: string;
 	activeBlockFlash: string;
@@ -199,12 +203,13 @@ export type DocumintProps = {
 	theme?: DocumintTheme;
 	keybindings?: EditorKeybinding[];
 	presence?: DocumentPresence[];
+	storage?: DocumintStorage;
 	users?: DocumentUser[];
 	onContentChanged?: (content: string, document: Document$1) => void;
 	onStateChanged?: (state: DocumintState) => void;
-	onCommentChanged?: (event: CommentChangedEvent) => void;
+	onCommentChanged?: (change: CommentChange) => void;
 };
-export type CommentChangedEvent = {
+export type CommentChange = {
 	kind: "added";
 	comment: Comment$1;
 	mentionedUserIds: string[];
@@ -239,7 +244,7 @@ export type DocumintState = {
 	selectionFrom: number;
 	selectionTo: number;
 };
-export declare function Documint({ className, content, keybindings, onCommentChanged, onContentChanged, onStateChanged, presence, theme, users, }: DocumintProps): import("react/jsx-runtime").JSX.Element;
+export declare function Documint({ className, content, keybindings, onCommentChanged, onContentChanged, onStateChanged, presence, storage, theme, users, }: DocumintProps): import("react/jsx-runtime").JSX.Element;
 export declare const lightTheme: EditorTheme;
 export declare const darkTheme: EditorTheme;
 export declare const mintTheme: EditorTheme;