Giter Site home page Giter Site logo

react-random-wheel's Introduction

react-random-wheel

Randomization wheel for React. Displays a series of segments and, on command, cycles through them to select one at random.

Usage

Install using npm or yarn.

Properties

  • segments: Required. An array of objects in this format:
    • name: Required. The name to display.
    • color: Optional. One of 'red', 'blue', or 'green'. Defaults to 'red' for odd-numbered segments or 'blue' for even-numbered segments.
    • data: Optional. An object that will be passed back untouched when the segment is selected.
  • spinTime: Optional. The number of milliseconds that a spin will last. Defaults to 2500.
  • onComplete: Optional. A callback that will receive the segment's object when the spinning animation is complete.

Methods

spinWheel()

Spins the wheel to select a random segment. Returns the segment that will be highlighted in the end. It's recommended that you wait until onComplete is called before doing anything user-facing with the selected segment, since the selection won't be obvious until then.

Example

See demo/wheel.js

License

(c) 2017 Todd Dukart. MIT licensed. See LICENSE for more information.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.