Skip to content

docs: core funtionalities section - #715

Open
hejsztynx wants to merge 11 commits into
@ksienkiewicz/docs-rich-text-formattingfrom
@ksienkiewicz/docs-core-functionalities
Open

docs: core funtionalities section#715
hejsztynx wants to merge 11 commits into
@ksienkiewicz/docs-rich-text-formattingfrom
@ksienkiewicz/docs-core-functionalities

Conversation

@hejsztynx

Copy link
Copy Markdown
Collaborator

Summary

The Core functionalities section in the docs

  • Styling the input
  • Rendering rich text
  • Handling events
  • Web support

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/src/examples/RenderingEditor.tsx
Comment thread docs/src/examples/RenderingEditor.tsx
Comment thread docs/docs/core-functionalities/web-support.md
Comment thread docs/docs/core-functionalities/handling-events.md Outdated
Comment thread docs/docs/core-functionalities/styling-the-input.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Comment thread docs/src/examples/RenderingEditor.tsx Outdated
Comment thread docs/docs/core-functionalities/rendering-rich-text.mdx Outdated
- **`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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would also add some info about onLinkDetected cleanup event, the same as for mentions

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same with mentions events, I wonder if it's the right place for that

Comment thread docs/docs/core-functionalities/web-support.md Outdated
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.

3 participants