Customizable React roulette wheel with spinning animation
npm install react-custom-roulette 
Customizable React roulette wheel with spinning animation
- Customizable design
- Prize selection with props
- Spinning animation (customizable spin duration)
- [NEW!] Images as items (see Types)
- [NEW!] Customizable pointer image
- Multiple consecutive spins (see Multi Spin)
- Compatible with TypeScript
$ npm install react-custom-roulette
or
$ yarn add react-custom-roulette
#### Wheel Component
``jsx
import React from 'react'
import { Wheel } from 'react-custom-roulette'
const data = [
{ option: '0', style: { backgroundColor: 'green', textColor: 'black' } },
{ option: '1', style: { backgroundColor: 'white' } },
{ option: '2' },
]
export default () => (
<>
prizeNumber={3}
data={data}
backgroundColors={['#3e3e3e', '#df3428']}
textColors={['#ffffff']}
/>
)
`
#### Props
| Prop | Type | Default | Description |
|---------------------------------|--------------------|---------------------------|--------------------------------------------------------------------|
| mustStartSpinning _(required)_ | boolean | - | Sets when the roulette must start the spinning animation |number
| prizeNumber _(required)_ | | - | Sets the winning option. It's value must be between 0 and data.lenght-1 |Array
| data _(required)_ | | - | Array of options. Can contain styling information for a specific option (see WheelData) |function
| onStopSpinning | | () => null | Callback function that is called when the roulette ends the spinning animation |Array
| backgroundColors | | ['darkgrey', 'lightgrey'] | Array of colors that will fill the background of the roulette options, starting from option 0 |Array
| textColors | | ['black'] | Array of colors that will fill the text of the roulette options, starting from option 0 |string
| outerBorderColor | | 'black' | Color of the roulette's outer border line |number
| outerBorderWidth | | 5 | Width of the roulette's outer border line (0 represents no outer border line) |number [0..100]
| innerRadius | | 0 | Distance of the inner radius from the center of the roulette |string
| innerBorderColor | | 'black' | Color of the roulette's inner border line |number
| innerBorderWidth | | 0 | Width of the roulette's inner border line (0 represents no inner border line) |string
| radiusLineColor | | 'black' | Color of the radial lines that separate each option |number
| radiusLineWidth | | 5 | Width of the radial lines that separate each option (0 represents no radial lines) |string
| fontFamily | | 'Helvetica, Arial' | Global font family of the option string. Non-Web safe fonts are fetched from https://fonts.google.com/. All available fonts can be found there. |number
| fontSize | | 20 | Global font size of the option string |number | string
| fontWeight | | 'bold' | Global font weight of the option string |string
| fontStyle | | 'normal' | Global font style of the option string |boolean
| perpendicularText | | false | When 'true', sets the option texts perpendicular to the roulette's radial lines |number [0..100]
| textDistance | | 60 | Distance of the option texts from the center of the roulette |number [0.01 ..]
| spinDuration | | 1.0 | Coefficient to adjust the default spin duration |number
| startingOptionIndex | | - | Set which option (through its index in the data array) will be initially selected by the roulette (before spinning). If not specified the roulette will render without choosing a starting option |PointerProps
| pointerProps | | { src: roulettePointer } | Image source and CSS styling to apply to the pointer image. |boolean
| disableInitialAnimation | | false | When 'true', disables the initial backwards wheel animation |
#### WheelData
`jsx`
interface WheelData {
option?: string;
image?: ImageProps;
style?: StyleType; // Optional
optionSize?: number; // Optional
}
| Prop | Type | Default | Description |
|------------|--------------|-------------|-------------------------------------------------------------------------------------------------------|
| option | string | '' | String to be rendered inside an option. |ImageProps
| image | | - | Image to be rendered inside an option. It is configured through ImageProps |StyleType
| style | | - | Styles for option. It is configured through StyleType |number
| optionSize | | 1 | Integer that sets the size of the option measured in roulette pieces. For example: if data provides 2 options A and B, and you set A's optionSize to 2, B's optionSize to 1, the roulette will render 3 pieces: 2 corresponding to A and 1 corresponding to B. Therefore, A will appear to be twice as big as B. |
#### StyleType
`jsx`
interface StyleType {
backgroundColor?: string; // Optional
textColor?: string; // Optional
fontFamily?: string; // Optional
fontSize?: number; // Optional
fontWeight?: number | string; // Optional
fontStyle?: string; // Optional
}
| Prop | Type | Default | Description |
|-----------------|-------------------|---------------------------|--------------------------------------------------------------------|
| backgroundColor | string | 'darkgrey' or 'lightgrey' | Background color for option |string
| textColor | | 'black' | Text color |string
| fontFamily | | 'Helvetica, Arial' | String containing text font and its fallbacks separated by commas |number
| fontSize | | 20 | Font size number |number | string
| fontWeight | | 'bold' | Font weight string or number |string
| fontStyle | | 'normal' | Font style string |
#### ImageProps
`jsx`
interface ImageProps {
uri: string;
offsetX?: number; // Optional
offsetY?: number; // Optional
sizeMultiplier?: number; // Optional
landscape?: boolean; // Optional
}
| Prop | Type | Default | Description |
|----------------|-----------|-------------|---------------------------------------------------------------------------------------|
| uri | string | - | Image source. It can be url or path. |number
| offsetX | | 0 | Image offset in its X axis |number
| offsetY | | 0 | Image offset in its Y axis |number
| sizeMultiplier | | 1 | A value of 1 means image height is calculated as 200px * sizeMultiplier and width will be calculated to keep aspect ratio. |boolean
| landscape | | false | If true, image will be rotated 90 degrees so as to render in a landscape orientation. |
#### PointerProps
`jsx`
interface PointerProps {
src?: string; // Optional
style?: React.CSSProperties; // Optional
}
| Prop | Type | Default | Description |
|----------|-----------------------|---------------------------|-----------------------------|
| src | string | - | Image src. |React.CSSProperties
| style | | - | Styling for pointer image. |
#### Example (using useState)
`jsx
import React, { useState } from 'react'
import { Wheel } from 'react-custom-roulette'
const data = [
{ option: '0' },
{ option: '1' },
{ option: '2' },
]
export default () => {
const [mustSpin, setMustSpin] = useState(false);
const [prizeNumber, setPrizeNumber] = useState(0);
const handleSpinClick = () => {
if (!mustSpin) {
const newPrizeNumber = Math.floor(Math.random() * data.length);
setPrizeNumber(newPrizeNumber);
setMustSpin(true);
}
}
return (
<>
prizeNumber={prizeNumber}
data={data}
onStopSpinning={() => {
setMustSpin(false);
}}
/>
)
}
``
This project exists thanks to all the people who contribute!
This project is licensed under the MIT license, Copyright (c) 2023 Effectus Software. [License]