-
Notifications
You must be signed in to change notification settings - Fork 5
feat: initial version of the docs #8
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,15 +6,115 @@ _Note: JavaScriptCore has been extracted from core react-native as a part of [Le | |
|
||
## Installation | ||
|
||
// TODO | ||
> [!IMPORTANT] | ||
> This library only supports React Native 0.79 and above with new architecture enabled. | ||
|
||
```sh | ||
yarn add @react-native-community/javascriptcore | ||
``` | ||
|
||
### iOS | ||
|
||
Install pods: | ||
|
||
```sh | ||
cd ios && USE_THIRD_PARTY_JSC=1 USE_HERMES=0 bundle exec pod install | ||
``` | ||
> [!NOTE] | ||
> Note: `USE_THIRD_PARTY_JSC=1` is required to use JavaScriptCore from this package until JavaScriptCore is removed from core react-native. | ||
|
||
### Android | ||
|
||
Add the following to your `android/gradle.properties`: | ||
|
||
```properties | ||
# Disable Hermes | ||
hermesEnabled=false | ||
|
||
# Enable third-party JSC | ||
useThirdPartyJSC=true | ||
``` | ||
|
||
## Usage | ||
|
||
// TODO | ||
### iOS | ||
|
||
Open AppDelegate.swift and overwrite `createJSRuntimeFactory` method: | ||
|
||
```swift | ||
import React | ||
import React_RCTAppDelegate | ||
import ReactAppDependencyProvider | ||
import UIKit | ||
import RCTRuntime | ||
|
||
// AppDelegate code | ||
|
||
class ReactNativeDelegate: RCTDefaultReactNativeFactoryDelegate { | ||
override func sourceURL(for bridge: RCTBridge) -> URL? { | ||
self.bundleURL() | ||
} | ||
|
||
override func bundleURL() -> URL? { | ||
#if DEBUG | ||
RCTBundleURLProvider.sharedSettings().jsBundleURL(forBundleRoot: "index") | ||
#else | ||
Bundle.main.url(forResource: "main", withExtension: "jsbundle") | ||
#endif | ||
} | ||
|
||
override func createJSRuntimeFactory() -> JSRuntimeFactory { | ||
jsrt_create_jsc_factory() // Use JavaScriptCore runtime | ||
} | ||
} | ||
``` | ||
|
||
### Android | ||
|
||
Open `MainApplication.java` and overwrite `getJavaScriptExecutorFactory` method: | ||
|
||
```java | ||
import io.github.reactnativecommunity.javascriptcore.JSCExecutorFactory | ||
import io.github.reactnativecommunity.javascriptcore.JSCRuntimeFactory | ||
|
||
class MainApplication : Application(), ReactApplication { | ||
|
||
override val reactNativeHost: ReactNativeHost = | ||
object : DefaultReactNativeHost(this) { | ||
override fun getPackages(): List<ReactPackage> = | ||
PackageList(this).packages.apply { | ||
// Packages that cannot be autolinked yet can be added manually here, for example: | ||
// add(MyReactNativePackage()) | ||
} | ||
|
||
override fun getJSMainModuleName(): String = "index" | ||
|
||
override fun getUseDeveloperSupport(): Boolean = BuildConfig.DEBUG | ||
|
||
override val isNewArchEnabled: Boolean = BuildConfig.IS_NEW_ARCHITECTURE_ENABLED | ||
override val isHermesEnabled: Boolean = BuildConfig.IS_HERMES_ENABLED | ||
|
||
override fun getJavaScriptExecutorFactory(): JavaScriptExecutorFactory = | ||
JSCExecutorFactory(packageName, AndroidInfoHelpers.getFriendlyDeviceName()) | ||
} | ||
|
||
override val reactHost: ReactHost | ||
get() = getDefaultReactHost(applicationContext, reactNativeHost, JSCRuntimeFactory()) | ||
|
||
override fun onCreate() { | ||
super.onCreate() | ||
SoLoader.init(this, OpenSourceMergedSoMapping) | ||
if (BuildConfig.IS_NEW_ARCHITECTURE_ENABLED) { | ||
// If you opted-in for the New Architecture, we load the native entry point for this app. | ||
load() | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## Maintainers | ||
|
||
// TODO | ||
This library is maintained by [Callstack](https://callstack.com/) a Total Software Engineering Consultancy that transforms organizations and teams through transformative apps. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @Kudo you (or Expo to some extend as your participation) want to be mentioned here as well? |
||
|
||
## License | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Having those as
diff
would be helpful though