smartrte-react 1.0.0-beta.5 → 1.0.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## 1.0.0-beta.8
+
+- Add a `tools` prop (`ClassicEditor`, `CanonicalAuthorityEditor`, and the standalone embed) letting a host hide any individual toolbar tool — Bold, Video, Version history, Review, and around 40 others — without wrapping or restyling the component. Every tool is visible by default; composes with existing gates (a required provider or capability must still be present). See the README's "Hiding individual toolbar tools" section for the full list and usage.
+- Retire the never-shipped `showVersionHistory`/`showReview` props in favor of `tools.versionHistory`/`tools.comments`/`tools.suggestions`.
+- Also export `EditorCapabilityPreset` from the package's public entry point (previously only reachable indirectly through `CanonicalAuthorityEditorProps`).
+
+## 1.0.0-beta.7
+
+- Fix the mobile "More tools" overflow menu getting clipped almost entirely off-screen when the editor is embedded inside a host container with `overflow: hidden` — the same fix already applied to the desktop toolbar dropdowns, now also covering this menu (the only overflow affordance on narrow viewports).
+- Add the "List preset" control (decimal/lower-alpha/upper-alpha/roman-numeral/outline numbering styles, plus bullet-glyph presets) to the mobile "More tools" menu — previously only reachable from the desktop toolbar's "More list tools" dropdown, leaving narrow-viewport users with no way to use anything beyond plain bulleted/numbered/checklist lists.
+
+## 1.0.0-beta.6
+
+- Replace the media Edit overlay's plain alt-text prompt with a full "Media details" panel: link (with open-in-new-tab), corner radius, alignment, and license fields (description, source URL, type, version, attribution), matching the pre-canonical editor's own edit-panel field set. A library-picked image's existing license metadata is now carried onto the inserted atom instead of being discarded. Depends on `smartrte-core@1.0.0-beta.3`.
+
 ## 1.0.0-beta.5
 
 - Add an opt-in `renderFormulaHtml` prop (on `ClassicEditor`/`CanonicalAuthorityEditor`) that bakes real KaTeX-rendered HTML into the formula elements of `onChange`'s exported HTML, instead of an empty placeholder — for hosts that display saved content directly (e.g. a read-only preview panel) without also running KaTeX against it. Depends on `smartrte-core@1.0.0-beta.2`.

package/README.md

@@ -96,6 +96,7 @@ export default App;
 | `defaultFont` | `string` | `undefined` | Default font family for the editor content |
 | `theme` | `"light" \| "dark"` | `"light"` | Built-in theme mode |
 | `className` | `string` | `undefined` | Custom CSS class for theming via CSS variable overrides |
+| `tools` | `Partial<ToolbarTools>` | every tool `true` | Hide individual toolbar tools (Bold, Video, Version history, etc.) — see [Hiding individual toolbar tools](#hiding-individual-toolbar-tools) below |
 
 ### Advanced Examples
 
@@ -118,6 +119,99 @@ import { ClassicEditor } from 'smartrte-react';
 />
 ```
 
+#### Hiding individual toolbar tools
+
+The `table`/`media`/`formula` props above turn off a whole *capability* — no
+tables anywhere, or media/formulas removed from the schema entirely. If you
+just want a **smaller toolbar** while keeping every capability intact (e.g.
+hide Video, Audio, Version history, and Review for a specific product
+surface, without touching what content the editor can actually store), use
+`tools` instead. It's a plain object: name the tools you want off, everything
+else stays on by default. No wrapping, no CSS overrides, no forking the
+component.
+
+```tsx
+import { ClassicEditor } from 'smartrte-react';
+
+<ClassicEditor
+  tools={{
+    video: false,
+    audio: false,
+    versionHistory: false,
+    comments: false,
+    suggestions: false,
+  }}
+/>
+```
+
+**How it composes with everything else:** a tool only ever needs *both*
+things to be true to show up — your `tools` flag says yes, *and* whatever
+that tool actually depends on is present. So:
+
+- `tools.video`/`tools.audio`/`tools.image` also need a `mediaProvider` (or
+  `mediaManager`) to be configured at all — turning the flag on can't make
+  media insertion appear out of nowhere if you never wired up a provider.
+- `tools.versionHistory` also needs a `versionProvider`; `tools.comments`
+  needs a `commentProvider`; `tools.suggestions` needs a `suggestionProvider`.
+- `tools.insertTable` also needs the table capability to actually be enabled
+  (i.e. you haven't set `table={false}`) — you can't use `tools` to bring
+  back a capability you turned off elsewhere.
+
+In other words: `tools` can only ever hide something, never force something
+into existence that isn't otherwise configured. This means it's always safe
+to leave `tools` unset — every consumer who doesn't pass it sees the exact
+toolbar they see today.
+
+**Every toggleable key**, grouped the way they appear in the toolbar:
+
+```ts
+interface ToolbarTools {
+  // Text formatting
+  bold, italic, underline, strikethrough, code,
+  superscript, subscript, textColor, backgroundColor, fontSize, fontFamily,
+
+  // Paragraph
+  blockType,   // the Paragraph/Heading/Code block dropdown
+  alignLeft, alignCenter, alignRight, alignJustify, quote,
+
+  // Lists
+  bulletedList, numberedList, checklist,
+  listPreset,  // the numbered-list style picker (1,2,3 / a,b,c / i,ii,iii / A,B,C / I,II,III)
+
+  // Insert
+  link, removeLink, image, video, audio, insertFormula, specialCharacters, insertTable,
+
+  // Document
+  import,
+  saveAsHtml, saveAsMarkdown, saveAsWord, saveAsPdf, saveAsSmartRte,
+  versionHistory, comments, suggestions,
+
+  // History
+  undo, redo,
+}
+```
+
+A few notes on what's *not* in this list, on purpose: actions that only ever
+apply to something you already have selected — moving a block up/down,
+indenting a list item, adding/removing a table row or column, resizing a
+selected image — aren't individually toggleable. They only make sense as
+part of using the tool that created them (a table, a list, an image), so
+they follow that tool's own visibility rather than needing a separate flag
+each. If you turn off `insertTable`, its row/column tools go with it
+automatically — there's no separate flag to remember.
+
+If you're using the exported `CanonicalAuthorityEditor` directly instead of
+`ClassicEditor`, `tools` works exactly the same way. And if you're using the
+standalone embed (`window.SmartRTE.ClassicEditor.init(...)`), pass `tools`
+in the same options object you pass `target`/`value`/etc.
+
+```ts
+window.SmartRTE.ClassicEditor.init({
+  target: document.getElementById('editor'),
+  tools: { video: false, audio: false },
+});
+```
+
 #### Complete Example with All Features
 
 ```tsx

package/dist/components/CanonicalAuthorityEditor.d.ts

@@ -6,6 +6,7 @@ import type { CommentProvider } from "../commentProvider.js";
 import type { SuggestionProvider } from "../suggestionProvider.js";
 import { type MediaPickerComponent } from "./MediaPicker.js";
 import type { EditorCapabilityPreset } from "../capabilityPresets.js";
+import { type ToolbarTools } from "../toolbarTools.js";
 import { CanonicalEditorRuntime, type SmartEditorChange, type SmartEditorHandle } from "../canonicalEditorRuntime.js";
 export interface CanonicalAuthorityEditorProps {
     /** Initial value only. Later replacements must use SmartEditorHandle.replaceValue. */
@@ -42,7 +43,20 @@ export interface CanonicalAuthorityEditorProps {
      * for images too.
      */
     mediaManager?: boolean;
-    /** Host-owned save/list/load/remove boundary for document version history. Absent hides the version-history toolbar button entirely, mirroring mediaProvider's absent-disables-the-feature contract. */
+    /**
+     * Per-tool toolbar visibility - "developers should be able to hide tools
+     * which are not for their use" (docs/bugs/per-tool-toolbar-visibility.md).
+     * Every tool defaults to visible; a host only needs to name the ones they
+     * want off (`tools={{ video: false, versionHistory: false }}`). Composes
+     * with, never overrides, the deeper existing gates: a tool whose required
+     * provider is absent (`versionProvider`/`commentProvider`/
+     * `suggestionProvider`/`mediaProvider`) or whose plugin was excluded via
+     * `preset` (e.g. `insertTable` under `preset="simple"`) still won't
+     * render even if explicitly set to `true` here - see ToolbarTools.ts's
+     * own doc comment for the full contract and scoping decisions.
+     */
+    tools?: Partial<ToolbarTools>;
+    /** Host-owned save/list/load/remove boundary for document version history. */
     versionProvider?: VersionProvider;
     /** Host-owned save/list/remove boundary for comment threads. Absent hides the comment toolbar buttons and markers entirely, mirroring versionProvider's absent-disables-the-feature contract. */
     commentProvider?: CommentProvider;