Code Monkey home page Code Monkey logo

react-repeatable's Introduction

react-repeatable build status Coverage Status

NPM

A press and hold wrapper component that can trigger hold action multiple times while holding down.

Demo: https://cheton.github.io/react-repeatable

Installation

npm install --save react-repeatable

Usage

<Repeatable
    repeatDelay={500}
    repeatInterval={32}
    onPress={(event) => {
        // Callback fired when the mousedown or touchstart event is triggered.
    }}
    onHoldStart={() => {
        // Callback fired once before the first hold action.
    }}
    onHold={() => {
        // Callback fired mutiple times while holding down.
    }}
    onHoldEnd={() => {
        // Callback fired once after the last hold action.
    }}
    onRelease={(event) => {
        // Callback fired when the mouseup, touchcancel, or touchend event is triggered.
    }}
>
    Press Me
</Repeatable>

Repeatable Button

const RepeatableButton = ({ onClick, ...props }) => (
    <Repeatable
        tag="button"
        type="button"
        onHold={onClick}
        onRelease={onClick}
        {...props}
    />
);

<RepeatableButton onClick={handleClick} />

API

Sequence of Events

Hold action is occurred

onPress -> onHoldStart -> onHold (once or more) -> onHoldEnd -> onRelease

Hold action is not occurred

onPress -> onRelease

Properties

Name Type Default Description
tag element 'div' A custom element for this component.
disabled Boolean false Set it to true to disable event actions.
repeatDelay Number 500 The time (in milliseconds) to wait before the first hold action is being triggered.
repeatInterval Number 32 The time interval (in milliseconds) on how often to trigger a hold action.
repeatCount Number 0 The number of times the hold action will take place. A zero value will disable the repeat counter.
onPress Function(event) Callback fired when the mousedown or touchstart event is triggered.
onHoldStart Function() Callback fired once before the first hold action.
onHold Function() Callback fired mutiple times while holding down.
onHoldEnd Function() Callback fired once after the last hold action.
onRelease Function(event) Callback fired when the mouseup, touchcancel, or touchend event is triggered.

License

MIT

react-repeatable's People

Contributors

baukevanderlaan avatar cheton avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

react-repeatable's Issues

Triggers twice on tap on Android devices

onPress and onRelease are triggered twice in Android devices. You can see it in your demo, in inspector tools, if you toggle the device to any mobile device, the console will show onPress and onRelease twice.

On an actual Android device, it seems that the onPress action is triggered once on touch start, and once on touch end. This double tapping behavior did not happen on an iPad.

Persist the original event?

Love the library! It would be cool to be able to persist the original event so it could be passed to onHold so that keyboard modifiers could be used in conjunction with this

eg, Shift+Click(&Hold) = Increment x10 like in many apps

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.