https://github.com/rescript-react-native/__template__
ReScript bindings for ORIGINAL_PACKAGE_NAME
https://github.com/rescript-react-native/__template__
react react-native rescript rescript-react rescript-react-native
Last synced: 2 months ago
JSON representation
ReScript bindings for ORIGINAL_PACKAGE_NAME
- Host: GitHub
- URL: https://github.com/rescript-react-native/__template__
- Owner: rescript-react-native
- License: mit
- Created: 2019-09-04T05:16:33.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2023-04-25T07:39:21.000Z (about 2 years ago)
- Last Synced: 2025-04-13T12:08:50.375Z (2 months ago)
- Topics: react, react-native, rescript, rescript-react, rescript-react-native
- Language: JavaScript
- Homepage:
- Size: 236 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## 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__`
[](https://github.com/rescript-react-native/__template__/actions)
[](https://www.npmjs.com/@rescript-react-native/__template__)
[](https://forum.rescript-lang.org/)
[ReScript](https://rescript-lang.org) bindings for
[`react-native-XXXXXXXXXX`](https://github.com/OWNER/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`](https://github.com/OWNER/react-native-XXXXXXXXXX)
is properly installed & configured by following their installation instructions,
you can install the bindings:
```console
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`:
```diff
{
//...
"bs-dependencies": [
"@rescript/react",
"rescript-react-native",
// ...
+ "@rescript-react-native/__template__"
],
//...
}
```
## Usage
### Types
#### `ReactNativeXxxxxxxxxx.t`
...
### Methods
#### `ReactNativeXxxxxxxxxx.method`
...
---
## Changelog
Check the [changelog](./CHANGELOG.md) for more informations about recent
releases.
---
## Contribute
Read the
[contribution guidelines](https://github.com/rescript-react-native/.github/blob/master/CONTRIBUTING.md)
before contributing.
## Code of Conduct
We want this community to be friendly and respectful to each other. Please read
[our full code of conduct](https://github.com/rescript-react-native/.github/blob/master/CODE_OF_CONDUCT.md)
so that you can understand what actions will and will not be tolerated.