Skip to content

Commit eefe9fd

Browse files
inokawainokawa
committed
0.12.0
1 parent 6e88c7a commit eefe9fd

File tree

8 files changed

+139
-48
lines changed

8 files changed

+139
-48
lines changed

‎docs/interfaces/index.ReactNativeMessage.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Interface: ReactNativeMessage\<T\>
2+
3+
[index](../modules/index.md).ReactNativeMessage
4+
5+
## Type parameters
6+
7+
| Name |
8+
| :------ |
9+
| `T` |
10+
11+
## Table of contents
12+
13+
### Properties
14+
15+
- [type](index.ReactNativeMessage.md#type)
16+
- [data](index.ReactNativeMessage.md#data)
17+
18+
## Properties
19+
20+
### type
21+
22+
• **type**: `string`
23+
24+
#### Defined in
25+
26+
[src/types.ts:7](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/types.ts#L7)
27+
28+
___
29+
30+
### data
31+
32+
• **data**: `T`
33+
34+
#### Defined in
35+
36+
[src/types.ts:8](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/types.ts#L8)

‎docs/interfaces/index.WebViewMessage.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Interface: WebViewMessage\<T\>
2+
3+
[index](../modules/index.md).WebViewMessage
4+
5+
## Type parameters
6+
7+
| Name |
8+
| :------ |
9+
| `T` |
10+
11+
## Table of contents
12+
13+
### Properties
14+
15+
- [type](index.WebViewMessage.md#type)
16+
- [data](index.WebViewMessage.md#data)
17+
18+
## Properties
19+
20+
### type
21+
22+
• **type**: `string`
23+
24+
#### Defined in
25+
26+
[src/types.ts:2](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/types.ts#L2)
27+
28+
___
29+
30+
### data
31+
32+
• **data**: `T`
33+
34+
#### Defined in
35+
36+
[src/types.ts:3](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/types.ts#L3)

‎docs/modules/index.md‎

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,18 @@ Modules for React Native
88

99
- [useWebViewMessage](index.md#usewebviewmessage)
1010

11-
### Type Aliases
11+
### Interfaces
1212

13-
- [Message](index.md#message)
13+
- [ReactNativeMessage](../interfaces/index.ReactNativeMessage.md)
14+
- [WebViewMessage](../interfaces/index.WebViewMessage.md)
1415

1516
## Functions
1617

1718
### useWebViewMessage
1819

19-
▸ **useWebViewMessage**<`T`\>(`onSubscribe`): `Object`
20+
▸ **useWebViewMessage**\<`T`\>(`onSubscribe`): `Object`
21+
22+
A hook to subscribe messages from WebView.
2023

2124
#### Type parameters
2225

@@ -28,41 +31,18 @@ Modules for React Native
2831

2932
| Name | Type |
3033
| :------ | :------ |
31-
| `onSubscribe` | (`message`: [`Message`](index.md#message)<`T`\>) => `void` |
34+
| `onSubscribe` | (`message`: [`WebViewMessage`](../interfaces/index.WebViewMessage.md)\<`T`\>) => `void` |
3235

3336
#### Returns
3437

3538
`Object`
3639

3740
| Name | Type |
3841
| :------ | :------ |
39-
| `ref` | `RefObject`<`WebView`<{}\>\> |
42+
| `ref` | `RefObject`\<`WebView`\<{}\>\> |
4043
| `onMessage` | (`event`: `WebViewMessageEvent`) => `void` |
41-
| `emit` | (`message`: [`Message`](index.md#message)<`T`\>) => `void` |
42-
43-
#### Defined in
44-
45-
[src/hooks.ts:7](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/hooks.ts#L7)
46-
47-
## Type Aliases
48-
49-
### Message
50-
51-
Ƭ **Message**<`T`\>: `Object`
52-
53-
#### Type parameters
54-
55-
| Name |
56-
| :------ |
57-
| `T` |
58-
59-
#### Type declaration
60-
61-
| Name | Type |
62-
| :------ | :------ |
63-
| `type` | `string` |
64-
| `data` | `T` |
44+
| `emit` | (`message`: [`ReactNativeMessage`](../interfaces/index.ReactNativeMessage.md)\<`T`\>) => `void` |
6545

6646
#### Defined in
6747

68-
[src/types.ts:1](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/types.ts#L1)
48+
[src/native/index.ts:28](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/native/index.ts#L28)

‎docs/modules/plugin.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Custom babelTransformer for metro bundler
1212

1313
### transform
1414

15-
▸ **transform**(`args`): `Promise`<`any`\>
15+
▸ **transform**(`args`): `Promise`\<`any`\>
1616

1717
#### Parameters
1818

@@ -22,8 +22,8 @@ Custom babelTransformer for metro bundler
2222

2323
#### Returns
2424

25-
`Promise`<`any`\>
25+
`Promise`\<`any`\>
2626

2727
#### Defined in
2828

29-
[src/plugin/index.js:11](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/plugin/index.js#L11)
29+
[src/plugin/index.ts:34](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/plugin/index.ts#L34)

‎docs/modules/web_preact.md‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ Modules for Preact
1919

2020
▸ **webViewRender**(`root`): `string`
2121

22+
The entry point of web file
23+
24+
This statement is detected by babelTransformer as an entry point
25+
All dependencies are resolved, compressed and stringified into one file
26+
2227
#### Parameters
2328

2429
| Name | Type |
@@ -31,13 +36,15 @@ Modules for Preact
3136

3237
#### Defined in
3338

34-
[src/web/core.ts:5](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/web/core.ts#L5)
39+
[src/web/preact.ts:17](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/preact.ts#L17)
3540

3641
___
3742

3843
### useNativeMessage
3944

40-
▸ **useNativeMessage**<`T`\>(`onSubscribe`): `void`
45+
▸ **useNativeMessage**\<`T`\>(`onSubscribe`): `void`
46+
47+
A hook to subscribe messages from React Native.
4148

4249
#### Type parameters
4350

@@ -49,15 +56,15 @@ ___
4956

5057
| Name | Type |
5158
| :------ | :------ |
52-
| `onSubscribe` | (`message`: [`Message`](index.md#message)<`T`\>) => `void` |
59+
| `onSubscribe` | (`message`: [`ReactNativeMessage`](../interfaces/index.ReactNativeMessage.md)\<`T`\>) => `void` |
5360

5461
#### Returns
5562

5663
`void`
5764

5865
#### Defined in
5966

60-
[src/web/core.ts:18](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/web/core.ts#L18)
67+
[src/web/preact.ts:25](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/preact.ts#L25)
6168

6269
## References
6370

‎docs/modules/web_react.md‎

Lines changed: 40 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Modules for React DOM
77
### Functions
88

99
- [webViewRender](web_react.md#webviewrender)
10+
- [webViewCreateRoot](web_react.md#webviewcreateroot)
1011
- [useNativeMessage](web_react.md#usenativemessage)
1112
- [emit](web_react.md#emit)
1213

@@ -16,25 +17,54 @@ Modules for React DOM
1617

1718
▸ **webViewRender**(`root`): `string`
1819

20+
The entry point of web file
21+
22+
This statement is detected by babelTransformer as an entry point
23+
All dependencies are resolved, compressed and stringified into one file
24+
1925
#### Parameters
2026

2127
| Name | Type |
2228
| :------ | :------ |
23-
| `root` | `ReactNode` |
29+
| `root` | `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> |
2430

2531
#### Returns
2632

2733
`string`
2834

2935
#### Defined in
3036

31-
[src/web/core.ts:5](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/web/core.ts#L5)
37+
[src/web/react.ts:18](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/react.ts#L18)
38+
39+
___
40+
41+
### webViewCreateRoot
42+
43+
▸ **webViewCreateRoot**(`root`): `string`
44+
45+
[webViewRender](web_react.md#webviewrender) but initiated with React's createRoot
46+
47+
#### Parameters
48+
49+
| Name | Type |
50+
| :------ | :------ |
51+
| `root` | `ReactElement`\<`any`, `string` \| `JSXElementConstructor`\<`any`\>\> |
52+
53+
#### Returns
54+
55+
`string`
56+
57+
#### Defined in
58+
59+
[src/web/react.ts:26](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/react.ts#L26)
3260

3361
___
3462

3563
### useNativeMessage
3664

37-
▸ **useNativeMessage**<`T`\>(`onSubscribe`): `void`
65+
▸ **useNativeMessage**\<`T`\>(`onSubscribe`): `void`
66+
67+
A hook to subscribe messages from React Native.
3868

3969
#### Type parameters
4070

@@ -46,21 +76,23 @@ ___
4676

4777
| Name | Type |
4878
| :------ | :------ |
49-
| `onSubscribe` | (`message`: [`Message`](index.md#message)<`T`\>) => `void` |
79+
| `onSubscribe` | (`message`: [`ReactNativeMessage`](../interfaces/index.ReactNativeMessage.md)\<`T`\>) => `void` |
5080

5181
#### Returns
5282

5383
`void`
5484

5585
#### Defined in
5686

57-
[src/web/core.ts:18](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/web/core.ts#L18)
87+
[src/web/react.ts:34](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/react.ts#L34)
5888

5989
___
6090

6191
### emit
6292

63-
▸ **emit**<`T`\>(`message`): `void`
93+
▸ **emit**\<`T`\>(`message`): `void`
94+
95+
A function to send a message to React Native
6496

6597
#### Type parameters
6698

@@ -72,12 +104,12 @@ ___
72104

73105
| Name | Type |
74106
| :------ | :------ |
75-
| `message` | [`Message`](index.md#message)<`T`\> |
107+
| `message` | [`WebViewMessage`](../interfaces/index.WebViewMessage.md)\<`T`\> |
76108

77109
#### Returns
78110

79111
`void`
80112

81113
#### Defined in
82114

83-
[src/web/core.ts:11](https://github.com/inokawa/react-native-react-bridge/blob/2039b21/src/web/core.ts#L11)
115+
[src/web/core.ts:13](https://github.com/inokawa/react-native-react-bridge/blob/6e88c7aaeb2065facab677943b1589e38f6c4a47/src/web/core.ts#L13)

‎package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-react-bridge",
3-
"version": "0.11.2",
3+
"version": "0.12.0",
44
"description": "An easy way to integrate your React (or Preact/React Native Web) app into React Native app with WebView.",
55
"main": "lib/index.js",
66
"module": "lib/index.mjs",

0 commit comments

Comments
 (0)