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

ReScript bindings for react-native-paper
https://github.com/rescript-react-native/paper

hacktoberfest paper react react-native rescript rescript-react rescript-react-native

Last synced: about 2 months ago
JSON representation

ReScript bindings for react-native-paper

• Host: GitHub
• URL: https://github.com/rescript-react-native/paper
• Owner: rescript-react-native
• License: mit
• Created: 2019-10-23T07:34:46.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-02-09T04:24:12.000Z (over 1 year ago)
• Last Synced: 2024-07-12T09:44:49.639Z (2 months ago)
• Topics: hacktoberfest, paper, react, react-native, rescript, rescript-react, rescript-react-native
• Language: ReScript
• Homepage:
• Size: 492 KB
• Stars: 15
• Watchers: 6
• Forks: 15
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - paper - native-paper | rescript-react-native | 12 | (ReScript)

README

        
# `@rescript-react-native/paper`

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

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

[![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-native-paper`](https://github.com/callstack/react-native-paper).

Exposed as `Paper` module.

`@rescript-react-native/paper` X.y.\* means it's compatible with

`react-native-paper` X.y.\*

## Status

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

are not complete yet and still subject to change.

[Checkout missing components](#implemented-components)

## Installation

When [`react-native-paper`](https://github.com/callstack/react-native-paper)

is properly installed & configured by following their installation instructions,

you can install the bindings:

```console

npm install @rescript-react-native/paper

# or

yarn add @rescript-react-native/paper

```

`@rescript-react-native/paper` should be added to `bs-dependencies` in your

`bsconfig.json`:

```diff

{

  //...

  "bs-dependencies": [

    "@rescript/react",

    "rescript-react-native",

    // ...

+    "@rescript-react-native/paper"

  ],

  //...

}

```

## Usage

### Components

```rescript

[@react.component]

let make = () => {

  let (visible, setVisible) = React.useState(() => false);

  

     setVisible(_ => false)}>

      

        {"Title"->React.string}

      

      

        {"Description"->React.string}

      

    

  

};

```

---

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

## Implemented components

- [x] ActivityIndicator

- [x] Avatar

- [x] Appbar

- [x] BottomNavigation

- [x] Badge

- [x] Banner

- [x] Button

- [x] Checkbox

- [x] Card

- [x] Chip

- [x] Dialog

- [x] Divider

- [x] FAB

- [ ] DataTable

- [x] Drawer

- [x] List

- [x] IconButton

- [x] Modal

- [ ] Menu

- [x] RadioButton

- [x] Searchbar

- [x] PaperProvider

- [x] Portal

- [x] ProgressBar

- [x] Snackbar

- [x] Surface

- [x] TextInput

- [x] TouchableRipple

- [x] ToggleButton

- [x] HelperText

- [x] ThemeProvider

- [x] withTheme (HoC)

- Typography

  - [x] Title

  - [x] Subheading

  - [x] Headline

  - [x] Paragraph

  - [x] Caption

  - [x] Text