Neatly Positioned Magazines

    preact-moveable
    TypeScript icon, indicating that this package has built-in type declarations

    0.28.0 • Public • Published

    Preact Moveable

    npm version Travis (.org)

    A Preact 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

    $ npm i preact-moveable

    📄 Documents

    🚀 How to use

    import Moveable from "preact-moveable";
    
    render() {
        return (
            <Moveable
                target={document.querySelector(".target")}
                container={null}
                origin={true}
    
                /* Resize, Scale event edges */
                edge={false}
    
                /* draggable */
                draggable={true}
                throttleDrag={0}
                onDragStart={({ target, clientX, clientY }) => {
                    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,
                    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

    Runs the app in the development mode.
    Open demo/index.html file.

    ⭐️ 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.

    🐞 Bug Report

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

    📝 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.
    

    Install

    npm i preact-moveable

    DownloadsWeekly Downloads

    137

    Version

    0.28.0

    License

    MIT

    Unpacked Size

    1.1 MB

    Total Files

    25

    Last publish

    Collaborators

    • avatar