Skip to content

Commit 565a94f

Browse files
artus9033artus9033
committed
chore: fixes after CR
1 parent 23a5e89 commit 565a94f

7 files changed

Lines changed: 33 additions & 22 deletions

File tree

‎docs/docs/docs/api-reference/brownie/getting-started.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@ npx brownfield package:ios --scheme YourScheme --configuration Release
7676
This produces the following in `ios/.brownfield/package/build/`:
7777

7878
- `YourScheme.xcframework` - Your React Native module
79-
- `Brownie.xcframework` - Shared state library
80-
- `ReactBrownfield.xcframework` - Brownfield integration
81-
- `BrownfieldNavigation.xcframework` - Brownfield navigation integration
8279
- `hermesvm.xcframework` - JavaScript engine (or `hermes.xcframework` for RN < 0.82.0)
80+
- `ReactBrownfield.xcframework` - Brownfield integration
81+
- `Brownie.xcframework` - Shared state library (only when using the Brownie package)
82+
- `BrownfieldNavigation.xcframework` - Brownfield navigation integration (only when using the brownfield-navigation package)
8383

8484
The `ios/.brownfield/build/` directory contains the build cache.
8585

‎docs/docs/docs/api-reference/react-native-brownfield/java.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -158,11 +158,12 @@ ReactNativeBrownfield.getShared()
158158

159159
Creates a React Native view with a given module name. It automatically uses an instance of React Native created in `initialize` method. This is useful when embedding React Native views directly in your native layouts.
160160

161-
| Param | Required | Type | Description |
162-
| ------------- | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
163-
| activity | No | `FragmentActivity` | Activity hosting the view, used for lifecycle management. Required for proper lifecycle; may be null only when using a custom `ReactDelegateWrapper`. |
164-
| moduleName | Yes | `String` | Name of React Native component registered to `AppRegistry` |
165-
| launchOptions | No | `Bundle` | Initial properties to be passed to React Native component |
161+
| Param | Required | Type | Description |
162+
| ------------- | -------- | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
163+
| activity | No | `FragmentActivity` | Activity hosting the view, used for lifecycle management. Required for proper lifecycle; may be null only when passing a custom `reactDelegate`. |
164+
| moduleName | Yes | `String` | Name of React Native component registered to `AppRegistry`. |
165+
| launchOptions | No | `Bundle` | Initial properties to be passed to React Native component. |
166+
| reactDelegate | No | `ReactDelegateWrapper` | Optional custom delegate. If passed, the `activity` argument is ignored. |
166167

167168
Returns: `FrameLayout` - A view containing the React Native component.
168169

‎docs/docs/docs/api-reference/react-native-brownfield/javascript.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ ReactNativeBrownfield.popToNative(animated?: boolean);
4242

4343
**Parameters:**
4444

45-
| Param | Type | Description |
46-
| -------- | --------- | --------------------------------------------------------------------------------------- |
47-
| animated | `boolean` | Optional. Whether to animate the transition (iOS only). Defaults to `false` on Android. |
45+
| Param | Type | Description |
46+
| -------- | --------- | ------------------------------------------------------------------------------------------------------ |
47+
| animated | `boolean` | Optional. Whether to animate the transition (iOS only). Defaults to `false`, has no effect on Android. |
4848

4949
**Example:**
5050

‎docs/docs/docs/api-reference/react-native-brownfield/kotlin.mdx‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,12 @@ ReactNativeBrownfield.shared
137137

138138
Creates a React Native view with a given module name. It automatically uses an instance of React Native created in `initialize` method. This is useful when embedding React Native views directly in your native layouts or Jetpack Compose UI.
139139

140-
| Param | Required | Type | Description |
141-
| ------------- | -------- | ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
142-
| activity | No | `FragmentActivity` | Activity hosting the view, used for lifecycle management. Required for proper lifecycle; may be null only when using a custom `ReactDelegateWrapper`. |
143-
| moduleName | Yes | `String` | Name of React Native component registered to `AppRegistry` |
144-
| launchOptions | No | `Bundle` | Initial properties to be passed to React Native component |
140+
| Param | Required | Type | Description |
141+
| ------------- | -------- | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
142+
| activity | No | `FragmentActivity` | Activity hosting the view, used for lifecycle management. Required for proper lifecycle; may be null only when using a custom `reactDelegate`. |
143+
| moduleName | Yes | `String` | Name of React Native component registered to `AppRegistry`. |
144+
| launchOptions | No | `Bundle` | Initial properties to be passed to React Native component. |
145+
| reactDelegate | No | `ReactDelegateWrapper` | Optional custom delegate. If passed, the `activity` argument is ignored. |
145146

146147
Returns: `FrameLayout` - A view containing the React Native component.
147148

‎docs/docs/docs/api-reference/react-native-brownfield/swift.mdx‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,7 @@ func application(
115115
_ application: UIApplication,
116116
didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?
117117
) -> Bool {
118-
ReactNativeBrownfield.shared.application(application, didFinishLaunchingWithOptions: launchOptions)
119-
return true
118+
return ReactNativeBrownfield.shared.application(application, didFinishLaunchingWithOptions: launchOptions)
120119
}
121120
```
122121

‎docs/docs/docs/cli/brownfield.mdx‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,17 @@ The build directory will be placed in the `<iOS project folder>/.brownfield/buil
4242
- `package/build/<scheme name>.xcframework`, e.g. in the `apps/RNApp` demo project, the output will be at `apps/RNApp/ios/.brownfield/package/build/BrownfieldLib.xcframework`.
4343
- `package/build/hermesvm.xcframework` for RN >= 0.82.0 or `package/build/hermes.xcframework` otherwise
4444
- `package/build/ReactBrownfield.xcframework`
45-
- `package/build/BrownfieldNavigation.xcframework`
45+
- `package/build/Brownie.xcframework` (only when using the Brownie package)
46+
- `package/build/BrownfieldNavigation.xcframework` (only when using the Navigation package)
4647

47-
When using Brownie or brownfield-navigation, you will also get `Brownie.xcframework` and/or `BrownfieldNavigation.xcframework` in the same folder. The consumer project needs to embed all required frameworks (at least 3: scheme, Hermes, ReactBrownfield).
48+
The consumer project needs to embed the required frameworks:
49+
50+
- `<scheme name>.xcframework` - Your React Native module
51+
- `hermesvm.xcframework` - JavaScript runtime (or `hermes.xcframework` for RN < 0.82.0)
52+
- `ReactBrownfield.xcframework` - React Native Brownfield library
53+
54+
If you are using the Brownie package, you will also need to embed `Brownie.xcframework`.
55+
If you are using the brownfield-navigation package, you will also need to embed `BrownfieldNavigation.xcframework`.
4856

4957
## Android
5058

‎docs/docs/docs/getting-started/ios.mdx‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,9 +119,11 @@ This creates the XCFramework in **`ios/.brownfield/package/build/`** (relative t
119119

120120
1. Open **`ios/.brownfield/package/build`** directory (relative to your React Native project root)
121121
2. Drag these files into your native iOS app's Xcode project:
122-
- **`hermesvm.xcframework`** - JavaScript runtime
122+
- **`<framework_target_name>.xcframework`** - Your React Native framework
123+
- **`hermesvm.xcframework`** - JavaScript runtime (or `hermes.xcframework` for RN < 0.82.0)
123124
- **`ReactBrownfield.xcframework`** - React Native Brownfield library
124-
- **`<framework_target_name>.xcframework`** - Your framework
125+
- `Brownie.xcframework` - Brownie shared state library (only when using the Brownie package)
126+
- `BrownfieldNavigation.xcframework` - Brownfield navigation integration (only when using the brownfield-navigation package) for React Native navigation
125127

126128
![Frameworks in Xcode Sidebar](/images/frameworks-sidebar.png)
127129

0 commit comments

Comments
 (0)