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
Co-authored-by: Kacper Żółkiewski <74975508+kacperzolkiewski@users.noreply.github.com>
…wicz/docs-core-functionalities
…wicz/docs-core-functionalities
…wicz/docs-core-functionalities
| - **`style`** - the container's layout behavior and its base typography (`fontSize`, `color`, `fontFamily`, …). It accepts a subset of React Native's `TextStyle`, described by | ||
| `EnrichedInputStyle`. |
There was a problem hiding this comment.
I think we could create a section for style (same as for htmlStyle) that will at least list these props available through the EnrichedInputStyle. They might be linked to the RN TextStyle counterparts but not mandatory imo.
There was a problem hiding this comment.
I've added a note that will direct the reader to the api-reference. The full list is already in the api-reference section, I wouldn't put it again in this file to be honest. WDYT?
Co-authored-by: Mikołaj Szydłowski <9szydlowski9@gmail.com>
Summary
The
Core functionalitiessection in the docs