react-spin-game
TypeScript icon, indicating that this package has built-in type declarations

1.0.7 • Public • Published

react-spin-game

react-spin-game is a wheel of prizes game, spinning game build using reactjs

NPM JavaScript Style Guide

Install

npm install --save react-spin-game

Preview

react-spin-game-photo

Usage

import React, { Component } from 'react'

import  SpinAndWin  from 'react-spin-game'
import  'react-spin-game/dist/index.css'

const freeSpinGifts = [['test1','red'], ['test2','black'], ['test3','#808080'], ['test4','blue'], ['test5','gray'], ['test6','blue']]

class Example extends Component {
  render() {
    return <SpinAndWin data={freeSpinGifts}/>
  }
}

Additional properties

interface SpinGameData {
  data: Array<Array<string>>
  hideButton?: boolean
  result?: string
  time?: number
  minTime?: number
  maxTime?: number
  removeButtonEffect?: boolean
  fontSize?: number
  fontFamily?: string,
  horizantalText?:boolean
}

Description:

  1. data: data to be displayed in spin game and their background colors, as array of arrays
  • Example: [['test1','red'], ['test2','black'], ['test3','#808080'], ['test4','blue'], ['test5','gray'], ['test6','blue']]
  1. hideButton: indicator to display the SPIN button or not
  • Example: true || false
  1. result: the result of spining the wheel
  • Example: test1
  1. time: the time of the transition after the wheel is spined
  • Example: 5 (any number)
  1. minTime and maxTime: the minimum and maximum time for the transition, in case that you need the spin time to be random between a range of two numbers
  • Example: 5 (any number)
  1. removeButtonEffect: indicator to stop the functionality of the SPIN button
  • Example: true
  1. fontSize: to change the font size for the text
  • Example: 26
  1. fontFamily: to change the font family for the text
  • Example: fantasy
  1. horizantalText: to switch the text to be horizontal instead of vertical
  • Example: true

Hint : you can also pass ref prop to SpinAndWin component to extract the function responsible for the spinning of the wheel, if you wish to use it on another component.

  • Example:
import React ,{ useRef }from 'react'
import  SpinAndWin  from 'react-spin-game'
import  'react-spin-game/dist/index.css'

const freeSpinGifts = [['test1','red'], ['test2','black'], ['test3','#808080'], ['test4','blue'], ['test5','gray'], ['test6','blue']]
const App = () => {
  const ref = useRef<any>(null)
  return <>
  <SpinAndWin ref={ref} data={freeSpinGifts} />
  <button onClick={()=>ref.current.handleSpin()}>Spin</button></>
}

export default App

License

MIT © ahmadalrasheed

Package Sidebar

Install

npm i react-spin-game

Weekly Downloads

39

Version

1.0.7

License

MIT

Unpacked Size

66.1 kB

Total Files

13

Last publish

Collaborators

  • ahmadalrasheed