Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

react-with-gesture

Package Overview
Dependencies
Maintainers
1
Versions
31
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

react-with-gesture

hoc for receiving gestures

  • 3.0.3
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
1.4K
decreased by-73.33%
Maintainers
1
Weekly downloads
 
Created
Source
npm install react-with-gesture

Wraps a component into a div that receives MouseDown and TouchStart events, then captures movement until release.

Demo: https://codesandbox.io/embed/jzn14k0ppy

  • down, true on mouse-down or finger-touch
  • x/y, screen coordinates
  • xDelta/yDelta, coordinates relative to initial coordinates, great for sliding/dragging gestures
  • xInitial/yInitial, coordinates of the first click/touch
  • xVelocity/yVelocity, flick velocity
  • xPrev/yPrev, coordinates of the previous frame
  • target, the dom element
  • event, the event itself, in case you need to prevent defaults, etc.

Decorated higher order component

import { withGesture } from 'react-with-gesture'

@withGesture
export class App extends React.Component {
  render() {
    const { down, x, y, xDelta, yDelta, xInitial, yInitial } = this.props
    return (
      <div>
        Drag me! coordinates: {x}, {y}
      </div>
    )
  }
}

Higher order component

class App extends React.Component {
  render() {
    const { down, x, y, xDelta, yDelta, xInitial, yInitial } = this.props
    return (
      <div>
        Drag me! coordinates: {x}, {y}
      </div>
    )
  }
}

export withGesture(App)

Render props

import { Gesture } from 'react-with-gesture'

class App extends React.Component {
  render() {
    return (
      <Gesture>
        {({ down, x, y, xDelta, yDelta, xInitial, yInitial }) => (
          <div>
            Drag me! coordinates: {x}, {y}
          </div>
        )}
      </Gesture>
    )
  }
}

Hooks

import { useGesture } from 'react-with-gesture'

function App() {
  const [bind, { args, down, x, y, xDelta, yDelta, xInitial, yInitial }] = useGesture()
  return (
    <div {...bind(/*arguments you pass here will be available under args*/)}>
      Drag me! coordinates: {x}, {y}
    </div>
  )
}

Transient mode

This won't cause new render passes, instead you will be notified through the callback. This works the same for Hoc's, render-props and hooks.

const bind = useGesture(e => console.log(e))

Keywords

FAQs

Package last updated on 01 Jan 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc