https://github.com/rescript-react-native/edge-to-edge
https://github.com/rescript-react-native/edge-to-edge
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/rescript-react-native/edge-to-edge
- Owner: rescript-react-native
- License: mit
- Created: 2025-04-15T15:20:35.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-04-16T14:05:37.000Z (2 months ago)
- Last Synced: 2025-04-16T20:59:35.541Z (2 months ago)
- Language: ReScript
- Size: 12.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# `@rescript-react-native/edge-to-edge`
[](https://github.com/rescript-react-native/edge-to-edge/actions)
[](https://www.npmjs.com/@rescript-react-native/edge-to-edge)
[](https://forum.rescript-lang.org/)
[ReScript](https://rescript-lang.org) bindings for
[`react-native-edge-to-edge`](https://github.com/zoontek/react-native-edge-to-edge).
Exposed as `ReactNativeEdgeToEdge` module.
`@rescript-react-native/edge-to-edge` X.y.\* means it's compatible with
`react-native-edge-to-edge` X.y.\*
## Installation
When
[`react-native-edge-to-edge`](https://github.com/zoontek/react-native-edge-to-edge)
is properly installed & configured by following their installation instructions,
you can install the bindings:
```console
npm install @rescript-react-native/edge-to-edge
# or
yarn add @rescript-react-native/edge-to-edge
```
`@rescript-react-native/edge-to-edge` should be added to `bs-dependencies` in your
`rescript.json`:
```diff
{
//...
"bs-dependencies": [
"@rescript/react",
"rescript-react-native",
// ...
+ "@rescript-react-native/edge-to-edge"
],
//...
}
```
## Usage
### Component
#### `ReactNativeEdgeToEdge.SystemBars`
```rescript
open ReactNativeEdgeToEdge
```
### Methods
#### `ReactNativeEdgeToEdge.SystemBars.pushStackEntry`
```rescript
open ReactNativeEdgeToEdge
SystemBars.pushStackEntry(props)
```
#### `ReactNativeEdgeToEdge.SystemBars.popStackEntry`
```rescript
open ReactNativeEdgeToEdge
SystemBars.popStackEntry(entry)
```
#### `ReactNativeEdgeToEdge.SystemBars.replaceStackEntry`
```rescript
open ReactNativeEdgeToEdge
SystemBars.replaceStackEntry(entry, props)
```
---
## 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.