docs: add api reference section - #716
Open
kacperzolkiewski wants to merge 16 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds full API reference documentation pages for the library’s two main public components (EnrichedTextInput editor and EnrichedText renderer), replacing prior TODO placeholders.
Changes:
- Documented
EnrichedTextprops, types, remarks, and platform compatibility. - Added a comprehensive
EnrichedTextInputAPI reference including props, ref methods, and style/type definitions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/docs/api-reference/enriched-text.md | Adds EnrichedText API reference with prop documentation and related types. |
| docs/docs/api-reference/enriched-text-input.md | Adds EnrichedTextInput API reference covering props, ref methods, and styling/type details. |
💡 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>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
hejsztynx
requested changes
Jul 21, 2026
|
|
||
| ## Props | ||
|
|
||
| ### `allowFontScaling` <Optional /> {#allowfontscaling} |
Collaborator
There was a problem hiding this comment.
I'm not sure about that Optional mark. Pretty much every prop we support is optional and IMO it creates unnecessary noise when reading, especially as its style it is pretty vibrant. What about changing the approach and marking the non-optional fields with a <Required /> instead?
Collaborator
Author
There was a problem hiding this comment.
Lets wait and see what @szydlovsky and @exploIF think about it ;)
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
Co-authored-by: Krystian Sienkiewicz <146986839+hejsztynx@users.noreply.github.com>
hejsztynx
approved these changes
Jul 21, 2026
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
Add Api reference section to docs