docs: core funtionalities section - #715
Open
hejsztynx wants to merge 11 commits into
Open
Conversation
Contributor
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
|
|
||
| ## One API across platforms | ||
|
|
||
| The web build exposes the **same props, ref methods, and events** as native. |
Collaborator
There was a problem hiding this comment.
Maybe we can soften somehow same props because web for example have sanitizationConfig that native does not support?
|
|
||
| ## Notable props | ||
|
|
||
| - **`selectable`** - allow the user to select and copy the rendered text. |
Collaborator
There was a problem hiding this comment.
Maybe we should add also allowFontScaling prop here?
| `EnrichedTextInput` is styled through two separate props. Together they cover | ||
| everything from the container's dimensions down to the color of a bullet point. | ||
|
|
||
| - **`style`** - the container's layout behavior and its base typography (`fontSize`, `color`, `fontFamily`, …). It accepts a subset of React Native's `TextStyle`, described by |
Collaborator
There was a problem hiding this comment.
Maybe we should add also some info about: placeholderTextColor, cursorColor and selectionColor?
Those props are also responsible for styling.
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
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.
Summary
The
Core functionalitiessection in the docs