https://github.com/rescript-react-native/rescript-react-navigation

ReScript bindings for React Navigation
https://github.com/rescript-react-native/rescript-react-navigation

hacktoberfest navigation react react-native react-navigation rescript rescript-react rescript-react-native

Last synced: 3 days ago
JSON representation

ReScript bindings for React Navigation

• Host: GitHub
• URL: https://github.com/rescript-react-native/rescript-react-navigation
• Owner: rescript-react-native
• License: mit
• Created: 2019-09-04T05:13:47.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-20T21:14:57.000Z (21 days ago)
• Last Synced: 2024-10-22T07:40:46.401Z (19 days ago)
• Topics: hacktoberfest, navigation, react, react-native, react-navigation, rescript, rescript-react, rescript-react-native
• Language: ReScript
• Homepage:
• Size: 4.22 MB
• Stars: 73
• Watchers: 5
• Forks: 28
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - rescript-react-navigation - react-native | 54 | (Reason)

README

        
# `rescript-react-navigation`

[![Build Status](https://github.com/rescript-react-native/rescript-react-navigation/workflows/Build/badge.svg)](https://github.com/rescript-react-native/rescript-react-navigation/actions)

[![Version](https://img.shields.io/npm/v/rescript-react-navigation.svg)](https://www.npmjs.com/rescript-react-navigation)

[![ReScript Forum](https://img.shields.io/discourse/posts?color=e6484f&label=ReScript%20Forum&server=https%3A%2F%2Fforum.rescript-lang.org)](https://forum.rescript-lang.org/)

[ReScript](https://rescript-lang.org) bindings for

[`react-navigation`](https://github.com/react-navigation/react-navigation).

Exposed as `ReactNavigation` module.

`rescript-react-navigation` X.y.\* means it's compatible with `react-navigation`

X.y.\*

## Status

⚠️ Work in progress. These bindings are used successfully in several apps, but

are not complete yet and still subject to change.

## Installation

When

[`react-navigation`](https://github.com/react-navigation/react-navigation) is

properly installed & configured by following their installation instructions,

you can install the bindings:

```console

npm install rescript-react-navigation

# or

yarn add rescript-react-navigation

```

`rescript-react-navigation` should be added to `bs-dependencies` in your

`bsconfig.json`:

```diff

{

  //...

  "bs-dependencies": [

    "@rescript/react",

    "rescript-react-native",

    // ...

+    "rescript-react-navigation"

  ],

  //...

}

```

## Example

See <./src/Example.re>

---

## 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.