Skip to content

Latest commit

 

History

History
232 lines (136 loc) · 8.9 KB

CHANGELOG.md

File metadata and controls

232 lines (136 loc) · 8.9 KB

Changelog

5.1.2 Release

Summary: Minor release fixing TypeScript export.

Fixed

  1. import { useGesture } from 'react-use-gesture' should now be functional

5.1.0 Release (do not use)

5.1.1 Release

Summary: important release introducing trackpad gestures. The library has been fully rewritten in TypeScript with some important refactoring involved.

Added

  1. Support for for zoom and rotate on trackpad for Safari.
  2. Support for zoom on trackpad for Chrome and Firefox.
  3. Added buttons attribute to pointer-related gesture state.
  4. Added origin attribute to pinch gesture.
  5. Accepts support for genuine element handlers (such as onMouseDown) to prevent overriding when passing the prop directly to the bound component.

Fixed

  1. Drag gesture will interrupt if a move event has no button pressed (that could happen if triggering a right click) and then moving the mouse around.

Breaking changes

  1. config object must be passed as a second argument.

5.0.2 Release

Summary: minor release.

Fixed

  1. Added onHover in Typescript definitions.

5.0.1 Release

Summary: release updating dev dependencies and fixing minor bugs.

Fixed

  1. Fixed a bug where onDragEnd or onPinchEnd would be called too late when the gestures are canceled #52

  2. Wheel and scroll gestures are also returning modifier keys.

5.0.0 Release

Summary (recap from betas): major release introducing additional gestures on top of drag: pinch, scroll, wheel, hover and move are now supported. This release is dropping support for high-order and render-props component and can only be used through React hooks 🎣. Therefore react-with-gesture is now react-use-gesture.

Added

  1. Support for pinch, scroll, wheel, move and hover events. Each gesture has now an active boolean prop that lets you know whether it’s currently active. State also include dragging, moving, scrolling, wheeling, pinching, and hovering booleans so that you can know within a gesture handler the running state of all others.

  2. Support for dynamically enabling or disabling gestures in the config object: useGesture(actions, { enabled: false }) or useGesture(actions, { drag: true, move: false }) if you want to disable or enable gestures individually.

  3. You can now add a gesture to a dom node or the window (useful for scroll) with the domTarget config prop. In that case you shouldn’t spread bind in a component but use the useEffect hook that will take care of adding and removing listeners:

const bind = useGesture({ onScroll: () => {...} }, { domTarget: window })
React.useEffect(bind, [bind])

  1. Individual per-axis velocity has been added in gesture state props as vxvy: vector2.

  2. There's a new transform config prop that can be passed to change the way x and y are calculated (useful for canvas which inverts axis compared to the dom).

  3. Experimental support for pointer events through config: { event : { pointerEvents: true } }.

  4. Tests with react-testing-library.

  5. Travis integration.

Improved

  1. State and props are no longer frozen, meaning you can now use state or props values from your component inside your handler and they will be up to date.
const [dragCount, setDragCount] = useState(0)
const bind = useGesture({
  onDrag: ({ first }) => {
    console.log(dragCount) //<-- count will be up to date
    if (first) setDragCount(dragCount + 1)
  },
})
  1. Readme should be clearer (hopefully)!

Breaking

  1. HOC and render-props component support has been dropped. Hooks usage is enforced, therefore this package requires React 16.8+.

  2. Default syntax [bind, props] = useGesture() has been dropped in favor of bind = useGesture({ onDrag: () => {...} }) which is more performance-effective since it doesn’t render on each frame.

  3. onAction prop is now an alias of onDrag but should be avoided as its support could be dropped at any time. Subsequently, onUp and onDown have been dropped, and there's now on[Gesture]Start and on[Gesture]End handlers.

  4. config object should now be passed as a second argument.

// from this:
useGesture({ onAction: () => {}, config })
// to this:
useGesture({ onDrag: () => {} }, { ...config })
  1. touch and mouse config props are dropped.

5.0.0-beta.8 Release

Summary: Removed default export to match TypeScript import in JS.

Breaking

  1. You should now import useGesture as follows: import { useGesture } from 'react-use-gesture'

5.0.0-beta.7 Release

Summary: Minor bug fixing.

Fixed

  1. first was still set to true when the gesture finished if no movement was registered.

5.0.0-beta.6 Release

Summary: Minor bug fixing.

Fixed

  1. NaN or Infinity velocities are now set to 0.

5.0.0-beta.5 Release

Summary: bug fixing and more tests.

Improved

  1. domTarget now accepts refs.
  2. Tests are now testing domTarget.
  3. Tests are now testing bind passing arguments.

Fixed

  1. onMoveEnd shouldn't fire if state isn't moving (ie onLeave was triggered).
  2. Performance optimizations were removed as they were conflicting with passing args to bind.

5.0.0-beta.4 Release

Summary: bug fixing and added tests!

Added

  1. Tests have been added with react-testing-library: they still throw a warning about some tests not being wrapped in act(...) but this is probably because of async debouncing in move, scroll, wheel events and RAF for cancel in drag and pinch.

  2. Added Travis integration.

Improved

  1. Now using dtslint for Typescript definitions and tests.

Fixed

  1. first was always returning true and this is no longer the case.

  2. active wasn't set to true when moving in onMove.

  3. Added activeset to false on mouseLeave for onHover. This might not be a good idea though.

5.0.0-beta.3 Release

Summary: major release introducing additional gestures on top of drag: pinch, scroll, wheel, hover and move are now supported. This release is dropping support for high-order and render-props component and can only be used through React hooks 🎣. Therefore react-with-gesture is now react-use-gesture.

Added

  1. Support for pinch, scroll, wheel, move and hover events. Each gesture has now an active boolean prop that lets you know whether it’s currently active. State also include dragging, moving, scrolling, wheeling, pinching, and hovering booleans so that you can know within a gesture handler the running state of all others.

  2. Support for dynamically enabling or disabling gestures in the config object: useGesture(actions, { enabled: false }) or useGesture(actions, { drag: true, move: false }) if you want to disable or enable gestures individually.

  3. You can now add a gesture to a dom node or the window (useful for scroll) with the domTarget config prop. In that case you shouldn’t spread bind in a component but use the useEffect hook that will take care of adding and removing listeners:

const bind = useGesture({ onScroll: () => {...} }, { domTarget: window })
React.useEffect(bind, [bind])

  1. Individual per-axis velocity has been added in gesture state props as vxvy: vector2.

  2. There's a new transform config prop that can be passed to change the way x and y are calculated (useful for canvas which inverts axis compared to the dom).

  3. Experimental support for pointer events through config: { event : { pointerEvents: true } }.

Improved

  1. useGesture returned value is now cached which should produce better performance in case of frequent renders produced by external factors (i.e. prop change).

  2. State and props are no longer frozen, meaning you can now use state or props values from your component inside your handler and they will be up to date.

const [dragCount, setDragCount] = useState(0)
const bind = useGesture({
  onDrag: ({ first }) => {
    console.log(dragCount) //<-- count will be up to date
    if (first) setDragCount(dragCount + 1)
  },
})
  1. Readme should be clearer (hopefully)!

Breaking

  1. HOC and render-props component support has been dropped. Hooks usage is enforced, therefore this package requires React 16.8+.

  2. Default syntax [bind, props] = useGesture() has been dropped in favor of bind = useGesture({ onDrag: () => {...} }) which is more performance-effective since it doesn’t render on each frame.

  3. onAction prop is now an alias of onDrag but should be avoided as its support could be dropped at any time. Subsequently, onUp and onDown have been dropped, and there's now on[Gesture]Start and on[Gesture]End handlers.

  4. config object should now be passed as a second argument.

// from this:
useGesture({ onAction: () => {}, config })
// to this:
useGesture({ onDrag: () => {} }, { ...config })
  1. touch and mouse config props are dropped.