@overlap/rte 0.1.8 → 0.1.9

package/dist/components/Editor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Editor.d.ts","sourceRoot":"","sources":["../../src/components/Editor.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAkD,MAAM,OAAO,CAAC;AASvE,OAAO,EAA4B,WAAW,EAAE,MAAM,UAAU,CAAC;AAwBjE,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAukBxC,CAAC"}
+{"version":3,"file":"Editor.d.ts","sourceRoot":"","sources":["../../src/components/Editor.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAkD,MAAM,OAAO,CAAC;AAUvE,OAAO,EAA4B,WAAW,EAAE,MAAM,UAAU,CAAC;AAwBjE,eAAO,MAAM,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,WAAW,CAilBxC,CAAC"}

package/dist/index.d.ts

@@ -17,6 +17,107 @@ interface DropdownProps {
 }
 declare const Dropdown: React$1.FC<DropdownProps>;
 
+/**
+ * Describes an additional field injected into the link dialog.
+ * This allows platform-specific extensions (e.g. page reference, URL extras)
+ * without baking them into the core RTE.
+ */
+interface LinkCustomField {
+    /** Unique identifier (used as key in LinkData.custom) */
+    key: string;
+    /** Display label */
+    label: string;
+    /** Input placeholder */
+    placeholder?: string;
+    /** The HTML attribute to read/write on the <a> element (e.g. "data-page-ref") */
+    dataAttribute: string;
+    /** If true, this field's value is appended to the href when saving. */
+    appendToHref?: boolean;
+    /** If true, the URL input is disabled when this field has a value. */
+    disablesUrl?: boolean;
+}
+interface AdvancedLinkOptions {
+    /** Show "Open in new tab" checkbox. Defaults to true. */
+    enableTarget?: boolean;
+    /** Additional custom fields rendered in the advanced section. */
+    customFields?: LinkCustomField[];
+}
+/**
+ * Creates an advanced link plugin with a floating dialog.
+ *
+ * Core features (always available):
+ * - URL input
+ * - "Open in new tab" checkbox (enableTarget)
+ * - Cmd/Ctrl+Click → open link in new tab
+ * - Click on link → edit it inline
+ *
+ * Platform-specific fields (injected via `customFields`):
+ * - Each field is rendered in the "Advanced" section
+ * - Values are stored as data-attributes on the <a> element
+ * - `appendToHref` fields have their value appended to the href
+ * - `disablesUrl` fields disable the URL input when they have a value
+ */
+declare function createAdvancedLinkPlugin(options?: AdvancedLinkOptions): Plugin;
+/** Pre-built link plugin with just target enabled (no custom fields). */
+declare const advancedLinkPlugin: Plugin;
+
+interface EditorSettings {
+    format?: {
+        bold?: boolean;
+        italic?: boolean;
+        underline?: boolean;
+        strikethrough?: boolean;
+        code?: boolean;
+        subscript?: boolean;
+        superscript?: boolean;
+        bulletList?: boolean;
+        numberedList?: boolean;
+        quote?: boolean;
+        codeBlock?: boolean;
+        check?: boolean;
+        /** Heading levels to enable, e.g. ["h1", "h2", "h3"] */
+        typography?: string[];
+        /** Color palette for text color, e.g. ["#000", "#ff0000"] */
+        colors?: string[];
+        /** Enable font size dropdown */
+        fontSize?: boolean;
+        /** Alignment options, e.g. ["left", "center", "right", "justify", "indent", "outdent"] */
+        alignment?: string[];
+    };
+    link?: {
+        external?: boolean;
+        internal?: boolean;
+    };
+    table?: {
+        enabled?: boolean;
+    };
+    image?: {
+        enabled?: boolean;
+    };
+}
+/** Default: everything enabled. */
+declare const defaultEditorSettings: EditorSettings;
+interface BuildPluginsOptions {
+    /** Callback for image uploads (required when image.enabled is true). */
+    onImageUpload?: (file: File) => Promise<string>;
+    /** Custom fields for the advanced link dialog (e.g. urlExtra, pageRef). */
+    linkCustomFields?: LinkCustomField[];
+    /** Custom font sizes for the font size dropdown. */
+    fontSizes?: number[];
+}
+/**
+ * Builds a Plugin[] array from an EditorSettings object.
+ *
+ * Usage:
+ * ```ts
+ * const plugins = buildPluginsFromSettings(settings, {
+ *   onImageUpload: handleUpload,
+ *   linkCustomFields: [{ key: 'urlExtra', ... }],
+ * });
+ * ```
+ */
+declare function buildPluginsFromSettings(settings?: EditorSettings, options?: BuildPluginsOptions): Plugin[];
+
 interface EditorNode {
     type: string;
     children?: EditorNode[];
@@ -98,6 +199,8 @@ interface EditorProps {
         primaryColor?: string;
     };
     onImageUpload?: (file: File) => Promise<string>;
+    settings?: EditorSettings;
+    settingsOptions?: BuildPluginsOptions;
 }
 
 declare const Editor: React$1.FC<EditorProps>;
@@ -110,7 +213,7 @@ interface ToolbarProps {
 declare const Toolbar: React$1.FC<ToolbarProps>;
 
 /**
- * Standard-Plugins
+ * Standard Plugins
  */
 declare const boldPlugin: Plugin;
 declare const italicPlugin: Plugin;
@@ -122,24 +225,32 @@ declare const codeInlinePlugin: Plugin;
 declare const undoPlugin: Plugin;
 declare const redoPlugin: Plugin;
 /**
- * Indent List Item Plugin (Tab für Unterliste)
+ * Indent List Item Plugin
  */
 declare const indentListItemPlugin: Plugin;
 /**
- * Outdent List Item Plugin (Shift+Tab)
+ * Outdent List Item Plugin
  */
 declare const outdentListItemPlugin: Plugin;
 
 declare const defaultPlugins: Plugin[];
 
+interface BlockFormatOptions {
+    bulletList?: boolean;
+    numberedList?: boolean;
+    quote?: boolean;
+    codeBlock?: boolean;
+    check?: boolean;
+}
 /**
  * Creates a Block Format plugin that combines headings, lists, and quote in a dropdown.
  * @param headings - Array of heading levels (e.g. ["h1", "h2", "h3"])
+ * @param blockOptions - Toggle individual block types (bulletList, numberedList, quote, check, codeBlock)
  */
-declare function createBlockFormatPlugin(headings?: string[]): Plugin;
+declare function createBlockFormatPlugin(headings?: string[], blockOptions?: BlockFormatOptions): Plugin;
 
 /**
- * Clear Formatting Plugin - Entfernt alle Formatierungen
+ * Clear Formatting Plugin - Removes all formatting
  */
 declare const clearFormattingPlugin: Plugin;
 
@@ -156,7 +267,7 @@ declare function createHeadingsPlugin(headings?: string[]): Plugin;
 declare function createImagePlugin(onImageUpload?: (file: File) => Promise<string>): Plugin;
 
 /**
- * Link-Plugin mit verbesserter Funktionalität
+ * Link plugin with improved functionality
  */
 declare function createLinkPlugin(): Plugin;
 declare const linkPlugin: Plugin;
@@ -186,21 +297,6 @@ declare const TableContextMenuProvider: React$1.FC<{
     children: React$1.ReactNode;
 }>;
 
-interface AdvancedLinkOptions {
-    enablePageRef?: boolean;
-    enableTarget?: boolean;
-    enableRel?: boolean;
-    enableTitle?: boolean;
-    enableUrlExtra?: boolean;
-}
-/**
- * Creates an advanced link plugin with a floating dialog.
- * Supports URL, target, rel, title, page reference, and URL extra.
- */
-declare function createAdvancedLinkPlugin(options?: AdvancedLinkOptions): Plugin;
-/** Pre-built advanced link plugin with target + rel + title enabled */
-declare const advancedLinkPlugin: Plugin;
-
 /**
  * Converts a DOM element (editor root) to EditorContent JSON.
  * Supports own format, Lexical HTML, and GitHub HTML.
@@ -242,11 +338,11 @@ declare class HistoryManager {
 }
 
 /**
- * Erhöht den Einrückungs-Level eines List-Items (Tab)
+ * Increases the indent level of a list item (Tab)
  */
 declare function indentListItem(selection: Selection): boolean;
 /**
- * Reduziert den Einrückungs-Level eines List-Items (Shift+Tab)
+ * Decreases the indent level of a list item (Shift+Tab)
  */
 declare function outdentListItem(selection: Selection): boolean;
 
@@ -255,15 +351,15 @@ declare function outdentListItem(selection: Selection): boolean;
  */
 declare function getCurrentFontSize(editor: EditorAPI): string | undefined;
 /**
- * Liest die aktuelle Textfarbe aus dem DOM an der Cursor-Position
+ * Reads the current text color from the DOM at the cursor position
  */
 declare function getCurrentTextColor(editor: EditorAPI): string | undefined;
 /**
- * Liest die aktuelle Hintergrundfarbe aus dem DOM an der Cursor-Position
+ * Reads the current background color from the DOM at the cursor position
  */
 declare function getCurrentBackgroundColor(editor: EditorAPI): string | undefined;
 /**
- * Liest das aktuelle Heading-Level aus dem DOM an der Cursor-Position
+ * Reads the current heading level from the DOM at the cursor position
  */
 declare function getCurrentHeading(editor: EditorAPI, availableHeadings: string[]): string | undefined;
 
@@ -288,5 +384,5 @@ declare function findClosestCheckboxList(element: HTMLElement): HTMLElement | nu
  */
 declare function ensureAllCheckboxes(editor: HTMLElement): void;
 
-export { Dropdown, Editor, HistoryManager, TableContextMenuProvider, Toolbar, advancedLinkPlugin, alignmentPlugin, blockquotePlugin, boldPlugin, clearFormattingPlugin, codeInlinePlugin, contentToDOM, contentToHTML, createAdvancedLinkPlugin, createAlignmentPlugin, createBackgroundColorPlugin, createBlockFormatPlugin, createEmptyContent, createFontSizePlugin, createHeadingsPlugin, createImagePlugin, createLinkPlugin, createTextColorPlugin, Editor as default, defaultPlugins, domToContent, ensureAllCheckboxes, findClosestCheckboxList, getCurrentBackgroundColor, getCurrentFontSize, getCurrentHeading, getCurrentTextColor, htmlToContent, indentListItem, indentListItemPlugin, isCheckboxList, italicPlugin, linkPlugin, orderedListPlugin, outdentListItem, outdentListItemPlugin, redoPlugin, strikethroughPlugin, subscriptPlugin, superscriptPlugin, tablePlugin, underlinePlugin, undoPlugin, unorderedListPlugin };
-export type { ButtonProps, CustomRenderer, EditorAPI, EditorContent, EditorNode, EditorProps, Plugin };
+export { Dropdown, Editor, HistoryManager, TableContextMenuProvider, Toolbar, advancedLinkPlugin, alignmentPlugin, blockquotePlugin, boldPlugin, buildPluginsFromSettings, clearFormattingPlugin, codeInlinePlugin, contentToDOM, contentToHTML, createAdvancedLinkPlugin, createAlignmentPlugin, createBackgroundColorPlugin, createBlockFormatPlugin, createEmptyContent, createFontSizePlugin, createHeadingsPlugin, createImagePlugin, createLinkPlugin, createTextColorPlugin, Editor as default, defaultEditorSettings, defaultPlugins, domToContent, ensureAllCheckboxes, findClosestCheckboxList, getCurrentBackgroundColor, getCurrentFontSize, getCurrentHeading, getCurrentTextColor, htmlToContent, indentListItem, indentListItemPlugin, isCheckboxList, italicPlugin, linkPlugin, orderedListPlugin, outdentListItem, outdentListItemPlugin, redoPlugin, strikethroughPlugin, subscriptPlugin, superscriptPlugin, tablePlugin, underlinePlugin, undoPlugin, unorderedListPlugin };
+export type { AdvancedLinkOptions, BlockFormatOptions, BuildPluginsOptions, ButtonProps, CustomRenderer, EditorAPI, EditorContent, EditorNode, EditorProps, EditorSettings, LinkCustomField, Plugin };

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AAGrC,cAAc,SAAS,CAAC;AAGxB,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAG/D,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrE,cAAc,yBAAyB,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAGtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,OAAO,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAG/C,cAAc,WAAW,CAAC;AAC1B,cAAc,uBAAuB,CAAC;AACtC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AAGrC,cAAc,SAAS,CAAC;AAGxB,cAAc,iBAAiB,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAG/D,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrE,cAAc,yBAAyB,CAAC;AAGxC,OAAO,EAAE,cAAc,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAC;AAGtE,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAGvD,OAAO,EAAE,MAAM,IAAI,OAAO,EAAE,MAAM,qBAAqB,CAAC"}