Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erksch/react-native-wheely
An all JavaScript wheel picker for react-native without any native code.
https://github.com/erksch/react-native-wheely
react react-native
Last synced: about 5 hours ago
JSON representation
An all JavaScript wheel picker for react-native without any native code.
- Host: GitHub
- URL: https://github.com/erksch/react-native-wheely
- Owner: erksch
- Created: 2020-02-13T12:35:31.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-30T11:53:13.000Z (8 months ago)
- Last Synced: 2024-04-26T13:22:26.528Z (7 months ago)
- Topics: react, react-native
- Language: TypeScript
- Homepage:
- Size: 425 KB
- Stars: 360
- Watchers: 3
- Forks: 49
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# react-native-wheely
[](https://circleci.com/gh/erksch/react-native-wheely)
[](https://www.npmjs.com/package/react-native-wheely)
[](https://www.npmjs.com/package/react-native-wheely)
An all JavaScript, highly customizable wheel picker for react native.
## Installation
Install with npm
```
npm install --save react-native-wheely
```
Install with yarn
```
yarn add react-native-wheely
```
## Usage
```jsx
import React, { useState } from 'react';
import WheelPicker from 'react-native-wheely';
function CityPicker() {
const [selectedIndex, setSelectedIndex] = useState(0);
return (
setSelectedIndex(index)}
/>
);
}
```
## Props
| Name | Type | Description |
| ------------------------ | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `options` | `string[]` | Options to be displayed in the wheel picker. Options are rendered from top to bottom, meaning the first item in the options will be at the top and the last at the bottom. |
| `selectedIndex` | `number` | Index of the currently selected option. |
| `onChange` | `(index: number) => void` | Handler that is called when the selected option changes. |
| `visibleRest` | `number` | Amount of additional options that are visible in each direction. Default is 2, resulting in 5 visible options. |
| `itemHeight` | `number` | Height of each option in the picker. Default is 40. |
| `itemStyle` | `StyleProp` | Style for the option's container. |
| `itemTextStyle` | `StyleProp` | Style for the option's text. |
| `containerStyle` | `StyleProp` | Style of the picker. |
| `selectedIndicatorStyle` | `StyleProp` | Style of overlaying selected-indicator in the middle of the picker. |
| `rotationFunction` | `(x: number) => number ` | Function to determine the x rotation of items based on their current distance to the center (which is x). Default is  |
| `scaleFunction` | `(x: number) => number ` | Function to determine the scale of items based on their current distance to the center (which is x). Default is ![scale quation]() |
| `opacityFunction` | `(x: number) => number` | Function to determine the opacity of items based on their current distance to the center (which is x). Default is  |
| `decelerationRate` | "normal", "fast", number | How quickly the underlying scroll view decelerates after the user lifts their finger. See the [ScrollView docs](https://facebook.github.io/react-native/docs/scrollview.html#decelerationrate). Default is "fast". |
| `containerProps` | `ViewProps` | Props that are applied to the container which wraps the `FlatList` and the selected indicator. |
| `flatListProps` | `FlatListProps` | Props that are applied to the `FlatList`. |
## Memoization
The individual items in the picker (``) are [strictly memoized](https://github.com/erksch/react-native-wheely/blob/master/src/WheelPickerItem.tsx#L109-L114), meaning that they will not rerender after the initial render. Rerendering the picker items uncontrollably would lead to bad performance with large number of options. Item styles, animation functions and other parameters of items therefore must be static and changes to them after the initial render will have no effect.