docs: core funtionalities section - #715
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new “Core functionalities” section to the documentation, describing how to style EnrichedTextInput, render read-only rich text via EnrichedText, handle editor events, and use the library on the web.
Changes:
- Added new rich-text rendering documentation page (MDX) with a live interactive example.
- Filled in the previously-blank “Styling the input”, “Handling events”, and “Web support” docs pages.
- Added a new docs example component (
RenderingEditor) and removed the old placeholder Markdown page.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/examples/RenderingEditor.tsx | New interactive example used by the docs to render HTML from the editor into EnrichedText. |
| docs/docs/core-functionalities/web-support.md | Documents web implementation details, shortcuts, platform differences, sanitization, and SSR guidance. |
| docs/docs/core-functionalities/styling-the-input.md | Documents style vs htmlStyle and lists supported htmlStyle keys/options. |
| docs/docs/core-functionalities/rendering-rich-text.mdx | New MDX page explaining EnrichedText, styling, notable props, and includes a live example. |
| docs/docs/core-functionalities/rendering-rich-text.md | Removes the old placeholder page in favor of the new MDX version. |
| docs/docs/core-functionalities/handling-events.md | Documents available callbacks/events and provides guidance on when to use onChangeHtml vs getHTML(). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
…wicz/docs-core-functionalities
| - **`onStartMention`** - a mention started being edited. | ||
| - **`onChangeMention`** - the query after the indicator changed. | ||
| - **`onEndMention`** - editing a mention stopped. | ||
| - **`onMentionDetected`** - the cursor entered or left a mention. |
There was a problem hiding this comment.
Maybe it would be worth mentioning that when the cursor leaves a mention, the event fires with empty values so you can clean up any related state?
There was a problem hiding this comment.
Good idea, but I wonder if that information should be here or in the api-reference 🤔
|
|
||
| ## Links | ||
|
|
||
| - **`onLinkDetected`** - the cursor entered or left a link. |
There was a problem hiding this comment.
I would also add some info about onLinkDetected cleanup event, the same as for mentions
There was a problem hiding this comment.
The same with mentions events, I wonder if it's the right place for that
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
…wicz/docs-core-functionalities
…wicz/docs-core-functionalities
Summary
The
Core functionalitiessection in the docs