Skip to content

Commit f562a15

Browse files
exploIFszydlovsky
andauthored
chore: add known limitations to docs (#189)
It may not be clear that we do not support nested lists (as reported in #187). I've added section with known limitations where we can explicitly mention such limitations --------- Co-authored-by: szydlovsky <9szydlowski9@gmail.com>
1 parent f678b77 commit f562a15

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
`EnrichedTextInput`, the rich text editor component is an uncontrolled input. This means that it doesn't use any state or props to store its value, but instead directly interacts with the underlying platform-specific components. Thanks to this, the component is really performant and simple to use while offering complex and advanced features no other solution has.
1515

16-
https://github.com/user-attachments/assets/4778d541-d967-47e7-8013-6f7c436bcb95
16+
<https://github.com/user-attachments/assets/4778d541-d967-47e7-8013-6f7c436bcb95>
1717

1818
Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues.
1919
We can help you build your next dream product –
@@ -32,6 +32,7 @@ We can help you build your next dream product –
3232
- [Other Events](#other-events)
3333
- [Customizing \<EnrichedTextInput /> styles](#customizing-enrichedtextinput--styles)
3434
- [API Reference](#api-reference)
35+
- [Known limitations](#known-limitations)
3536
- [Future Plans](#future-plans)
3637
- [Contributing](#contributing)
3738
- [License](#license)
@@ -240,6 +241,13 @@ You can find some examples in the [usage section](#usage) or in the example app.
240241

241242
See the [API Reference](docs/API_REFERENCE.md) for a detailed overview of all the props, methods, and events available.
242243

244+
## Known limitations
245+
246+
- Only one level of lists is supported. We currently do not support nested lists.
247+
- Inline images are supported only on Android.
248+
- Codeblocks are supported only on Android.
249+
- iOS headings can't have the same `fontSize` in their config as input's `fontSize`. Doing so results in incorrect headings behavior.
250+
243251
## Future Plans
244252

245253
- Adding Codeblocks and Inline Images to iOS input.

0 commit comments

Comments
 (0)