[add] document insertValue() method#40
Open
serhiipylypchuk1991 wants to merge 2 commits into
Open
Conversation
Contributor
serhiipylypchuk1991
commented
May 22, 2026
serhiipylypchuk1991
commented
- 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 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
|
all is ok |
kullias
reviewed
May 26, 2026
kullias
requested changes
May 26, 2026
| ### Parameters | ||
|
|
||
| - `value` - (required) a value to be inserted into the RichText at the current cursor position. If a selection is active, the selection is replaced with the new value | ||
| - `encoder` - (optional) a parser used to decode the inserted value from a custom format. The following formats are available: `html` (default), `text`, and `markdown` |
There was a problem hiding this comment.
"custom format" is somewhat misleading. only 3 formats are supported, which is said later. so just drop "from a custom format"
- @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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.