✨ Features

• Axes translate user action entered by various input devices into the virtual coordinate system.
• You can create an UI that responds to user actions.
• Provides five input types. These can be associated with a user interface.
  • PanInput
  • RotatePanInput
  • PinchInput
  • WheelInput
  • MoveKeyInput
• Provides six types of events generated by InputTypes.
  • hold
  • change
  • release
  • animationStart
  • animationEnd
  • finish
• Moreover, you can create your own custom InputTypes!

⚙️ Installation

npm

$ npm install @egjs/react-axes

🏃 Quick Start

Using reactive properties from useAxes

• You can change the value of the axis through touch screen, mouse or anything else.
• You can use the names of each axis as reactive properties.
• Connect axis with various InputTypes inside useEffect.

import { PanInput, useAxes } from "@egjs/react-axes";

function App() {
  const area = useRef<HTMLDivElement>(null);
  const { connect, rotateX, rotateY } = useAxes(
    {
      rotateX: {
        range: [0, 360],
        circular: true,
        startPos: 0,
      },
      rotateY: {
        range: [0, 360],
        circular: true,
        startPos: 0,
      },
    },
    {
      deceleration: 0.0024,
    },
  );

  useEffect(() => {
    connect("rotateX rotateY", new PanInput(area));
  }, []);

  return (
    <div className="App">
      <div id="area" ref={area} style={{ transform: `rotateY(${rotateX}deg) rotateX(${rotateY}deg)` }}>
        <div id="item"></div>
      </div>
    </div>
  );
}

Using Events with useAxes

• useAxes provides hooks to define callback functions for each event.
• If the callback function references any values, please pass them in the dependency array.
• For a detailed description of the event object passed to the callback functions, please refer to Events.

const {
    onHold,
    onChange,
    onRelease,
    onAnimationStart,
    onAnimationEnd,
    onFinish,
    ...
} = useAxes({...});

// `hold` Event Hook
onHold(callback, dependencies);

// `change` Event Hook
onChange(callback, dependencies);

// `release` Event Hook
onRelease(callback, dependencies);

// `animationStart` Event Hook
onAnimationStart(callback, dependencies);

// `animationEnd` Event Hook
onAnimationEnd(callback, dependencies);

// `finish` Event Hook
onFinish(callback, dependencies);

🌐 Supported Browsers

||||||| |:---:|:---:|:---:|:---:|:---:|:---:| |10+|Latest|Latest|Latest|7+|2.3+(except 3.x)|

🔧 Dependency

egjs-axes has the dependencies for the following libraries:

|eg.Component|eg.Agent| |----|----| |3.0.1+|2.2.1+|

📼 Demos

Check our Demos.

📖 Documentation

See Documentation page.

🙌 Contributing

See CONTRIBUTING.md.

📝 Feedback & Bug Report

Please file an Issue.

📜 License

@egjs/react-axes is released under the MIT license.

Copyright (c) 2015 NAVER Corp.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.