2.0.1 • Published 3 years ago

react-native-pins v2.0.1

Weekly downloads
117
License
MIT
Repository
github
Last release
3 years ago

react-native-pins

npm npm licence npm downloads

The pins come with a shake animation and configurable device vibration.

Install

To get started install via npm:

 npm install react-native-pins

Usage

Import:

 import { Pins } from 'react-native-pins';

Then add it to your code:

<Pins
    onRef={ref => (this.pins = ref)}
    numberOfPins={5}
    numberOfPinsActive={2}
    numberOfPinsMaximum={2}
    activeOnly
/>

The <Pins /> has a shake() method which can be called through a reference this.pins.shake(). This will perform a shake animation and vibration if enabled. A callback can be passed through props which will be fired when the animation is complete. See props below.

Pins

PropTypeOptionalDefaultDescription
onRefanyYesonRef allows you to call the shake() method.
activeOnlyboooleanyesfalseWhether to only fill the active pin or to fill all of them.
spacingnumberyes15The space between the pins
pinSizenumberyes18The size of the pins
numberOfPinsnumberYes5Number of pins to render.
numberOfPinsActivenumberYes0Number of active pins. You can pass the pin.length here.
vibrationboolYestrueShould vibration be enabled on shake?
animationShakeCallbackfuncYesA callback triggered when the pin shake animation has finished.
containerStyleobjectYesSee Pins.jsStyle applied to PINS container.
pinStyleobjectYesSee Pins.jsStyle applied to each circle PIN.
pinActiveStyleobjectYesSee Pins.jsStyle applied to each circle PIN when it is active.
numberOfPinsMaximumnumberYesThis property is used to set a maximum number of pins to show. If specified, then the pins will have an animation effect, as showcased in the demo above.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

License

This project is licensed under the MIT License