@callstack/react-native-brownfield 0.0.3 → 0.1.0

package/docs/OBJECTIVE_C.md

@@ -1,150 +0,0 @@
-## Objective-C
-
-React Native Brownfield provides first-class support for Objective-C.
-
-### Linking
-
-The library is meant to work with [auto linking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md). In case you can't use this feature, please check out the following options:
-
-<details>
-<summary>react-native link</summary>
-Run the following command in your terminal:
-
-```bash
-  react-native link @react-native-community/slider
-```
-</details>
-
-<details>
-<summary>CocoaPods</summary>
-Add the following line to your `Podfile`:
-
-```ruby
-  pod 'ReactNativeBrownfield', :path => '../node_modules/@callstack/react-native-brownfield/ios'
-```
-</details>
-
-<details>
-<summary>Manually link the library on iOS</summary>
-
-### `Open project.xcodeproj in Xcode`
-
-Drag `ReactNativeBrownfield.xcodeproj` to your project on Xcode (usually under the Libraries group on Xcode):
-
-![xcode-add](https://facebook.github.io/react-native/docs/assets/AddToLibraries.png)
-
-### Link `libReactNativeBrownfield.a` binary with libraries
-
-Click on your main project file (the one that represents the `.xcodeproj`) select `Build Phases` and drag the static library from the `Products` folder inside the Library you are importing to `Link Binary With Libraries` (or use the `+` sign and choose library from the list):
-
-![xcode-link](https://facebook.github.io/react-native/docs/assets/AddToBuildPhases.png)
-</details>
-
-### API Reference
-
-#### ReactNativeBrownfield
-
-You can import the object from:
-
-```objc
-  #import <ReactNativeBrownfield/ReactNativeBrownfield.h>
-```
-
----
-
-**Statics:**
-
-`shared`
-
-A singleton that keeps an instance of ReactNativeBrownfield object.
-
-Examples:
-
-```objc
-  [ReactNativeBrownfield shared]
-```
-
----
-
-**Properties:**
-
-| Property                   | Type      | Default        | Description                                        |
-| --------------------       | --------- | -------------- | -------------------------------------------------- |
-| bridge                     | RCTBridge | nil            | Launch options, typically passed from AppDelegate. |
-| entryFile                  | NSString  | index          | Path to JavaScript root.                           |
-| fallbackResource           | NSString  | nil            | Path to bundle fallback resource.                  |
-| bundlePath                 | NSString  | main.jsbundle  | Path to bundle fallback resource.                  |
-
----
-
-**Methods:**
-
-`startReactNative`
-
-Starts React Native, produces an instance of a bridge. You can use it to initialize React Native in your app.
-
-Params:
-
-| Param                   | Required | Type          | Description                                           |
-| ----------------------- | -------- | ------------- | ----------------------------------------------------- |
-| onBundleLoaded          | No       | void(^)(void) | Callback invoked after JS bundle is fully loaded.     |
-| launchOptions           | No       | NSDictionary  | Launch options, typically passed from AppDelegate.    |
-
-Examples:
-
-```objc
-    [[ReactNativeBrownfield shared] startReactNative];
-```
-
-```objc
-    [[ReactNativeBrownfield shared] startReactNative:^(void){
-        NSLog(@"React Native started");
-    }];
-```
-
-```objc
-    [[ReactNativeBrownfield shared] startReactNative:^(void){
-        NSLog(@"React Native started");
-    }, launchOptions];
-```
-
----
-
-#### ReactNativeViewController
-
-A view controller that's rendering `RCTRootView` within its bounds. It automatically uses an instance of a bridge created in `startReactNative` method. It works well with exposed JavaScript module. It's the simplest way to embed React Native into your navigation stack.
-
-You can import it from:
-
-```objc
-  #import <ReactNativeBrownfield/ReactNativeViewController.h>
-```
-
----
-
-**Constructors:**
-
-`[ReactNativeViewController initWithModuleName:moduleName andInitialProperties:initialProps]`
-
-| Param              | Required  | Type          | Description                                                   |
-| ------------------ | --------- | ------------- | ------------------------------------------------------------- |
-| moduleName         | Yes       | NSString      | Name of React Native component registered to `AppRegistry`.   |
-| initialProperties  | No        | NSString      | Initial properties to be passed to React Native component.    |
-
-Examples:
-
-```objc
-  [[ReactNativeViewController alloc] initWithModuleName:@"ReactNative"]
-```
-
-```objc
-  [[ReactNativeViewController alloc] initWithModuleName:@"ReactNative" andInitialProperties:@{@"score": 12}]
-```
-
----
-
-### Example
-
-You can find an example app [here](../example/objc).
-
-

package/docs/SWIFT.md

@@ -1,164 +0,0 @@
-## Swift
-
-React Native Brownfield provides first-class support for Swift. 
-
-### `use_frameworks!` support
-
-It is possible to build `react-native-brownfield` with `use_frameworks!` directive in CocoaPods as long as `React` can be built this way.
-
-| React Native version       | `use_frameworks!` compatibility |
-| -------------------------- | ------------------------------- | 
-| <= 0.59.X                  | Compatible                      |
-| 0.60.X                     | Not compatible                  |
-| 0.61.0-rc.0                | Not compatible                  |
-
-Please reffer to [this issue](https://github.com/facebook/react-native/issues/25349) to learn more about `use_frameworks!` state in React Native.
-
-Until this behavior is fixed, you can access `react-native-brownfield` API in Swift via [Bridging Header](../example/swift/BridgingHeader.h).
-
-### Linking
-
-The library is meant to work with [auto linking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md). In case you can't use this feature, please check out the following options:
-
-<details>
-<summary>react-native link</summary>
-Run the following command in your terminal:
-
-```bash
-  react-native link @react-native-community/slider
-```
-</details>
-
-<details>
-<summary>CocoaPods</summary>
-Add the following line to your `Podfile`:
-
-```ruby
-  pod 'ReactNativeBrownfield', :path => '../node_modules/@callstack/react-native-brownfield/ios'
-```
-</details>
-
-<details>
-<summary>Manually link the library on iOS</summary>
-
-### `Open project.xcodeproj in Xcode`
-
-Drag `ReactNativeBrownfield.xcodeproj` to your project on Xcode (usually under the Libraries group on Xcode):
-
-![xcode-add](https://facebook.github.io/react-native/docs/assets/AddToLibraries.png)
-
-### Link `libReactNativeBrownfield.a` binary with libraries
-
-Click on your main project file (the one that represents the `.xcodeproj`) select `Build Phases` and drag the static library from the `Products` folder inside the Library you are importing to `Link Binary With Libraries` (or use the `+` sign and choose library from the list):
-
-![xcode-link](https://facebook.github.io/react-native/docs/assets/AddToBuildPhases.png)
-</details>
-
-### API Reference
-
-#### ReactNativeBrownfield
-
-You can import the object from:
-
-```swift
-  import ReactNativeBrownfield
-```
-
----
-
-**Statics:**
-
-`shared()`
-
-A singleton that keeps an instance of ReactNativeBrownfield object.
-
-Examples:
-
-```swift
-  ReactNativeBrownfield.shared()
-```
-
----
-
-**Properties:**
-
-| Property                   | Type      | Default        | Description                                        |
-| --------------------       | --------- | -------------- | -------------------------------------------------- |
-| bridge                     | RCTBridge | nil            | Launch options, typically passed from AppDelegate. |
-| entryFile                  | NSString  | index          | Path to JavaScript root.                           |
-| fallbackResource           | NSString  | nil            | Path to bundle fallback resource.                  |
-| bundlePath                 | NSString  | main.jsbundle  | Path to bundle fallback resource.                  |
-
----
-
-**Methods:**
-
-`startReactNative`
-
-Starts React Native, produces an instance of a bridge. You can use it to initialize React Native in your app.
-
-Params:
-
-| Param                   | Required | Type          | Description                                           |
-| ----------------------- | -------- | ------------- | ----------------------------------------------------- |
-| onBundleLoaded          | No       | () -> void | Callback invoked after JS bundle is fully loaded.     |
-| launchOptions           | No       | NSDictionary  | Launch options, typically passed from AppDelegate.    |
-
-Examples:
-
-```swift
-    ReactNativeBrownfield.shared().startReactNative()
-```
-
-```swift
-   ReactNativeBrownfield.shared().startReactNative {
-     print("React Native started")
-   }
-```
-
-```swift
-    ReactNativeBrownfield.shared().startReactNative({
-      print("React Native started")
-    }, launchOptions)
-```
-
----
-
-#### ReactNativeViewController
-
-A view controller that's rendering `RCTRootView` within its bounds. It automatically uses an instance of a bridge created in `startReactNative` method. It works well with exposed JavaScript module. It's the simplest way to embed React Native into your navigation stack.
-
-You can import it from:
-
-```swift
-  import ReactNativeBrownfield
-```
-
----
-
-**Constructors:**
-
-`ReactNativeViewController(moduleName: moduleName, initialProperites:initialProperties)`
-
-| Param              | Required  | Type          | Description                                                   |
-| ------------------ | --------- | ------------- | ------------------------------------------------------------- |
-| moduleName         | Yes       | NSString      | Name of React Native component registered to `AppRegistry`.   |
-| initialProperties  | No        | NSString      | Initial properties to be passed to React Native component.    |
-
-Examples:
-
-```swift
-  ReactNativeViewController(moduleName: "ReactNative")
-```
-
-```swift
-  ReactNativeViewController(moduleName: "ReactNative", initialProperites:["score": 12])
-```
-
----
-
-### Example
-
-You can find an example app [here](../example/swift).
-
-

package/prettier.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  singleQuote: true,
-  trailingComma: 'all',
-  bracketSpacing: false,
-  jsxBracketSameLine: true,
-  parser: 'flow',
-};

package/react-native.config.js

@@ -1,9 +0,0 @@
-const root = process.cwd();
-
-module.exports = {
-  dependencies: {
-    'react-native-brownfield': {
-      root,
-    },
-  },
-};

package/types/index.d.ts

@@ -1,11 +0,0 @@
-declare module 'react-native-brownfield' {
-  /**
-   * A method to pop to native screen used to push React Native experience.
-   */
-  export function popToNative(animated?: boolean): void;
-
-  /**
-   * A method used to toggle iOS native back gesture and Android hardware back button.
-   */
-  export function setNativeGesturesAndButtonsEnabled(enabled: boolean): void;
-}