Skip to content

@neosjs/moveable-panel ​

可移动、可缩放的浮动面板组件。固定定位并挂载到 body,按住头部或内容区拖动改变位置(限制在视口内),开启 resizeable 后可通过右下角手柄调整尺寸(限制在 min/max 之间)。

安装 ​

sh
pnpm add @neosjs/moveable-panel
sh
npm i @neosjs/moveable-panel
sh
yarn add @neosjs/moveable-panel

快速上手 ​

width / height 必填,默认显示带标题和关闭按钮的头部。

vue
<script setup lang="ts">
import { MoveablePanel } from '@neosjs/moveable-panel'
import { ref } from 'vue'

const show = ref(true)
</script>

<template>
  <button @click="show = true">
    显示面板
  </button>

  <MoveablePanel
    v-if="show"
    :width="300"
    :height="200"
    title="面板标题"
    @on-close="show = false"
  >
    <p>面板内容,按住此处或头部即可拖动</p>
  </MoveablePanel>
</template>

缩放 ​

resizeable 开启后,拖动面板右下角的斜向手柄可同时调整宽高。

vue
<MoveablePanel
  :width="300"
  :height="200"
  resizeable
  :min-width="200"
  :max-width="600"
  @on-resize="(w, h) => console.log(w, h)"
>
  <p>内容</p>
</MoveablePanel>

TIP

left / top 支持负值:传入负数时表示相对视口右侧/底部的偏移(如 left: -20 表示面板右边缘距视口右侧 20px)。

Props ​

参数类型默认值说明
widthnumber必填面板宽度(px)
heightnumber必填面板高度(px)
min-widthnumber20缩放时的最小宽度(px)
min-heightnumber20缩放时的最小高度(px)
max-widthnumber1500缩放时的最大宽度(px)
max-heightnumber1500缩放时的最大高度(px)
leftnumber0初始横坐标,负值表示距视口右侧的偏移
topnumber0初始纵坐标,负值表示距视口底部的偏移
titlestring''头部标题(未使用 header 插槽时显示)
moveablebooleantrue是否可拖拽移动
resizeablebooleanfalse是否可调整大小
closablebooleantrue是否显示头部关闭按钮
append-tostring'body'挂载的目标容器

Emits ​

事件名参数说明
onClose—点击头部关闭按钮时触发
onDragMove(x: number, y: number)拖动面板时触发,返回当前坐标
onResize(width: number, height: number)调整面板大小时触发,返回当前尺寸

Slots ​

插槽名说明
header自定义头部,替代默认的标题与关闭按钮
default面板内容
footer底部区域