For AI agents: the complete documentation index is available at /next/zh/llms.txt, the full documentation bundle is available at /next/zh/llms-full.txt, and this page is available as Markdown at /next/zh/ui/components/draggable.md.
lynx-ui logo
lynx-ui
  • 简体中文
  • Draggable

    一个适用于 ReactLynx 的无样式拖拽组件,通过主线程执行提供拖拽基础能力。
    Info

    你可以查看源码来了解它的运行原理,也欢迎大家提 PR 来丰富其能力。

    基本用法

    Draggable 支持两种手势模式:immediate(触摸后立即开始拖拽)和 longpress(长按后开始拖拽)。 你也可以控制拖拽结束后的位置是重置,还是保留当前的 transform 位置。

    示例

    带边界限制

    可拖拽区域可以通过 min(max)TranslateX/Y 属性进行限制。

    结构

    当整个组件都需要响应拖拽时,使用 <Draggable>。

    <Draggable>
      {/* Your content */}
    </Draggable>

    当只有特定区域需要响应拖拽时,使用 <DraggableRoot> 和 <DraggableArea>。

    <DraggableRoot>
      <DraggableArea />
    </DraggableRoot>

    组件 API

    Draggable

    allowedDirectioniOSAndroidHarmony
    类型Directions·默认值'all'
    允许的拖拽方向
    childreniOSAndroidHarmony
    类型ReactNode
    子节点
    classNameiOSAndroidHarmony
    类型string
    类名
    debugLogiOSAndroidHarmony
    类型boolean·默认值false
    显示调试日志,发现问题时开启。
    draggablePropsiOSAndroidHarmony
    类型ViewProps
    可拖拽组件的额外属性。接受普通 view 的所有属性。
    enableDraggingiOSAndroidHarmony
    类型boolean·默认值true
    组件是否可拖拽
    idiOSAndroidHarmony
    类型string
    id
    maxTranslateXiOSAndroidHarmony
    类型number
    X 轴方向 translate 的最大值
    maxTranslateYiOSAndroidHarmony
    类型number
    Y 轴方向 translate 的最大值
    minTranslateXiOSAndroidHarmony
    类型number
    X 轴方向 translate 的最小值
    minTranslateYiOSAndroidHarmony
    类型number
    Y 轴方向 translate 的最小值
    MTSRefiOSAndroidHarmony
    类型RefObject<DraggableRef>
    main-thread:ref
    onDragEndiOSAndroidHarmony
    类型(translate: Point) => void
    当拖拽结束时触发
    onDraggingiOSAndroidHarmony
    类型(translate: Point) => void
    当拖拽进行时触发
    onDragStartiOSAndroidHarmony
    类型(pagePoint: Point) => void
    当拖拽开始时触发
    onMTSDragEndiOSAndroidHarmony
    类型(translate: Point, event: MouseEvent | TouchEvent) => void
    当拖拽结束时触发。在主线程运行,可以执行更及时的 UI 操作。请确保传入的 handler 是主线程函数,即带有 'main thread' 标记的函数。
    onMTSDraggingiOSAndroidHarmony
    类型(translate: Point, event: MouseEvent | TouchEvent) => void
    当拖拽结束时触发。在主线程运行,可以执行更及时的 UI 操作。请确保传入的 handler 是主线程函数,即带有 'main thread' 标记的函数。
    onMTSDragStartiOSAndroidHarmony
    类型(pagePoint: Point, event: MouseEvent | TouchEvent) => void
    当拖拽进行时触发。在主线程运行,可以执行更及时的 UI 操作。请确保传入的 handler 是主线程函数,即带有 'main thread' 标记的函数。
    resetOnEndiOSAndroidHarmony
    类型boolean
    当拖拽结束时复位 transform
    styleiOSAndroidHarmony
    类型CSSProperties
    样式
    triggeriOSAndroidHarmony
    类型longpress | immediate·默认值'longpress'
    触发拖拽的方式

    DraggableArea

    childreniOSAndroidHarmony
    类型ReactNode
    子节点
    classNameiOSAndroidHarmony
    类型string
    类名
    idiOSAndroidHarmony
    类型string
    id
    styleiOSAndroidHarmony
    类型CSSProperties
    样式

    DraggableRef

    MTSResetInternalTranslateValues
    类型() => void
    重置可拖动组件的内部状态,例如起始触摸点和当前平移量。如果你在组件外部控制 transform,此方法可用于外部重置组件状态。
    MTSSetOtherStyles
    类型(styles: Record<string, string>) => void
    在可拖动元素上设置一组 CSS 样式。可用于设置与可拖动行为不直接相关的样式。
    MTSSetTransform
    类型(x: number, y: number) => void
    以编程方式设置可拖动元素的 transform 样式。从外部设置 'transform' 需通过此方法,否则会破坏内部逻辑。
    除非另有说明,本项目采用知识共享署名 4.0 国际许可协议进行许可,代码示例采用 Apache License 2.0 许可协议进行许可。