Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- ⚡ Fully native input and display components (Supports New Architecture only)
- 💻 HTML-based parsing with live, synchronous text styling
- 🎨 Fully customizable styles for seamless UI integration
- 🌐 Solid mobile support with an experimental Web implementation
- 🌐 Solid mobile and web support

`EnrichedTextInput`, the rich text input 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.

Expand Down Expand Up @@ -46,7 +46,7 @@ We can help you build your next dream product –

## Prerequisites

- `react-native-enriched-html` currently supports Android and iOS, Web implementation is still experimental.
- `react-native-enriched-html` currently supports Android, iOS and Web.
- It works only with [the React Native New Architecture (Fabric)](https://reactnative.dev/architecture/landing-page) and supports following React Native releases: `0.81`, `0.82`, `0.83`, `0.84`, `0.85` and `0.86`.

## Installation
Expand Down Expand Up @@ -379,10 +379,6 @@ See the [EnrichedText API Reference](docs/TEXT_API_REFERENCE.md) for the `Enrich

- Only one level of lists is supported. We currently do not support nested lists.

## Future Plans

- Web support: currently in the experimental stage. Details in [docs/WEB.md](docs/WEB.md).

## Contributing
Comment thread
kacperzolkiewski marked this conversation as resolved.

See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
Expand Down
2 changes: 0 additions & 2 deletions docs/INPUT_API_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# API Reference

> **Web support is experimental.** Behavior may change without a major version bump.
## Props

### `allowFontScaling`
Expand Down
2 changes: 0 additions & 2 deletions docs/TEXT_API_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# EnrichedText API Reference

> **Web support is experimental.** Behavior may change without a major version bump.
## Props

### `allowFontScaling`
Expand Down
30 changes: 1 addition & 29 deletions docs/WEB.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,7 @@
# Web Support (Experimental)

Web support is still experimental. APIs and behavior can change in future releases without a major version bump. Expect breaking changes until the web path is stabilized.
# Web Support

## Enriched Text Input

### What works

- Inline marks: bold, italic, underline, strikethrough, inline code
- Headings (h1-h6)
- Blockquote, code block
- Ordered lists, unordered lists, checkbox lists
- Images (via `setImage` ref method and optional `onPasteImages` when pasting image data)
- Manual links (via `setLink` ref method)
- Mentions
- Automatic link detection
- `getHTML`, `setValue`, selection mapping
- Core callbacks: `onChange`, `onChangeState`, `onFocus`, `onBlur`, `onSelectionChange`
- Submit props: `submitBehavior` and `onSubmitEditing`. `returnKeyType` is only a hint, it maps to [enterkeyhint](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/enterkeyhint) (`done`, `go`, `next`, `previous`, `search`, `send`, `default`/`enter`). Not all values of `ReturnKeyTypeOptions` are supported, the behavior of this prop is heavily dependent on the browser's capabilities.
- Input theming via `placeholderTextColor`, `cursorColor` and `selectionColor` props
- Keyboard shortcuts for formatting
- `useHtmlNormalizer`
- Setting text alignment via `setTextAlignment()`
- `textShortcuts`

### Keyboard shortcuts

See [Web Keyboard Shortcuts](./INPUT_API_REFERENCE.md#web-keyboard-shortcuts) for the up-to-date list of Web keyboard shortcuts.
Expand All @@ -36,13 +15,6 @@ See [Web Keyboard Shortcuts](./INPUT_API_REFERENCE.md#web-keyboard-shortcuts) fo

## Enriched Text

### What works

- Customizing the styling using props: `style`, `htmlStyle`, `selectionColor`.
- `selectable` prop
- `useHtmlNormalizer`
- `onLinkPress` and `onMentionPress` callbacks

### Unsupported

- **`ellipsizeMode`**: ignored on web.
Expand Down
Loading