Skip to content

Commit

Permalink
[RN][NewArch] Add danger block for C++ TurboModule (#4402)
Browse files Browse the repository at this point in the history
  • Loading branch information
cipolleschi authored Dec 20, 2024
1 parent 3125a70 commit a94002d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/the-new-architecture/pure-cxx-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ The rest of this guide assume that you have created your application running the
npx @react-native-community/cli@latest init SampleApp --version 0.76.0
```

:::danger
We are aware of some issues that are preventing pure C++ Modules to work well on Android, when developed locally in the app.
Pure C++ modules consumed as external libraries works well on Android.

These issues started from version 0.76.2 and are still persisting in version 0.76.5.

We found the root cause for the issue (see [#48298](https://github.com/facebook/react-native/issues/48298) and [#48340](https://github.com/facebook/react-native/pull/48340)), and we are aiming to fix in 0.76.6.
:::

## 1. Create the JS specs

Pure C++ Turbo Native Modules are Turbo Native Modules. They need a specification file (also called spec file) so that Codegen can create the scaffolding code for us. The specification file is also what we use to access the Turbo Native Module in JS.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ The rest of this guide assume that you have created your application running the
npx @react-native-community/cli@latest init SampleApp --version 0.76.0
```

:::danger
We are aware of some issues that are preventing pure C++ Modules to work well on Android, when developed locally in the app.
Pure C++ modules consumed as external libraries works well on Android.

These issues started from version 0.76.2 and are still persisting in version 0.76.5.

We found the root cause for the issue (see [#48298](https://github.com/facebook/react-native/issues/48298) and [#48340](https://github.com/facebook/react-native/pull/48340)), and we are aiming to fix in 0.76.6.
:::

## 1. Create the JS specs

Pure C++ Turbo Native Modules are Turbo Native Modules. They needs a specification file (also called spec file) so that Codegen can create the scaffolding code for us. The specification file is also what we use to access the Turbo Native Module in JS.
Expand Down

0 comments on commit a94002d

Please sign in to comment.