Skip to content

Commit 915a0c9

Browse files
committed
feat: 1.0.0 rename
1 parent 7ce19e4 commit 915a0c9

41 files changed

Lines changed: 140 additions & 137 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
33
- name: Feature Request 💡
4-
url: https://github.com/software-mansion/react-native-enriched/discussions/new?category=ideas
4+
url: https://github.com/software-mansion/react-native-enriched-html/discussions/new?category=ideas
55
about: If you have a feature request, please create a new discussion on GitHub.
66
- name: Discussions on GitHub 💬
7-
url: https://github.com/software-mansion/react-native-enriched/discussions
7+
url: https://github.com/software-mansion/react-native-enriched-html/discussions
88
about: If this library works as promised but you need help, please ask questions there.

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ jobs:
4848
if: ${{ github.event_name == 'workflow_dispatch' }}
4949
uses: software-mansion/npm-package-publish@1bb885ec49bed729c8c1ec95a11a285d89f1bf45
5050
with:
51-
package-name: 'react-native-enriched'
51+
package-name: 'react-native-enriched-html'
5252
package-json-path: 'package.json'
5353
install-dependencies-command: 'yarn install --immutable'
5454
release-type: ${{ inputs.release-type }}
@@ -59,7 +59,7 @@ jobs:
5959
if: ${{ github.event_name == 'schedule' }}
6060
uses: software-mansion/npm-package-publish@1bb885ec49bed729c8c1ec95a11a285d89f1bf45
6161
with:
62-
package-name: 'react-native-enriched'
62+
package-name: 'react-native-enriched-html'
6363
package-json-path: 'package.json'
6464
install-dependencies-command: 'yarn install --immutable'
6565
release-type: 'nightly'

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ The [example app](/apps/example/) demonstrates usage of the library. You need to
2323

2424
It is configured to use the local version of the library, so any changes you make to the library's source code will be reflected in the example app. Changes to the library's JavaScript code will be reflected in the example app without a rebuild, but native code changes will require a rebuild of the example app.
2525

26-
If you want to use Android Studio or Xcode to edit the native code, you can open the `apps/example/android` or `apps/example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `apps/example/ios/EnrichedTextInputExample.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > ReactNativeEnriched`.
26+
If you want to use Android Studio or Xcode to edit the native code, you can open the `apps/example/android` or `apps/example/ios` directories respectively in those editors. To edit the Objective-C or Swift files, open `apps/example/ios/EnrichedTextInputExample.xcworkspace` in Xcode and find the source files at `Pods > Development Pods > ReactNativeEnrichedHtml`.
2727

28-
To edit the Java or Kotlin files, open `apps/example/android` in Android studio and find the source files at `react-native-enriched` under `Android`.
28+
To edit the Java or Kotlin files, open `apps/example/android` in Android studio and find the source files at `react-native-enriched-html` under `Android`.
2929

3030
You can use various commands from the root directory to work with the project.
3131

README.md

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
<img src="https://github.com/user-attachments/assets/c8ba03bc-4ea8-48f4-9566-02ebac0c19d3" alt="react-native-enriched by Software Mansion" width="100%">
1+
<img src="https://github.com/user-attachments/assets/c8ba03bc-4ea8-48f4-9566-02ebac0c19d3" alt="react-native-enriched-html by Software Mansion" width="100%">
22

33
[![Ad](https://swm-delivery.com/www/images/zone-gh-react-native-enriched-1?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-enriched-1&n=1)
44
[![Ad](https://swm-delivery.com/www/images/zone-gh-react-native-enriched-2?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-enriched-2&n=1)
55
[![Ad](https://swm-delivery.com/www/images/zone-gh-react-native-enriched-3?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-react-native-enriched-3&n=1)
66

7-
# react-native-enriched
7+
# react-native-enriched-html
88

9-
`react-native-enriched` is a powerful React Native library that exposes a rich text editor component:
9+
`react-native-enriched-html` is a powerful React Native rich text solution:
1010

11-
- ⚡ Fully native text input component
12-
- 🕹️ Synchronous text styling
13-
- 🔍 Live styling detection and HTML parsing
14-
- 🎨 Customizable styles
15-
- 📱 Mobile platforms support
16-
- 🏛 Supports only the New Architecture
11+
⚡ Fully native input and display components (Supports New Architecture only)
12+
💻 HTML-based parsing with live, synchronous text styling
13+
🎨 Fully customizable styles for seamless UI integration
14+
🌐 Solid mobile support with an experimental Web implementation
1715

18-
`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.
16+
`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.
1917

20-
![react-native-enriched-demo](https://github.com/user-attachments/assets/a2c968c0-9b85-492f-ac71-af64ef231fbf)
18+
`EnrichedText` is the display component designed to work seamlessly with `EnrichedTextInput`. It flawlessly renders any HTML generated by the input, while a shared, customizable styling API guarantees perfect 1:1 visual consistency between editing and displaying.
19+
20+
![react-native-enriched-html-demo](https://github.com/user-attachments/assets/a2c968c0-9b85-492f-ac71-af64ef231fbf)
2121

2222
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.
2323
We can help you build your next dream product –
24-
[Hire us](https://swmansion.com/contact/projects?utm_source=react-native-enriched&utm_medium=readme).
24+
[Hire us](https://swmansion.com/contact/projects?utm_source=react-native-enriched-html&utm_medium=readme).
2525

2626
## Table of Contents
2727

@@ -46,9 +46,8 @@ We can help you build your next dream product –
4646

4747
## Prerequisites
4848

49-
- `react-native-enriched` currently supports only Android and iOS platforms
49+
- `react-native-enriched-html` currently supports Android and iOS, Web implementation is still experimental.
5050
- 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` and `0.85`.
51-
- If you would like to use `react-native-enriched` in React Native `0.79` or `0.80` use `react-native-enriched 0.4.x`.
5251

5352
## Installation
5453

@@ -57,14 +56,14 @@ We can help you build your next dream product –
5756
#### 1. Install the library
5857

5958
```sh
60-
yarn add react-native-enriched
59+
yarn add react-native-enriched-html
6160
```
6261

6362
> [!TIP]
6463
> To try the latest features before they land in a stable release, install the nightly build:
6564
>
6665
> ```sh
67-
> yarn add react-native-enriched@nightly
66+
> yarn add react-native-enriched-html@nightly
6867
> ```
6968
>
7069
> Nightly versions are published to npm automatically and may contain breaking changes.
@@ -82,7 +81,7 @@ cd ios && bundler install && bundler exec pod install
8281
#### 1. Install the library
8382

8483
```sh
85-
npx expo install react-native-enriched
84+
npx expo install react-native-enriched-html
8685
```
8786

8887
#### 2. Run prebuild
@@ -101,11 +100,11 @@ npx expo prebuild
101100
Here's a simple example of an input that lets you toggle bold on its text and shows whether bold is currently active via the button color.
102101

103102
```tsx
104-
import { EnrichedTextInput } from 'react-native-enriched';
103+
import { EnrichedTextInput } from 'react-native-enriched-html';
105104
import type {
106105
EnrichedTextInputInstance,
107106
OnChangeStateEvent,
108-
} from 'react-native-enriched';
107+
} from 'react-native-enriched-html';
109108
import { useState, useRef } from 'react';
110109
import { View, Button, StyleSheet } from 'react-native';
111110

@@ -157,7 +156,7 @@ Summary of what happens here:
157156

158157
## Supported Tags
159158

160-
`react-native-enriched` uses both standard and custom HTML tags in its output and accepts them as input.
159+
`react-native-enriched-html` uses both standard and custom HTML tags in its output and accepts them as input.
161160

162161
Not all styles can be combined freely. There are two kinds of restrictions:
163162

@@ -235,7 +234,7 @@ The links are here, just like in any other editor, a piece of text with a URL at
235234

236235
### Automatic links detection
237236

238-
`react-native-enriched` automatically detects words that appear to be some URLs and makes them links.
237+
`react-native-enriched-html` automatically detects words that appear to be some URLs and makes them links.
239238
You can customize this behavior by providing your own regular expression via [linkRegex](docs/INPUT_API_REFERENCE.md#linkregex) prop.
240239

241240
### Applying links manually
@@ -262,7 +261,7 @@ There are two ways in which a mention can be started; either by typing one of th
262261

263262
### Mention related events
264263

265-
`react-native-enriched` emits 3 different events that help handling mentions' editing:
264+
`react-native-enriched-html` emits 3 different events that help handling mentions' editing:
266265

267266
- [onStartMention](docs/INPUT_API_REFERENCE.md#onstartmention) is emitted whenever mention is started in one of the ways from the [previous section](#starting-a-mention) or the user has come back (moved selection) to some unfinished mention they have started. It can be used for opening proper tools you use in the app to edit a mention (e.g. a list for choosing from users or channels that the mention will affect).
268267
- [onChangeMention](docs/INPUT_API_REFERENCE.md#onchangemention) is emitted whenever user put or removed some characters after a mention indicator. This way you can react to active mention editing by, for example, filtering users in your displayed list based on the typed text.
@@ -286,7 +285,7 @@ You can find some examples in the [usage section](#usage) or in the example app.
286285

287286
## Other Events
288287

289-
`react-native-enriched` emits a few more events that may be of use:
288+
`react-native-enriched-html` emits a few more events that may be of use:
290289

291290
- [onFocus](docs/INPUT_API_REFERENCE.md#onfocus) - emits whenever input focuses.
292291
- [onBlur](docs/INPUT_API_REFERENCE.md) - emits whenever input blurs.
@@ -323,18 +322,18 @@ You can extend the native text editing menu with custom items using the [context
323322

324323
## Customizing \<EnrichedTextInput /> styles
325324

326-
`react-native-enriched` allows customizing styles of the `<EnrichedTextInput />` component. See [htmlStyle](docs/INPUT_API_REFERENCE.md#htmlstyle) prop.
325+
`react-native-enriched-html` allows customizing styles of the `<EnrichedTextInput />` component. See [htmlStyle](docs/INPUT_API_REFERENCE.md#htmlstyle) prop.
327326

328327
## EnrichedText component
329328

330-
`react-native-enriched` provides an `EnrichedText` component that renders the HTML output of `EnrichedTextInput` with all supported styles, interactive links, and mentions.
329+
`react-native-enriched-html` provides an `EnrichedText` component that renders the HTML output of `EnrichedTextInput` with all supported styles, interactive links, and mentions.
331330

332331
```tsx
333-
import { EnrichedText } from 'react-native-enriched';
332+
import { EnrichedText } from 'react-native-enriched-html';
334333
import type {
335334
OnLinkPressEvent,
336335
OnMentionPressEvent,
337-
} from 'react-native-enriched';
336+
} from 'react-native-enriched-html';
338337
import { StyleSheet } from 'react-native';
339338

340339
export default function App() {
@@ -390,7 +389,7 @@ See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the
390389

391390
## License
392391

393-
`react-native-enriched` library is licensed under [The MIT License](./LICENSE).
392+
`react-native-enriched-html` library is licensed under [The MIT License](./LICENSE).
394393

395394
---
396395

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@ require "json"
33
package = JSON.parse(File.read(File.join(__dir__, "package.json")))
44

55
Pod::Spec.new do |s|
6-
s.name = "ReactNativeEnriched"
6+
s.name = "ReactNativeEnrichedHtml"
77
s.version = package["version"]
88
s.summary = package["description"]
99
s.homepage = package["homepage"]
1010
s.license = package["license"]
1111
s.authors = package["author"]
1212

1313
s.platforms = { :ios => min_ios_version_supported }
14-
s.source = { :git => "https://github.com/software-mansion/react-native-enriched.git", :tag => "#{s.version}" }
14+
s.source = { :git => "https://github.com/software-mansion/react-native-enriched-html.git", :tag => "#{s.version}" }
1515

1616
s.source_files = ["ios/**/*.{h,m,mm,cpp}", "cpp/**/*.{h,hpp,c,cpp}"]
1717
s.exclude_files = ["cpp/tests/**"]

android/build.gradle

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
buildscript {
22
ext.getExtOrDefault = {name ->
3-
return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['ReactNativeEnriched_' + name]
3+
return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['ReactNativeEnrichedHtml_' + name]
44
}
55

66
repositories {
@@ -27,7 +27,7 @@ apply plugin: "com.facebook.react"
2727
apply from: "lint.gradle"
2828

2929
def getExtOrIntegerDefault(name) {
30-
return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReactNativeEnriched_" + name]).toInteger()
30+
return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["ReactNativeEnrichedHtml_" + name]).toInteger()
3131
}
3232

3333
def supportsNamespace() {
@@ -101,6 +101,6 @@ dependencies {
101101

102102
react {
103103
jsRootDir = file("../src/")
104-
libraryName = "ReactNativeEnriched"
104+
libraryName = "ReactNativeEnrichedHtml"
105105
codegenJavaPackageName = "com.swmansion.enriched"
106106
}

android/gradle.properties

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
ReactNativeEnriched_kotlinVersion=2.0.21
2-
ReactNativeEnriched_minSdkVersion=24
3-
ReactNativeEnriched_targetSdkVersion=34
4-
ReactNativeEnriched_compileSdkVersion=35
5-
ReactNativeEnriched_ndkVersion=27.1.12297006
1+
ReactNativeEnrichedHtml_kotlinVersion=2.0.21
2+
ReactNativeEnrichedHtml_minSdkVersion=24
3+
ReactNativeEnrichedHtml_targetSdkVersion=34
4+
ReactNativeEnrichedHtml_compileSdkVersion=35
5+
ReactNativeEnrichedHtml_ndkVersion=27.1.12297006

apps/example-web/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# React Native Enriched Web Example
1+
# React Native Enriched Html Web Example
22

3-
This is a [**Vite**](https://vite.dev) + [**React**](https://react.dev) web example for the React Native Enriched text input component, bootstrapped with Vite's React template.
3+
This is a [**Vite**](https://vite.dev) + [**React**](https://react.dev) web example for the React Native Enriched Html text input component, bootstrapped with Vite's React template.
44

55
# Getting Started
66

apps/example-web/index.html

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,13 @@
11
<!doctype html>
22
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>React Native Enriched Html Web Example</title>
7+
</head>
38

4-
<head>
5-
<meta charset="UTF-8" />
6-
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>React Native Enriched Web Example</title>
8-
</head>
9-
10-
<body>
11-
<div id="root"></div>
12-
<script type="module" src="/src/main.tsx"></script>
13-
</body>
14-
15-
</html>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.tsx"></script>
12+
</body>
13+
</html>

apps/example-web/src/App.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import {
1414
type OnSubmitEditing,
1515
type OnChangeMentionEvent,
1616
type OnMentionDetected,
17-
} from 'react-native-enriched';
17+
} from 'react-native-enriched-html';
1818
import { WEB_DEFAULT_HTML_STYLE } from './defaultHtmlStyle';
1919
import type { NativeSyntheticEvent } from 'react-native';
2020
import { EditorActions } from './components/EditorActions';

0 commit comments

Comments
 (0)