KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

rebolt-navigation

★ 207 Open GitHub ↗

Fast and declarative router for Rebolt

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Rebolt Navigation

[![Build Status][build-badge]][build]
[![Version][version-badge]][package]
[![MIT License][license-badge]][license]
[![PRs Welcome][prs-welcome-badge]][prs-welcome]
[![Chat][chat-badge]][chat]

> a fast, declarative navigation for react native

We're looking forward to seeing your feedback or questions on Discord

## Getting started

[Rebolt Navigation website](https://rebolt-navigation.callstack.com/)

### Installation

Open a Terminal in your project's folder and run,

```she
yarn add rebolt-navigation
```

After installation, you will need to add this library to your `bsconfig.json` dependencies

```json
"bs-dependencies": [
  "reason-react",
  "rebolt-navigation"
],
```

In addition you will need to install a few peer dependencies:

```sh
yarn add rebolt react-native-gesture-handler
```

* `react-native-gesture-handler` - [installation instructions](https://github.com/kmagiera/react-native-gesture-handler#installation)

As per [this issue](https://github.com/callstackincubator/rebolt-navigation/issues/103), you might need to add the following to your `bsconfig.json`:

```

"package-specs": {
  "module": "commonjs",
  "in-source": true
}

```
This generates output alongside source files. ([documentation](https://bucklescript.github.io/docs/en/build-configuration.html#package-specs))

## Usage

[View the docs](https://rebolt-navigation.callstack.com/docs/get-started.html#usage)

## Examples
- example built-in library - [/example](/example)
- standalone example - [reroute-example](https://github.com/souhe/reroute-example)

## Developing

```sh
# Starts Metro (React Native Packager)
npm run start-example

# Runs the app on iOS/Android
npm run run-ios

# Watches for source build changes
npm start
```

## License

[build-badge]: https://img.shields.io/circleci/project/github/callstackincubator/rebolt-navigation/master.svg?style=flat-square
[build]: https://circleci.com/gh/callstackincubator/rebolt-navigation
[version-badge]: https://img.shields.io/npm/v/rebolt-navigation.svg?style=flat-square
[package]: https://www.npmjs.com/package/rebolt-navigation
[license-badge]: https://img.shields.io/npm/l/rebolt-navigation.svg?style=flat-square
[license]: https://opensource.org/licenses/MIT
[prs-welcome-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs-welcome]: http://makeapullrequest.com
[chat-badge]: https://img.shields.io/discord/426714625279524876.svg?style=flat-square&colorB=758ED3
[chat]: https://discord.gg/zwR2Cdh

rebolt-navigation

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README