@neosjs/vue-dragresizable
可拖拽、可缩放的元素容器组件。为任意内容提供 8 个方向的缩放手柄与拖拽能力,支持网格吸附、锁定宽高比、限制在父容器内、最大化、轴约束与触摸操作。
TIP
带 beta 的版本为支持 Vue2 的版本;Vue3 项目请安装最新正式版(v1.2.0)。
安装
sh
pnpm add @neosjs/vue-dragresizablesh
npm i @neosjs/vue-dragresizablesh
yarn add @neosjs/vue-dragresizable快速上手
组件默认可拖拽、可缩放,通过 drag-selector 指定按住哪个区域拖动。
vue
<script setup lang="ts">
import VueDragresizable from '@neosjs/vue-dragresizable'
import { ref } from 'vue'
const width = ref(338)
const height = ref(250)
const left = ref(`calc(50% - ${width.value / 2}px)`)
const top = ref(`calc(50% - ${height.value / 2}px)`)
const handles = ref([
'tl',
'tm',
'tr',
'mr',
'br',
'bm',
'bl',
'ml'
])
</script>
<template>
<VueDragresizable
drag-selector=".drag-header"
:handles="handles"
:width="width"
:height="height"
:min-width="200"
:min-height="150"
:x="left"
:y="top"
>
<p class="drag-header">
<span>标题</span>
</p>
<p>这里是内容</p>
</VueDragresizable>
</template>全局注册
组件自带 install 方法,可全局注册,同时注册 VueDragresizable 与 vueDragresizable 两个组件名。
ts
import VueDragresizable from '@neosjs/vue-dragresizable'
import { createApp } from 'vue'
import App from './App.vue'
createApp(App).use(VueDragresizable).mount('#app')缩放手柄
handles 可传入 tl、tm、tr、mr、br、bm、bl、ml 的任意组合:
tl左上、tm顶部中间、tr右上mr右侧中间、ml左侧中间br右下、bm底部中间、bl左下
每个手柄都是具名插槽(与手柄同名),可自定义手柄内容。
Props
| 参数 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| width | number | string | — | 初始宽度,支持 'auto' |
| height | number | string | — | 初始高度,支持 'auto' |
| x / left | number | string | 0 | 初始横坐标,支持 calc() 等字符串 |
| y / top | number | string | 0 | 初始纵坐标 |
| min-width | number | 0 | 最小宽度 |
| min-height | number | 0 | 最小高度 |
| max-width | number | — | 最大宽度 |
| max-height | number | — | 最大高度 |
| active | boolean | true | 是否激活(激活时显示手柄) |
| draggable | boolean | true | 是否可拖拽 |
| resizable | boolean | true | 是否可缩放 |
| handles | string[] | ['tl','tm','tr','mr','br','bm','bl','ml'] | 显示的缩放手柄 |
| hide-handles | boolean | true | 是否隐藏手柄(隐藏后仍可缩放,可配合 CSS hover 显示) |
| round-handle | boolean | false | 手柄是否为圆角 |
| drag-selector | string | — | 拖拽生效的选择器,只有按住匹配元素才能拖动 |
| drag-cancel | string | — | 取消拖拽的选择器,按住匹配元素不触发拖动 |
| axis | 'x' | 'y' | 'both' | 'both' | 可拖动的方向轴 |
| grid | [number, number] | [1, 1] | 网格吸附,拖拽与缩放按网格步进 |
| lock-ratio | boolean | false | 是否锁定宽高比 |
| fit-parent | boolean | false | 是否限制在父容器内拖拽与缩放 |
| maximize | boolean | false | 是否最大化(铺满父容器,需 fit-parent) |
| scale | number | number[] | 1 | 元素缩放比例,用于修正拖拽距离 |
| z-index | string | number | 'auto' | z-index 层级 |
| prevent-deactivation | boolean | false | 点击组件外部时是否阻止取消激活 |
| disable-user-select | boolean | true | 拖拽时是否禁用文本选择 |
| enable-native-drag | boolean | false | 是否启用原生拖拽 |
| class-name | string | '' | 自定义容器类名 |
| class-name-draggable | string | 'neos-draggable' | 可拖拽状态类名 |
| class-name-resizable | string | 'neos-resizable' | 可缩放状态类名 |
| class-name-dragging | string | 'neos-dragging' | 拖拽中类名 |
| class-name-resizing | string | 'neos-resizing' | 缩放中类名 |
| class-name-active | string | 'neos-active' | 激活状态类名 |
| class-name-handle | string | 'neos-handle' | 手柄类名前缀 |
| on-drag-start | Function | — | 拖拽开始回调,返回 false 可阻止拖拽 |
| on-drag | Function | — | 拖拽过程回调,返回 false 可阻止移动 |
| on-resize-start | Function | — | 缩放开始回调,返回 false 可阻止缩放 |
| on-resize | Function | — | 缩放过程回调,返回 false 可阻止调整 |
Emits
所有事件回调参数均为同一个对象:{ eventName, left, top, width, height }(maximize 事件额外包含 state 字段)。
| 事件名 | 说明 |
|---|---|
| activated | 组件激活时触发 |
| deactivated | 组件失活时触发 |
| mounted | 组件挂载完成时触发 |
| destroyed | 组件销毁时触发 |
| resizeStart | 缩放开始时触发 |
| resizeMove / resizeing | 缩放过程中触发 |
| resizeEnd / resizeStop | 缩放结束时触发 |
| dragStart | 拖拽开始时触发 |
| dragMove / dragging | 拖拽过程中触发 |
| dragEnd / dragStop | 拖拽结束时触发 |
| maximize | 最大化状态切换时触发,state 为 true 表示最大化 |
Slots
| 插槽名 | 说明 |
|---|---|
| default | 元素内容 |
| tl / tm / tr / mr / br / bm / bl / ml | 各缩放手柄的自定义内容(插槽名与手柄名一致) |