moveable README

The project's README from github.com/daybrush/moveable. As one markdown file: README.md.

Moveable

npm version Github actions React Preact Angular Vue Vue 3 Svelte Lit

Moveable is Draggable, Resizable, Scalable, Rotatable, Warpable, Pinchable, Groupable, Snappable

Github / Demo / Storybook / API / Main Project

Moveable
Draggable Resizable Scalable Rotatable
Warpable Pinchable Groupable Snappable
Clippable Roundable OriginDraggable Selecto

🔥 Features

⚙️ Installation

npm

$ npm i moveable

scripts

<script src="//daybrush.com/moveable/release/latest/dist/moveable.min.js"></script>

📄 Documents

🚀 How to use

import Moveable from "moveable";

const moveable = new Moveable(document.body, {
    target: document.querySelector(".target"),
    // If the container is null, the position is fixed. (default: parentElement(document.body))
    container: document.body,
    draggable: true,
    resizable: true,
    scalable: true,
    rotatable: true,
    warpable: true,
    // Enabling pinchable lets you use events that
    // can be used in draggable, resizable, scalable, and rotateable.
    pinchable: true, // ["resizable", "scalable", "rotatable"]
    origin: true,
    keepRatio: true,
    // Resize, Scale Events at edges.
    edge: false,
    throttleDrag: 0,
    throttleResize: 0,
    throttleScale: 0,
    throttleRotate: 0,
});
/* draggable */
moveable.on("dragStart", ({ target, clientX, clientY }) => {
    console.log("onDragStart", target);
}).on("drag", ({
    target, transform,
    left, top, right, bottom,
    beforeDelta, beforeDist, delta, dist,
    clientX, clientY,
}) => {
    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;
}).on("dragEnd", ({ target, isDrag, clientX, clientY }) => {
    console.log("onDragEnd", target, isDrag);
});

/* resizable */
moveable.on("resizeStart", ({ target, clientX, clientY }) => {
    console.log("onResizeStart", target);
}).on("resize", ({ target, width, height, dist, delta, clientX, clientY }) => {
    console.log("onResize", target);
    delta[0] && (target!.style.width = `${width}px`);
    delta[1] && (target!.style.height = `${height}px`);
}).on("resizeEnd", ({ target, isDrag, clientX, clientY }) => {
    console.log("onResizeEnd", target, isDrag);
});

/* scalable */
moveable.on("scaleStart", ({ target, clientX, clientY }) => {
    console.log("onScaleStart", target);
}).on("scale", ({
    target, scale, dist, delta, transform, clientX, clientY,
}: OnScale) => {
    console.log("onScale scale", scale);
    target!.style.transform = transform;
}).on("scaleEnd", ({ target, isDrag, clientX, clientY }) => {
    console.log("onScaleEnd", target, isDrag);
});

/* rotatable */
moveable.on("rotateStart", ({ target, clientX, clientY }) => {
    console.log("onRotateStart", target);
}).on("rotate", ({ target, beforeDelta, delta, dist, transform, clientX, clientY }) => {
    console.log("onRotate", dist);
    target!.style.transform = transform;
}).on("rotateEnd", ({ target, isDrag, clientX, clientY }) => {
    console.log("onRotateEnd", target, isDrag);
});

/* warpable */
this.matrix = [
    1, 0, 0, 0,
    0, 1, 0, 0,
    0, 0, 1, 0,
    0, 0, 0, 1,
];
moveable.on("warpStart", ({ target, clientX, clientY }) => {
    console.log("onWarpStart", target);
}).on("warp", ({
    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(",")})`;
}).on("warpEnd", ({ target, isDrag, clientX, clientY }) => {
    console.log("onWarpEnd", target, isDrag);
});

/* pinchable */
// Enabling pinchable lets you use events that
// can be used in draggable, resizable, scalable, and rotateable.
moveable.on("pinchStart", ({ target, clientX, clientY }) => {
    // pinchStart event occur before dragStart, rotateStart, scaleStart, resizeStart
    console.log("onPinchStart");
}).on("pinch", ({ target, clientX, clientY, datas }) => {
    // pinch event occur before drag, rotate, scale, resize
    console.log("onPinch");
}).on("pinchEnd", ({ isDrag, target, clientX, clientY, datas }) => {
    // pinchEnd event occur before dragEnd, rotateEnd, scaleEnd, resizeEnd
    console.log("onPinchEnd");
});

📦 Packages

⚙️ Developments

The moveable repo is managed as a monorepo with yarn.

yarn config set registry https://registry.npmjs.org/

The main project was made with react and I used croact to make it lighter with umd.

For development and testing, check in packages/react-moveable.

npm run storybook

$ yarn
$ npm run packages:build
$ npm run storybook

Runs the app in the development mode.
Open http://localhost:6006 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

⭐️ 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 or give me a Pull Request freely.

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

🐞 Bug Report

If you find a bug, please report to us opening a new Issue on GitHub.

Sponsors

Open Collective Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

📝 License

This project is MIT 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.

moveable (daybrush/moveable)

Searching Database…

10.8K ·GitHub
Moveable
Что это такое?Moveable — это библиотека на JavaScript/TypeScript, которая делает DOM- и SVG-элементы перетаскиваемыми, изменяемыми по размеру, масштабируемыми, поворачиваемыми, деформируемыми, масштабируемыми жестом щипка, объединяемыми в группы и прилипающими к направляющим, а также включает готовые компоненты для React, Vue, Vue 3, Angular, Svelte, Lit и Preact.
Это один компонент или набор пакетов под разные фреймворки?Это монорепозиторий, в основе которого лежит базовый компонент на чистом JS (moveable), а также тонкие обёртки под фреймворки, которые публикуются на npm отдельно: react-moveable, vue-moveable, vue3-moveable, ngx-moveable, svelte-moveable, lit-moveable и preact-moveable.
Как подключить это к своему проекту?Установите npm-пакет, подходящий вашему стеку (например, react-moveable, vue-moveable, vue3-moveable, ngx-moveable), и оберните нужный элемент компонентом Moveable.
Тянет ли это за собой другие библиотеки при работе?У базового пакета практически нет сторонних зависимостей времени выполнения, кроме tslib, поэтому он остаётся легковесным.
Есть ли подвох с именами, о котором стоит знать?Все контрольные рамки Moveable и классы элементов с суффиксом «able» используют префикс moveable-, поэтому не стоит применять этот же префикс к имени класса своего целевого элемента, иначе возникнет конфликт.
Работает ли это во всех основных браузерах?Да, библиотека рассчитана на основные браузеры и также умеет работать с 3D-трансформациями CSS, а не только с базовым 2D-позиционированием.
Поддерживает ли это SVG-элементы, а не только HTML-блоки div?Да, Moveable явно поддерживает SVG-элементы, такие как svg, path, line, ellipse, g и rect, помимо обычных HTML-элементов.
Можно ли перемещать несколько элементов вместе как одно целое?Да, функция Groupable позволяет перетаскивать, изменять размер, масштабировать и поворачивать несколько элементов вместе как одну группу.
Умеет ли это автоматически притягивать элементы к направляющим?Да, функция Snappable позволяет элементам прилипать к заданным направляющим при перетаскивании, изменении размера или повороте.
Зачем нужно столько отдельных npm-пакетов, а не один универсальный?Базовый компонент moveable обёрнут отдельно для каждого фреймворка (React, Vue, Vue 3, Angular, Svelte, Lit, Preact), чтобы каждая экосистема получала нативный и легковесный компонент, а не один общий адаптер.
What are similar projects?blobatar, canvas-ui, Libraries.dev, formily, mitosis, dnd-kit, taro, draggable
Which topics is it in?draggable, scalable, drag-and-drop, vue3, svelte, frontend-framework, ui-library, npm-package, svg, monorepo, component-library, vue
Creator
daybrush
Size
79.1 MB
Stars
10.8K
Updated
CommitDec 03Release0.53.0Dec 03
Age
7y
Commits · 90 Days