Skip to content

Commit 8a8c0c4

Browse files
kacperzolkiewskikacperzolkiewski
committed
docs: fix docs review
1 parent 45a4710 commit 8a8c0c4

2 files changed

Lines changed: 41 additions & 38 deletions

File tree

‎docs/INPUT_API_REFERENCE.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88

99
If `true`, the input respects the system's accessibility font scaling settings.
1010

11-
| Type | Default Value | Platform |
12-
| ------ | ------------- | -------- |
13-
| `bool` | `true` | Both |
11+
| Type | Default Value | Platform |
12+
| ------ | ------------- | ------------ |
13+
| `bool` | `true` | iOS, Android |
1414

1515
### `autoFocus`
1616

@@ -119,16 +119,16 @@ A custom regex pattern for detecting links in the input. If not provided, a defa
119119
With this approach you can customize what patterns should be recognized as links, for example you can make it so that only links starting with `https://` are detected, or you can support custom schemes.
120120
Keep in mind that not all JS regex features are supported, for example variable-width lookbehinds won't work.
121121

122-
| Type | Default Value | Platform |
123-
| -------- | ----------------------------- | ----------------- |
124-
| `RegExp` | default native platform regex | iOS, Android, Web |
122+
| Type | Default Value | Platform |
123+
| -------- | ----------------------------- | ------------ |
124+
| `RegExp` | default native platform regex | iOS, Android |
125125

126126
> [!TIP]
127127
> With this approach you can also disable link detection completely by providing a `null` value as the prop.
128128
129129
### `onBlur`
130130

131-
Callback that's called whenever the input loses focused (is blurred).
131+
Callback that's called whenever the input loses focus (is blurred).
132132

133133
| Type | Platform |
134134
| ------------ | ----------------- |
@@ -497,7 +497,7 @@ A React ref that lets you call any ref methods on the input.
497497

498498
### `returnKeyLabel`
499499

500-
Overrides the return key label with a custom string. Not suppported by iOS.
500+
Overrides the return key label with a custom string. Not suppported on iOS.
501501

502502
| Type | Default Value | Platform |
503503
| -------- | ------------- | ------------ |
@@ -712,6 +712,9 @@ Sets text alignment for the paragraph(s) at the current selection. When inside a
712712
> [!NOTE]
713713
> On Android, `'justify'` is not supported. Calling `setTextAlignment('justify')` does not apply justified text — the paragraph ends up with natural alignment, the same as `'auto'`. On iOS, justified alignment works as expected.
714714
715+
> [!NOTE]
716+
> On Web text alignment is not supported. Calling `setTextAlignment()` has no effect.
717+
715718
### `.startMention()`
716719

717720
```ts

‎docs/TEXT_API_REFERENCE.md‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,33 +8,33 @@
88

99
If `true`, the text respects the system's accessibility font scaling settings.
1010

11-
| Type | Default Value | Platform |
12-
| ------ | ------------- | -------- |
13-
| `bool` | `true` | Both |
11+
| Type | Default Value | Platform |
12+
| ------ | ------------- | ------------ |
13+
| `bool` | `true` | iOS, Android |
1414

1515
### `children`
1616

1717
The HTML string to render. Accepts the HTML format produced by `EnrichedTextInput`.
1818

19-
| Type | Default Value | Platform |
20-
| -------- | ------------- | -------- |
21-
| `string` | - | Both |
19+
| Type | Default Value | Platform |
20+
| -------- | ------------- | ------------ |
21+
| `string` | - | iOS, Android |
2222

2323
### `style`
2424

2525
Standard React Native `TextStyle` applied to the text.
2626

27-
| Type | Default Value | Platform |
28-
| ----------- | ------------- | -------- |
29-
| `TextStyle` | - | Both |
27+
| Type | Default Value | Platform |
28+
| ----------- | ------------- | ------------ |
29+
| `TextStyle` | - | iOS, Android |
3030

3131
### `htmlStyle`
3232

3333
A prop for customizing styles of HTML elements, including press colors for interactive elements.
3434

35-
| Type | Default Value | Platform |
36-
| ------------------------------------------------------ | ------------- | -------- |
37-
| [`EnrichedTextHtmlStyle`](#enrichedtexthtmlstyle-type) | - | Both |
35+
| Type | Default Value | Platform |
36+
| ------------------------------------------------------ | ------------- | ------------ |
37+
| [`EnrichedTextHtmlStyle`](#enrichedtexthtmlstyle-type) | - | iOS, Android |
3838

3939
### `useHtmlNormalizer`
4040

@@ -53,9 +53,9 @@ How the text should be truncated when `numberOfLines` is set and the text overfl
5353
- `tail` – truncates at the end, e.g. `abcd...`.
5454
- `clip` – clips the text without inserting an ellipsis.
5555

56-
| Type | Default Value | Platform |
57-
| ---------------------------------------- | ------------- | -------- |
58-
| `'head' \| 'middle' \| 'tail' \| 'clip'` | `'tail'` | Both |
56+
| Type | Default Value | Platform |
57+
| ---------------------------------------- | ------------- | ------------ |
58+
| `'head' \| 'middle' \| 'tail' \| 'clip'` | `'tail'` | iOS, Android |
5959

6060
> [!NOTE]
6161
> On Android, when numberOfLines is set to a value higher than 1, only tail value will work correctly.
@@ -64,25 +64,25 @@ How the text should be truncated when `numberOfLines` is set and the text overfl
6464

6565
Limits the number of displayed lines. Set to `0` for unlimited lines.
6666

67-
| Type | Default Value | Platform |
68-
| -------- | ------------- | -------- |
69-
| `number` | `0` | Both |
67+
| Type | Default Value | Platform |
68+
| -------- | ------------- | ------------ |
69+
| `number` | `0` | iOS, Android |
7070

7171
### `selectable`
7272

7373
If `true`, the text can be selected by the user (e.g. for copy/paste).
7474

75-
| Type | Default Value | Platform |
76-
| ------ | ------------- | -------- |
77-
| `bool` | `false` | Both |
75+
| Type | Default Value | Platform |
76+
| ------ | ------------- | ------------ |
77+
| `bool` | `false` | iOS, Android |
7878

7979
### `selectionColor`
8080

8181
The color of the text selection highlight.
8282

83-
| Type | Default Value | Platform |
84-
| ---------------------------------------------- | -------------- | -------- |
85-
| [`color`](https://reactnative.dev/docs/colors) | system default | Both |
83+
| Type | Default Value | Platform |
84+
| ---------------------------------------------- | -------------- | ------------ |
85+
| [`color`](https://reactnative.dev/docs/colors) | system default | iOS, Android |
8686

8787
### `onLinkPress`
8888

@@ -94,9 +94,9 @@ interface OnLinkPressEvent {
9494
}
9595
```
9696

97-
| Type | Default Value | Platform |
98-
| ----------------------------------- | ------------- | -------- |
99-
| `(event: OnLinkPressEvent) => void` | - | Both |
97+
| Type | Default Value | Platform |
98+
| ----------------------------------- | ------------- | ------------ |
99+
| `(event: OnLinkPressEvent) => void` | - | iOS, Android |
100100

101101
### `onMentionPress`
102102

@@ -110,9 +110,9 @@ interface OnMentionPressEvent {
110110
}
111111
```
112112

113-
| Type | Default Value | Platform |
114-
| -------------------------------------- | ------------- | -------- |
115-
| `(event: OnMentionPressEvent) => void` | - | Both |
113+
| Type | Default Value | Platform |
114+
| -------------------------------------- | ------------- | ------------ |
115+
| `(event: OnMentionPressEvent) => void` | - | iOS, Android |
116116

117117
## EnrichedTextHtmlStyle type
118118

0 commit comments

Comments
 (0)