Skip to content

Latest commit

 

History

History
118 lines (82 loc) · 7 KB

README.md

File metadata and controls

118 lines (82 loc) · 7 KB
Raw

React Native Brownfield

Set of helpers to make your brownfield integration smooth and easy.

Build Status Version MIT License

PRs Welcome Chat Code of Conduct Sponsored by Callstack

tweet

Features

  • Easily integrate React Native with existing native app
  • Start React Native with one method and invoke code as soon as it's loaded
  • Reuse the same instance of React Native bridge between different components
  • Use predefined native building blocks - crafted for React Native
  • Disable and enable native gestures and hardware buttons from JavaScript
  • Works well with any native navigation pattern, as well as every React Native JavaScript based navigation
  • Compatible with all native languages Objective-C, Swift, Java and Kotlin

Installation

npm install @callstack/react-native-brownfield

or

yarn add @callstack/react-native-brownfield

Usage

React Native Brownfield library works with all major native programming languages. Majority of its API is exposed on the native side. Click on the logo to choose the one that interests you:

Objective-C
Objective-C		 Swift
Swift		 Java
Java		 Kotlin
Kotlin

JavaScript Module

Besides native components, we are exposing JavaScript functions to control the behavior of those components.

To use the module, simply import it:

import ReactNativeBrownfield from '@callstack/react-native-brownfield';

JavaScript API Reference:

setNativeBackGestureAndButtonEnabled(enabled: boolean)

A method used to toggle iOS native back gesture and Android hardware back button.

ReactNativeBrownfield.setNativeBackGestureAndButtonEnabled(true);

popToNative(animated[iOS only]: boolean)

A method to pop to native screen used to push React Native experience.

ReactNativeBrownfield.popToNative(true);

NOTE: Those methods works only with native components provided by this library.

Made with ❤️ at Callstack

React Native Brownfield is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. Callstack is a group of React and React Native geeks, contact us at [email protected] if you need any help with these or just want to say hi!

Like the project? ⚛️ Join the team who does amazing stuff for clients and drives React Native Open Source! 🔥

Contributors

Thanks goes to these wonderful people (emoji key):

Michał Chudziak
Michał Chudziak
💻 📖 🤔		 Piotr Drapich
Piotr Drapich
💻 🤔

This project follows the all-contributors specification. Contributions of any kind welcome!