Skip to content

Commit 1bd2e35

Browse files
committed
Adjust things for "ReScript" branding
1 parent 3faaee4 commit 1bd2e35

File tree

3 files changed

+11
-18
lines changed

3 files changed

+11
-18
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ node_modules
99
# npm unused lock file (we use yarn.lock)
1010
package-lock.json
1111

12-
# Ocaml / Reason / BuckleScript artifacts
12+
# ReScript / Reason / Ocaml artifacts
1313
#*.bs.js # we do want this files to ensure zero-cost
1414
.bsb.lock
1515
**/lib/bs

README.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
[![Version](https://img.shields.io/npm/v/@reason-react-native/viewpager.svg)](https://www.npmjs.com/@reason-react-native/viewpager)
55
[![Chat](https://img.shields.io/discord/235176658175262720.svg?logo=discord&colorb=blue)](https://reasonml-community.github.io/reason-react-native/discord/)
66

7-
[ReasonML](https://reasonml.github.io) /
8-
[BuckleScript](https://bucklescript.github.io) bindings for
7+
[ReScript](https://rescript-lang.org) / [Reason](https://reasonml.github.io) bindings for
98
[`@react-native-community/viewpager`](https://github.com/react-native-community/react-native-viewpager).
109

1110
Exposed as `ReactNativeViewPager` module.
1211

13-
`@reason-react-native/viewpager` X.y._ means it's compatible with
14-
`@react-native-community/viewpager` X.y._
12+
`@reason-react-native/viewpager` X.y.\* means it's compatible with
13+
`@react-native-community/viewpager` X.y.\*
1514

1615
## Installation
1716

@@ -27,7 +26,7 @@ yarn add @reason-react-native/viewpager
2726
```
2827

2928
`@reason-react-native/viewpager` should be added to `bs-dependencies` in your
30-
`bsconfig.json`. Something like
29+
`bsconfig.json`:
3130

3231
```diff
3332
{
@@ -61,23 +60,16 @@ let app = () =>
6160
</SafeAreaView>;
6261
```
6362

64-
### Types
65-
66-
#### `ReactNativeViewPager.t`
63+
#### `ReactNativeViewPager` props
6764

6865
```reason
6966
~ref: ref=?,
7067
~initialPage: int=?,
7168
~scrollEnabled: bool=?,
72-
~onPageScroll: ReactNative.Event.syntheticEvent(scrollEvent) => unit=?,
73-
~onPageSelected: ReactNative.Event.syntheticEvent(selectedEvent) => unit=?,
74-
~onPageScrollStateChanged: ReactNative.Event.syntheticEvent(
75-
scrollStateChangedEvent,
76-
) =>
77-
unit
78-
=?,
79-
~keyboardDismissMode: [@bs.string] [ | `none | [@bs.as "on-drag"] `onDrag]
80-
=?,
69+
~onPageScroll: PageScrollEvent.t => unit=?,
70+
~onPageSelected: PageSelectedEvent.t => unit=?,
71+
~onPageScrollStateChanged: PageScrollStateChangedEvent.t => unit=?,
72+
~keyboardDismissMode: [@bs.string] [ | `none | [@bs.as "on-drag"] `onDrag]=?,
8173
~pageMargin: int=?,
8274
~onMoveShouldSetResponderCapture: ReactNative.Event.pressEvent => bool=?,
8375
~style: ReactNative.Style.t=?,

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"repository": "https://github.com/reason-react-native/viewpager.git",
1111
"license": "MIT",
1212
"keywords": [
13+
"rescript",
1314
"reason",
1415
"reasonml",
1516
"bucklescript",

0 commit comments

Comments
 (0)