https://github.com/px2code/moveable-pxcode
https://github.com/px2code/moveable-pxcode
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/px2code/moveable-pxcode
- Owner: px2code
- License: mit
- Created: 2021-04-02T02:03:53.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T07:19:36.000Z (over 2 years ago)
- Last Synced: 2024-10-28T22:36:08.793Z (7 months ago)
- Language: TypeScript
- Size: 3.23 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - px2code/moveable-pxcode - (TypeScript)
README
React Moveable
A React Component that create Moveable, Draggable, Resizable, Scalable, Rotatable, Warpable, Pinchable, Groupable, Snappable.
Demo /
Storybook /
API /
Main Project
Moveable
Draggable
Resizable
Scalable
Rotatable
Warpable
Pinchable
Groupable
Snappable
Clippable
Roundable
OriginDraggable
Selecto
## 🔥 Features
* **Draggable** refers to the ability to drag and move targets.
* **Resizable** indicates whether the target's width and height can be increased or decreased.
* **Scalable** indicates whether the target's x and y can be scale of transform.
* **Rotatable** indicates whether the target can be rotated.
* **Warpable** indicates whether the target can be warped(distorted, bented).
* **Pinchable** indicates whether the target can be pinched with draggable, resizable, scalable, rotatable.
* **Groupable** indicates Whether the targets can be moved in group with draggable, resizable, scalable, rotatable.
* **Snappable** indicates whether to snap to the guideline.
* **OriginDraggable*** indicates Whether to drag origin.
* **Clippable** indicates Whether to clip the target.
* **Roundable** indicates Whether to show and drag or double click border-radius.
* Support SVG Elements (svg, path, line, ellipse, g, rect, ...etc)
* Support Major Browsers
* Support 3d Transform
## ⚙️ Installation
```sh
$ npm i react-moveable
```
## 📄 Documents
* [**Moveable Handbook**](https://github.com/daybrush/moveable/blob/master/handbook/handbook.md)
* [**How to use Group**](https://github.com/daybrush/moveable/blob/master/handbook/handbook.md#toc-group)
* [**How to use custom CSS**](https://github.com/daybrush/moveable/blob/master/handbook/handbook.md#toc-custom-css)
* [**How to make custom able**](https://github.com/daybrush/moveable/blob/master/packages/react-moveable/src/react-moveable/ables/README.md)
* [API Documentation](https://daybrush.com/moveable/release/latest/doc/)
## 🚀 How to use
```tsx
import Moveable from "react-moveable";
render() {
return (
{
console.log("onDragStart", target);
}}
onDrag={({
target,
beforeDelta, beforeDist,
left, top,
right, bottom,
delta, dist,
transform,
clientX, clientY,
}: OnDrag) => {
console.log("onDrag left, top", left, top);
// target!.style.left = `${left}px`;
// target!.style.top = `${top}px`;
console.log("onDrag translate", dist);
target!.style.transform = transform;
}}
onDragEnd={({ target, isDrag, clientX, clientY }) => {
console.log("onDragEnd", target, isDrag);
}}
/* When resize or scale, keeps a ratio of the width, height. */
keepRatio={true}
/* resizable*/
/* Only one of resizable, scalable, warpable can be used. */
resizable={true}
throttleResize={0}
onResizeStart={({ target , clientX, clientY}) => {
console.log("onResizeStart", target);
}}
onResize={({
target, width, height,
dist, delta, direction,
clientX, clientY,
}: OnResize) => {
console.log("onResize", target);
delta[0] && (target!.style.width = `${width}px`);
delta[1] && (target!.style.height = `${height}px`);
}}
onResizeEnd={({ target, isDrag, clientX, clientY }) => {
console.log("onResizeEnd", target, isDrag);
}}
/* scalable */
/* Only one of resizable, scalable, warpable can be used. */
scalable={true}
throttleScale={0}
onScaleStart={({ target, clientX, clientY }) => {
console.log("onScaleStart", target);
}}
onScale={({
target, scale, dist, delta, transform,
clientX, clientY,
}: OnScale) => {
console.log("onScale scale", scale);
target!.style.transform = transform;
}}
onScaleEnd={({ target, isDrag, clientX, clientY }) => {
console.log("onScaleEnd", target, isDrag);
}}
/* rotatable */
rotatable={true}
throttleRotate={0}
onRotateStart={({ target, clientX, clientY }) => {
console.log("onRotateStart", target);
}}
onRotate={({
target,
delta, dist,
transform,
clientX, clientY,
}: onRotate) => {
console.log("onRotate", dist);
target!.style.transform = transform;
}}
onRotateEnd={({ target, isDrag, clientX, clientY }) => {
console.log("onRotateEnd", target, isDrag);
}}
/* warpable */
/* Only one of resizable, scalable, warpable can be used. */
/*
this.matrix = [
1, 0, 0, 0,
0, 1, 0, 0,
0, 0, 1, 0,
0, 0, 0, 1,
]
*/
warpable={true}
onWarpStart={({ target, clientX, clientY }) => {
console.log("onWarpStart", target);
}}
onWarp={({
target,
clientX,
clientY,
delta,
dist,
multiply,
transform,
}) => {
console.log("onWarp", target);
// target.style.transform = transform;
this.matrix = multiply(this.matrix, delta);
target.style.transform = `matrix3d(${this.matrix.join(",")})`;
}}
onWarpEnd={({ target, isDrag, clientX, clientY }) => {
console.log("onWarpEnd", target, isDrag);
}}
// Enabling pinchable lets you use events that
// can be used in draggable, resizable, scalable, and rotateable.
pinchable={true}
onPinchStart={({ target, clientX, clientY, datas }) => {
// pinchStart event occur before dragStart, rotateStart, scaleStart, resizeStart
console.log("onPinchStart");
}}
onPinch={({ target, clientX, clientY, datas }) => {
// pinch event occur before drag, rotate, scale, resize
console.log("onPinch");
}}
onPinchEnd={({ isDrag, target, clientX, clientY, datas }) => {
// pinchEnd event occur before dragEnd, rotateEnd, scaleEnd, resizeEnd
console.log("onPinchEnd");
}}
/>
);
}
```
## ⚙️ Developments
### `npm start`
The main project was made with `react` and I used [`react-simple-compat`](https://github.com/daybrush/react-simple-compat) to make it lighter with umd.
For development and testing, check in [packages/react-moveable](https://github.com/daybrush/moveable/blob/master/packages/react-moveable).
```bash
$ cd packages/react-moveable
$ npm i
$ npm start
```
Runs the app in the development mode.
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
### Files related to major features.
* Ables: https://github.com/daybrush/moveable/tree/master/packages/react-moveable/src/react-moveable/ables
* Calculate Matrix Stack: https://github.com/daybrush/moveable/blob/master/packages/react-moveable/src/react-moveable/utils.ts
(`calculateElementInfo` function)
* Render Moveable Controls: https://github.com/daybrush/moveable/blob/master/packages/react-moveable/src/react-moveable/MoveableManager.tsx
* Render Moveable Group: https://github.com/daybrush/moveable/blob/master/packages/react-moveable/src/react-moveable/MoveableGroup.tsx
## ⭐️ Show Your Support
Please give a ⭐️ if this project helped you!
## 👏 Contributing
If you have any questions or requests or want to contribute to `moveable` or other packages, please write the [issue](https://github.com/daybrush/moveable/issues) or give me a Pull Request freely.
## 🐞 Bug Report
If you find a bug, please report to us opening a new [Issue](https://github.com/daybrush/moveable/issues) on GitHub.
## 📝 License
This project is [MIT](https://github.com/daybrush/moveable/blob/master/LICENSE) licensed.
```
MIT License
Copyright (c) 2019 Daybrush
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.
```