smartrte-react 1.0.0-beta.1 → 1.0.0-beta.10

package/dist/toolbarTools.d.ts

@@ -0,0 +1,95 @@
+/**
+ * A named, per-tool toolbar-visibility toggle - "developers should be able
+ * to hide tools they don't want their users to see" (e.g. Version History,
+ * Review, Video, Audio), without wrapping/overriding the component or
+ * patching it with CSS. This is a UI-visibility layer, distinct from and
+ * composed with (never replacing) two existing, deeper mechanisms:
+ *
+ * - `EditorCapabilityPreset` (capabilityPresets.ts) controls real document
+ *   *capability* - which plugins the schema itself is built with (today,
+ *   only `table`). Excluding a plugin there already, correctly, hides its
+ *   toolbar entry (`tablesEnabled`) - this file does not duplicate that.
+ * - Provider presence (`mediaProvider`, `versionProvider`, `commentProvider`,
+ *   `suggestionProvider`) already gates whether a feature can function at
+ *   all. `tools` never turns a tool ON when its required provider is
+ *   absent - see `resolveToolbarTools`'s own doc comment.
+ *
+ * `tools` is for the remaining, larger set of toolbar entries that have no
+ * other on/off mechanism at all today (Bold, Italic, Video, Audio, Special
+ * characters, Version history, ...) - a host that wants to hide any of
+ * these previously had no supported way to do so.
+ *
+ * Deliberately NOT covered by individual keys (scoping decision, not an
+ * oversight): purely contextual actions that only ever act on something
+ * already selected - block move/indent, list-item indent/move/restart
+ * numbering, table row/column/cell operations, and the selected-media
+ * edit/resize/delete actions. None of these have independent product
+ * meaning (there is no real case for "let people insert a table but hide
+ * its 'Add row' action") - they stay governed solely by their owning
+ * top-level tool (`insertTable`, `bulletedList`/`numberedList`/`checklist`,
+ * `link`, `image`/`video`/`audio`).
+ */
+export interface ToolbarTools {
+    bold: boolean;
+    italic: boolean;
+    underline: boolean;
+    strikethrough: boolean;
+    code: boolean;
+    superscript: boolean;
+    subscript: boolean;
+    textColor: boolean;
+    backgroundColor: boolean;
+    fontSize: boolean;
+    fontFamily: boolean;
+    /** The Paragraph/Heading 1-6/Code block <select>. */
+    blockType: boolean;
+    alignLeft: boolean;
+    alignCenter: boolean;
+    alignRight: boolean;
+    alignJustify: boolean;
+    /** The line-spacing dropdown (1/1.15/1.5/2/2.5 presets plus a custom value). */
+    lineHeight: boolean;
+    quote: boolean;
+    bulletedList: boolean;
+    numberedList: boolean;
+    checklist: boolean;
+    /** The named multi-level marker preset picker (decimal/alpha/roman/outline/bullet-glyph) - independent of the plain list-type toggles above. */
+    listPreset: boolean;
+    link: boolean;
+    removeLink: boolean;
+    /** Requires `mediaProvider` to actually render - see resolveToolbarTools. */
+    image: boolean;
+    /** Requires `mediaProvider` to actually render - see resolveToolbarTools. */
+    video: boolean;
+    /** Requires `mediaProvider` to actually render - see resolveToolbarTools. */
+    audio: boolean;
+    insertFormula: boolean;
+    specialCharacters: boolean;
+    /** Inserts a `divider` atom (a horizontal rule) - see docs/bugs/ for the toolbar-tools feature this was added alongside. */
+    horizontalLine: boolean;
+    /** Inserts a `page_break` atom - a print/export pagination marker, distinct from `horizontalLine`. */
+    pageBreak: boolean;
+    /** Requires the schema to actually have the table plugin (EditorCapabilityPreset) - see resolveToolbarTools. */
+    insertTable: boolean;
+    import: boolean;
+    saveAsHtml: boolean;
+    saveAsMarkdown: boolean;
+    saveAsWord: boolean;
+    saveAsPdf: boolean;
+    saveAsSmartRte: boolean;
+    /** Requires `versionProvider` to actually render. */
+    versionHistory: boolean;
+    /** Bundles "Add comment" and the Comments panel toggle - requires `commentProvider` to actually render. */
+    comments: boolean;
+    /** Bundles Suggest insertion/deletion/removal, the Suggestions panel toggle, and "Show edits" (track changes) - requires `suggestionProvider` to actually render. */
+    suggestions: boolean;
+    undo: boolean;
+    redo: boolean;
+}
+/** Every tool defaults to visible - an existing consumer who never passes `tools` sees 100% unchanged behavior. */
+export declare const DEFAULT_TOOLBAR_TOOLS: ToolbarTools;
+/**
+ * Merges a host's partial `tools` override onto the all-enabled default -
+ * a host only ever needs to name the tools they want OFF.
+ */
+export declare const resolveToolbarTools: (tools?: Partial<ToolbarTools>) => ToolbarTools;

package/dist/toolbarTools.js

@@ -0,0 +1,17 @@
+/** Every tool defaults to visible - an existing consumer who never passes `tools` sees 100% unchanged behavior. */
+export const DEFAULT_TOOLBAR_TOOLS = {
+    bold: true, italic: true, underline: true, strikethrough: true, code: true,
+    superscript: true, subscript: true, textColor: true, backgroundColor: true, fontSize: true, fontFamily: true,
+    blockType: true, alignLeft: true, alignCenter: true, alignRight: true, alignJustify: true, lineHeight: true, quote: true,
+    bulletedList: true, numberedList: true, checklist: true, listPreset: true,
+    link: true, removeLink: true, image: true, video: true, audio: true, insertFormula: true, specialCharacters: true,
+    horizontalLine: true, pageBreak: true, insertTable: true,
+    import: true, saveAsHtml: true, saveAsMarkdown: true, saveAsWord: true, saveAsPdf: true, saveAsSmartRte: true,
+    versionHistory: true, comments: true, suggestions: true,
+    undo: true, redo: true,
+};
+/**
+ * Merges a host's partial `tools` override onto the all-enabled default -
+ * a host only ever needs to name the tools they want OFF.
+ */
+export const resolveToolbarTools = (tools) => ({ ...DEFAULT_TOOLBAR_TOOLS, ...tools });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartrte-react",
-  "version": "1.0.0-beta.1",
+  "version": "1.0.0-beta.10",
   "description": "A powerful, feature-rich Rich Text Editor for React with support for tables, mathematical formulas (LaTeX/KaTeX), and media management",
   "type": "module",
   "main": "dist/index.js",
@@ -84,7 +84,7 @@
     "lucide-react": "^1.35.0",
     "mammoth": "^1.11.0",
     "pdfjs-dist": "^5.4.530",
-    "smartrte-core": "^1.0.0-beta.1"
+    "smartrte-core": "^1.0.0-beta.5"
   },
   "scripts": {
     "build": "rm -rf dist && tsc -p tsconfig.json",