Skip to content

Changes before relese v2.1#51

Open
serhiipylypchuk1991 wants to merge 33 commits into
nextfrom
sp-next-v-2-1
Open

Changes before relese v2.1#51
serhiipylypchuk1991 wants to merge 33 commits into
nextfrom
sp-next-v-2-1

Conversation

@serhiipylypchuk1991
Copy link
Copy Markdown
Contributor

No description provided.

- index.md: list Markdown alongside HTML and plain text in features and Supported formats; add example with richtext.markdown encoders and a note on the supported subset
- get-value.md / set-value.md: include markdown in the encoder list and show richtext.markdown.toMarkdown / fromMarkdown usage
- new article docs/api/methods/insert-value.md covering description, parameters (value, optional encoder), encoder snippet (text/html/markdown), example and v2.1 change log
- register the method in sidebars.js and in main_overview.md / methods_overview.md tables
- new "Copy and paste" section in index.md describing system shortcuts, toolbar/menubar entries, plain-text + HTML clipboard payload, paste fallback to plain text, and behavior across RichText instances and external sources
- note that the toolbar Paste button uses the async Clipboard API (plain text only), while Ctrl+V / ⌘V receives full HTML
- image-upload-url.md: describe optional behavior — when imageUploadUrl is omitted, images are inserted as base64 data URLs with 1024x800 downscaling; add upload vs inline examples and note caveats around DOCX/PDF export and payload size
- guides/configuration.md: rename "Configure the image upload URL" to "Configure image insertion" and split into server-upload vs inline base64 modes
- insert-image.md: clarify that IImageContext.value holds either an external URL or a base64 data URL
- index.md: mention server upload and inline base64 in the features list
- image-upload-url.md @short and configuration guide now state that image uploads can be triggered from the toolbar, menubar, clipboard paste, or drag-and-drop, not just the toolbar
- insert-image.md @short updated to match
- macOS shortcuts now follow Ctrl+C style: ⌘+C / ⌘+X / ⌘+V (incl. the note about ⌘+V)
- clarify that pasting from any external source is processed as plain text; previous wording about HTML-aware external paste was incorrect
- drop the separate plain-text-source bullet; external-source behavior is now one line
- drop "fully" from "fully optional" in the v2.1 change-log note
- @short now describes the inserted content as "text, Markdown, or HTML" instead of the abstract "a value"
- drop "from a custom format" from the encoder description; the supported formats are listed on the next line
- extend Markdown support note in docs/index.md
- document that nested inline structures are unsupported
- call out bold-inside-italic as the only exception
- list bold-in-link, italic-in-list, multi-level lists as cases that won't render correctly
- new API reference page for the hide-suggest event
- documents when the dropdown closes (selection, Escape, cursor leaves trigger, empty result)
- new API reference page for the insert-token event
- documents callback fields (id, label, url, trigger, showTrigger)
- new API reference page for the show-suggest event
- documents callback fields (trigger, query, items, pos) and intercept example
- new API reference page for the triggers property
- covers static array, sync function, async function data sources
- documents suggestion item fields and rendered token CSS targeting
- new API reference page for the triggerTemplate property
- documents callback parameters (data, trigger) and template usage
- includes tip on overriding the dropdown anchor width
- new guide covering trigger characters, data source forms, token rendering, and event handling
- examples for static array, sync function, async function, and custom dropdown templates
- list hide-suggest, insert-token, and show-suggest in the events table
- list triggers and triggerTemplate in the properties table
- list triggers in the property overview with a link to the Mentions and tags guide
- update anchor in whats_new from #custom-toolbar-controls to #add-custom-toolbar-controls to match the heading in configuration.md
- add hide-suggest, insert-token, show-suggest under events
- add triggers and trigger-template under properties
- add mentions_and_tags under guides
- add `action` field to triggers config with Custom action section
  (emoji insertion and slash-style command menu examples)
- update insert-token event payload: id/label/url replaced by `data`
  object carrying the picked item plus custom fields; add `action`
- note that `action` takes priority over `showTrigger`
- show-suggest items now documented as optional fields + custom keys
- extend mentions guide with custom action examples
- fix typos, a broken anchor, and align wording across pages
- destructure ({ data, trigger, showTrigger }) to match the
  insert-token event docs and the PR review suggestion
- mark suggestion `label` as optional (custom triggerTemplate case)
- note Ctrl+Click opens token url, explain mailto behavior
- break down rendered token attributes (trigger/id/url/label)
- clarify custom action can run code without inserting content
- add "Group emoji by category" example with custom filtering,
  category headers and api.intercept guard
- triggerTemplate: add second trigger so trigger check is meaningful,
  replace !important width tip with more specific selector
[update] note paste and drag-and-drop as image upload sources
…AR-2920

# Conflicts:
#	docs/guides/configuration.md
[add] document inline base64 image insertion
[add] document copy and paste behavior
[add] document insertValue() method
- merge the Copy and paste section from the base branch with the new
  Markdown format section
- pull in the expanded image uploading feature line from base
- fix misleading example: Markdown cannot be passed via the value config
  (always parsed as HTML), use setValue with the markdown encoder instead
… into sp-next-v-SVAR-2919

# Conflicts:
#	docs/index.md
[add] document Markdown encoder support
@serhiipylypchuk1991 serhiipylypchuk1991 self-assigned this Jun 4, 2026
Describe new API related to triggers
- trigger-template: "the template use" -> "uses"
- triggers: "instead of selected one" -> "instead of the selected one"
- mentions_and_tags: align dash in trigger list, drop stray space in note
- set-value: encoder describes decoding the value from a format (consistent with insertValue)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant