Skip to content

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 1 commit into from
Feb 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 103 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

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

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.
Copy link
Member

Choose a reason for hiding this comment

The 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

Expand Down