Skip to content

Commit 210fc8b

Browse files
inokawainokawa
committed
0.26.3
1 parent f68d9e7 commit 210fc8b

14 files changed

+213
-238
lines changed

‎docs/API.md‎

Lines changed: 13 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -1,159 +1,25 @@
1-
# API
1+
**API** • **Docs**
22

3-
## Table of contents
3+
***
44

5-
### Functions
5+
# API
66

7-
- [RichTextarea](API.md#richtextarea)
8-
- [experimental\_RichInput](API.md#experimental_richinput)
9-
- [createRegexRenderer](API.md#createregexrenderer)
10-
- [createCSSCustomHighlightRenderer](API.md#createcsscustomhighlightrenderer)
7+
## Functions
118

12-
### Interfaces
9+
- [RichTextarea](functions/RichTextarea.md)
10+
- [experimental\_RichInput](functions/experimental_RichInput.md)
11+
- [createRegexRenderer](functions/createRegexRenderer.md)
12+
- [createCSSCustomHighlightRenderer](functions/createCSSCustomHighlightRenderer.md)
13+
14+
## Interfaces
1315

1416
- [RichTextareaProps](interfaces/RichTextareaProps.md)
1517
- [RichTextareaHandle](interfaces/RichTextareaHandle.md)
1618
- [RichInputProps](interfaces/RichInputProps.md)
1719
- [RichInputHandle](interfaces/RichInputHandle.md)
1820

19-
### Type Aliases
20-
21-
- [StyleOrRender](API.md#styleorrender)
22-
- [Renderer](API.md#renderer)
23-
- [CaretPosition](API.md#caretposition)
24-
25-
## Functions
26-
27-
### RichTextarea
28-
29-
▸ **RichTextarea**(`props`): `ReactNode`
30-
31-
Textarea component with some extra props. See [RichTextareaProps](interfaces/RichTextareaProps.md) and [RichTextareaHandle](interfaces/RichTextareaHandle.md).
32-
33-
#### Parameters
34-
35-
| Name | Type |
36-
| :------ | :------ |
37-
| `props` | `Omit`<[`RichTextareaProps`](interfaces/RichTextareaProps.md), ``"ref"``\> & `RefAttributes`<[`RichTextareaHandle`](interfaces/RichTextareaHandle.md)\> |
38-
39-
#### Returns
40-
41-
`ReactNode`
42-
43-
#### Defined in
44-
45-
[src/textarea.tsx:128](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/textarea.tsx#L128)
46-
47-
___
48-
49-
### experimental\_RichInput
50-
51-
▸ **experimental_RichInput**(`props`): `ReactNode`
52-
53-
Input component with some extra props. See [RichInputProps](interfaces/RichInputProps.md) and [RichInputHandle](interfaces/RichInputHandle.md).
54-
55-
**NOTE: This component is experimental one so it may have some bugs.**
56-
57-
#### Parameters
58-
59-
| Name | Type |
60-
| :------ | :------ |
61-
| `props` | `Omit`<[`RichInputProps`](interfaces/RichInputProps.md), ``"ref"``\> & `RefAttributes`<[`RichInputHandle`](interfaces/RichInputHandle.md)\> |
62-
63-
#### Returns
64-
65-
`ReactNode`
66-
67-
#### Defined in
68-
69-
[src/input.tsx:138](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/input.tsx#L138)
70-
71-
___
72-
73-
### createRegexRenderer
74-
75-
▸ **createRegexRenderer**(`matchers`): [`Renderer`](API.md#renderer)
76-
77-
An utility to create renderer function with regex.
78-
79-
The priority is descending order.
80-
81-
#### Parameters
82-
83-
| Name | Type |
84-
| :------ | :------ |
85-
| `matchers` | ([regex: RegExp, style: StyleOrRender] \| [regex: RegExp, style: StyleOrRender, shouldRender?: Function])[] |
86-
87-
#### Returns
88-
89-
[`Renderer`](API.md#renderer)
90-
91-
#### Defined in
92-
93-
[src/renderers/regex/index.tsx:19](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/renderers/regex/index.tsx#L19)
94-
95-
___
96-
97-
### createCSSCustomHighlightRenderer
98-
99-
▸ **createCSSCustomHighlightRenderer**(`matchers`): [`Renderer`](API.md#renderer)
100-
101-
[createRegexRenderer](API.md#createregexrenderer) but rendered with [CSS Custom Highlight API](https://developer.mozilla.org/en-US/docs/Web/API/CSS_Custom_Highlight_API).
102-
103-
#### Parameters
104-
105-
| Name | Type |
106-
| :------ | :------ |
107-
| `matchers` | [regex: RegExp, style: string][] |
108-
109-
#### Returns
110-
111-
[`Renderer`](API.md#renderer)
112-
113-
#### Defined in
114-
115-
[src/renderers/regex/index.tsx:166](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/renderers/regex/index.tsx#L166)
116-
11721
## Type Aliases
11822

119-
### StyleOrRender
120-
121-
Ƭ **StyleOrRender**: `React.CSSProperties` \| (`props`: { `children`: `React.ReactNode` ; `value`: `string` ; `key?`: `string` }) => `React.ReactNode`
122-
123-
#### Defined in
124-
125-
[src/renderers/regex/index.tsx:6](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/renderers/regex/index.tsx#L6)
126-
127-
___
128-
129-
### Renderer
130-
131-
Ƭ **Renderer**: (`value`: `string`) => `React.ReactNode`
132-
133-
#### Type declaration
134-
135-
▸ (`value`): `React.ReactNode`
136-
137-
##### Parameters
138-
139-
| Name | Type |
140-
| :------ | :------ |
141-
| `value` | `string` |
142-
143-
##### Returns
144-
145-
`React.ReactNode`
146-
147-
#### Defined in
148-
149-
[src/types.ts:1](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/types.ts#L1)
150-
151-
___
152-
153-
### CaretPosition
154-
155-
Ƭ **CaretPosition**: { `focused`: ``false`` ; `selectionStart`: `number` ; `selectionEnd`: `number` } \| { `focused`: ``true`` ; `selectionStart`: `number` ; `selectionEnd`: `number` ; `top`: `number` ; `left`: `number` ; `height`: `number` }
156-
157-
#### Defined in
158-
159-
[src/types.ts:3](https://github.com/inokawa/rich-textarea/blob/dc63a9fde91f2e2855d6240be87ca131d128cc23/src/types.ts#L3)
23+
- [StyleOrRender](type-aliases/StyleOrRender.md)
24+
- [Renderer](type-aliases/Renderer.md)
25+
- [CaretPosition](type-aliases/CaretPosition.md)

‎docs/functions/RichTextarea.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[**API**](../API.md) • **Docs**
2+
3+
***
4+
5+
# Function: RichTextarea()
6+
7+
> **RichTextarea**(`props`): `ReactNode`
8+
9+
Textarea component with some extra props. See [RichTextareaProps](../interfaces/RichTextareaProps.md) and [RichTextareaHandle](../interfaces/RichTextareaHandle.md).
10+
11+
## Parameters
12+
13+
• **props**: `Omit`\<[`RichTextareaProps`](../interfaces/RichTextareaProps.md), `"ref"`\> & `RefAttributes`\<[`RichTextareaHandle`](../interfaces/RichTextareaHandle.md)\>
14+
15+
## Returns
16+
17+
`ReactNode`
18+
19+
## Defined in
20+
21+
[src/textarea.tsx:128](https://github.com/inokawa/rich-textarea/blob/f68d9e7ccb43f4a3c1bc208fe5bee1c78fa77f0e/src/textarea.tsx#L128)

‎docs/functions/createCSSCustomHighlightRenderer.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
[**API**](../API.md) • **Docs**
2+
3+
***
4+
5+
# Function: createCSSCustomHighlightRenderer()
6+
7+
> **createCSSCustomHighlightRenderer**(`matchers`): [`Renderer`](../type-aliases/Renderer.md)
8+
9+
**`Experimental`**
10+
11+
## Parameters
12+
13+
• **matchers**: [`RegExp`, `string`][]
14+
15+
## Returns
16+
17+
[`Renderer`](../type-aliases/Renderer.md)
18+
19+
## Defined in
20+
21+
[src/renderers/regex/index.tsx:166](https://github.com/inokawa/rich-textarea/blob/f68d9e7ccb43f4a3c1bc208fe5bee1c78fa77f0e/src/renderers/regex/index.tsx#L166)

‎docs/functions/createRegexRenderer.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[**API**](../API.md) • **Docs**
2+
3+
***
4+
5+
# Function: createRegexRenderer()
6+
7+
> **createRegexRenderer**(`matchers`): [`Renderer`](../type-aliases/Renderer.md)
8+
9+
An utility to create renderer function with regex.
10+
11+
The priority is descending order.
12+
13+
## Parameters
14+
15+
• **matchers**: ([`RegExp`, [`StyleOrRender`](../type-aliases/StyleOrRender.md)] \| [`RegExp`, [`StyleOrRender`](../type-aliases/StyleOrRender.md), (`matchedText`, `matchResult`) => `boolean`])[]
16+
17+
## Returns
18+
19+
[`Renderer`](../type-aliases/Renderer.md)
20+
21+
## Defined in
22+
23+
[src/renderers/regex/index.tsx:19](https://github.com/inokawa/rich-textarea/blob/f68d9e7ccb43f4a3c1bc208fe5bee1c78fa77f0e/src/renderers/regex/index.tsx#L19)

‎docs/functions/experimental_RichInput.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[**API**](../API.md) • **Docs**
2+
3+
***
4+
5+
# Function: experimental\_RichInput()
6+
7+
> **experimental\_RichInput**(`props`): `ReactNode`
8+
9+
Input component with some extra props. See [RichInputProps](../interfaces/RichInputProps.md) and [RichInputHandle](../interfaces/RichInputHandle.md).
10+
11+
**NOTE: This component is experimental one so it may have some bugs.**
12+
13+
## Parameters
14+
15+
• **props**: `Omit`\<[`RichInputProps`](../interfaces/RichInputProps.md), `"ref"`\> & `RefAttributes`\<[`RichInputHandle`](../interfaces/RichInputHandle.md)\>
16+
17+
## Returns
18+
19+
`ReactNode`
20+
21+
## Defined in
22+
23+
[src/input.tsx:138](https://github.com/inokawa/rich-textarea/blob/f68d9e7ccb43f4a3c1bc208fe5bee1c78fa77f0e/src/input.tsx#L138)

‎docs/interfaces/RichInputHandle.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
[**API**](../API.md) • **Docs**
2+
3+
***
4+
15
# Interface: RichInputHandle
26

3-
Methods of [RichInput](../API.md#experimental_richinput).
7+
Methods of [RichInput](../functions/experimental_RichInput.md).
48

59
All the others not mentioned are proxied to ref of [input](https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement).
610

@@ -10,8 +14,6 @@ All the others not mentioned are proxied to ref of [input](https://developer.moz
1014
| selectionEnd | `number` | Same as original but has handling of composition event |
1115
| setRangeText | | Same as original but has fallback to `document.execCommand("insertText")` |
1216

13-
## Hierarchy
17+
## Extends
1418

1519
- `HTMLInputElement`
16-
17-
↳ **`RichInputHandle`**

0 commit comments

Comments
 (0)