Skip to content

Latest commit

 

History

History
102 lines (73 loc) · 2.94 KB

README.md

File metadata and controls

102 lines (73 loc) · 2.94 KB
Raw

How to use this template

  • ⚠️ Don't fork this repository. Use the "Use this template" green GitHub button.

  • Put your bindings in src/ReactNativeXxxxxxxxxx & rename accordingly or use bsconfig.json "namespace" field (more on this below),

  • Update all occurences of

    • @rescript-react-native/__template__
    • https://github.com/rescript-react-native/__template__
    • __template__
    • react-native-XXXXXXXXXX
    • https://github.com/OWNER/react-native-XXXXXXXXXX
    • ReactNativeXxxxxxxxxx. If you have more than a file exposed, you should consider using ReScript custom namespace by adjusting bsconfig.json and adding a "namespace": "react-native-something" (note that it will be converted to ReactNativeXxxxxxxxxx)

  • Add your react-native-XXXXXXXXXX (adjusted) in peerDependencies & devDependencies section

  • Adjust the changelog (and/or clean it)

  • Remove this part ⬆ & keep everything below ⬇

@rescript-react-native/__template__

Build Status Version ReScript Forum

ReScript bindings for react-native-XXXXXXXXXX.

Exposed as ReactNativeXxxxxxxxxx module.

@rescript-react-native/__template__ X.y.* means it's compatible with react-native-XXXXXXXXXX X.y.*

Installation

When react-native-XXXXXXXXXX is properly installed & configured by following their installation instructions, you can install the bindings:

npm install @rescript-react-native/__template__
# or
yarn add @rescript-react-native/__template__

@rescript-react-native/__template__ should be added to bs-dependencies in your bsconfig.json:

{
  //...
  "bs-dependencies": [
    "@rescript/react",
    "rescript-react-native",
    // ...
+    "@rescript-react-native/__template__"
  ],
  //...
}

Usage

Types

ReactNativeXxxxxxxxxx.t

...

Methods

ReactNativeXxxxxxxxxx.method

...

Changelog

Check the changelog for more informations about recent releases.

Contribute

Read the contribution guidelines before contributing.

Code of Conduct

We want this community to be friendly and respectful to each other. Please read our full code of conduct so that you can understand what actions will and will not be tolerated.