Options
All
  • Public
  • Public/Protected
  • All
Menu

元素拖拽类

Hierarchy

  • Sortable

Index

Constructors

constructor

  • Parameters

    Returns Sortable

Properties

Private _dragStartId

_dragStartId: number

Private _dragStartTimer

_dragStartTimer: number

Private _ignoreWhileAnimating

_ignoreWhileAnimating: EventTarget = null

Private _lastX

_lastX: number

Private _lastY

_lastY: number

Private _loopId

_loopId: number

Private animationCallbackId

animationCallbackId: number

Private animationStates

animationStates: SortableAnimationState[]

Private cloneId

cloneId: number

el

el: HTMLElement

拖拽绑定的最外层的html元素

lastPutMode

lastPutMode: any

multiDrag

multiDrag: any

Private nativeDraggable

nativeDraggable: boolean

私有变量 nativeDraggable 是否支持拖拽

options

配置选项

plugins

plugins: SortablePluginBase[] = ...

插件实例

Static activeSortable

activeSortable: Sortable

当前激活饿sortable实例

Static clone

clone: HTMLElement

等于SortableUtils.cloneEl 有啥用.直接使用它不就可以了.还弄个这个东西

Static eventCanceled

eventCanceled: any

Static ghost

ghost: any

等于SortableUtils.ghostEl 有啥用.直接使用它不就可以了.还弄个这个东西

Static supportPointer

supportPointer: boolean

Static version

version: string = ...

Methods

Private _appendGhost

  • _appendGhost(): void
  • Returns void

Private _delayedDragTouchMoveHandler

  • _delayedDragTouchMoveHandler(e: TouchEvent | PointerEvent): void
  • Parameters

    • e: TouchEvent | PointerEvent

    Returns void

Private _disableDelayedDragEvents

  • _disableDelayedDragEvents(): void
  • Returns void

Private _disableDelayedDragHandler

  • _disableDelayedDragHandler(): void
  • Returns void

Private _disableDraggable

  • _disableDraggable(el: any): void
  • 只是把 el的属性draggable =false

    Parameters

    • el: any

    Returns void

Private _dragStarted

  • _dragStarted(fallback: any, evt: any): void
  • Parameters

    • fallback: any
    • evt: any

    Returns void

Private _emulateDragOver

  • _emulateDragOver(): void
  • Returns void

Private _generateId

  • _generateId(el: HTMLElement): string
  • 生成一个id

    Parameters

    • el: HTMLElement

    Returns string

Private _getDirection

  • _getDirection(evt: any, target: any): Direction
  • 得到要加入的方向?

    Parameters

    • evt: any
    • target: any

    Returns Direction

Private _getInsertDirection

  • _getInsertDirection(target: HTMLElement): 1 | -1
  • Gets the direction dragEl must be swapped relative to target in order to make it 新增元素的方向 seem that dragEl has been "inserted" into that element's position

    Parameters

    • target: HTMLElement

      The target whose position dragEl is being inserted at

    Returns 1 | -1

    Direction dragEl must be swapped

Private _getSwapDirection

  • _getSwapDirection(evt: MouseEvent, target: any, targetRect: DOMRect, vertical: any, swapThreshold: any, invertedSwapThreshold: any, invertSwap: any, isLastTarget: any): number
  • 得到交换的方向

    Parameters

    • evt: MouseEvent
    • target: any
    • targetRect: DOMRect
    • vertical: any
    • swapThreshold: any
    • invertedSwapThreshold: any
    • invertSwap: any
    • isLastTarget: any

    Returns number

Private _ghostIsLast

  • _ghostIsLast(evt: MouseEvent, vertical: boolean, sortable: Sortable): boolean
  • 判断当前鼠标的位置位于最后的子节点的指定方向的区域内

    Parameters

    • evt: MouseEvent

      鼠标事件对象

    • vertical: boolean

      方向 true 垂直, 否则 水平

    • sortable: Sortable

      Sortable实例

    Returns boolean

    true,

Private _globalDragOver

  • _globalDragOver(evt: DragEvent): void
  • Parameters

    • evt: DragEvent

    Returns void

Private _hideClone

  • _hideClone(): void
  • 隐藏复制的 cloneEl

    Returns void

Private _isOutsideThisEl

  • _isOutsideThisEl(target: any): void
  • Parameters

    • target: any

    Returns void

Private _nulling

  • _nulling(): void
  • 清空各个全局的静态变量

    Returns void

Private _offMoveEvents

  • _offMoveEvents(): void
  • 关闭鼠标移动事件

    Returns void

Private _offUpEvents

  • _offUpEvents(): void
  • 关闭鼠标的释放的事件

    Returns void

Private _onDragStartHandler

  • _onDragStartHandler(evt: any, fallback: boolean): void
  • addEventListener 触发的dragstar回调函数

    Parameters

    • evt: any
    • fallback: boolean

    Returns void

Private _onDropHandler

  • _onDropHandler(evt?: any): void
  • 拖拽事件处理

    Parameters

    • Optional evt: any

    Returns void

Private _onMove

  • _onMove(fromEl: HTMLElement, toEl: HTMLElement, dragEl: HTMLElement, dragRect: DOMRect, targetEl: HTMLElement, targetRect: DOMRect, originalEvent: any, willInsertAfter: boolean): boolean | 1 | -1
  • 触发拖拽时移动的事件

    reutns

    返回true ; false:不允许移动 ; 1:方向 ; -1

    Parameters

    • fromEl: HTMLElement

      来源元素的父容器

    • toEl: HTMLElement

      目标容器

    • dragEl: HTMLElement

      拖拽的元素

    • dragRect: DOMRect
    • targetEl: HTMLElement

      目标容器

    • targetRect: DOMRect
    • originalEvent: any
    • willInsertAfter: boolean

    Returns boolean | 1 | -1

Private _onTapStartHandler

  • _onTapStartHandler(evt: TouchEvent | PointerEvent): void
  • mousedown pointerdown touchstart 触发鼠标/指标 点下事件

    Parameters

    • evt: TouchEvent | PointerEvent

    Returns void

Private _prepareDragStart

  • _prepareDragStart(evt: PointerEvent, touch: Touch, target: HTMLElement): void
  • 准备各种拖拽的初始化

    Parameters

    • evt: PointerEvent
    • touch: Touch
    • target: HTMLElement

    Returns void

Private _saveInputCheckedState

  • _saveInputCheckedState(root: HTMLElement): void
  • Parameters

    • root: HTMLElement

    Returns void

Private _showClone

  • _showClone(putSortable: any): void
  • Parameters

    • putSortable: any

    Returns void

Private _unsilent

  • _unsilent(): void
  • Returns void

addAnimationState

  • addAnimationState(state: SortableAnimationState): void
  • Parameters

    • state: SortableAnimationState

    Returns void

addPlugin

  • addPlugin(plug: SortablePluginBase): void
  • 增加插件

    Parameters

    • plug: SortablePluginBase

    Returns void

animate

  • animate(target: ISortableHtmlElement, prev: DOMRect, duration: number): void
  • Parameters

    • target: ISortableHtmlElement
    • prev: DOMRect
    • duration: number

    Returns void

animateAll

  • animateAll(callback?: Function): void
  • Parameters

    • Optional callback: Function

    Returns void

captureAnimationState

  • captureAnimationState(): void
  • Returns void

destroy

  • destroy(): void
  • Destroy

    Returns void

getPlugin

  • getPlugin(pluginName: string): SortablePluginBase
  • 获取插件

    Parameters

    • pluginName: string

    Returns SortablePluginBase

handleEvent

  • handleEvent(evt: MouseEvent): void
  • drop dragend dragenter dragover selectstart 的事件处理

    Parameters

    • evt: MouseEvent

    Returns void

Private initDragStartEvent

  • initDragStartEvent(evt: any, touch: any): void
  • Parameters

    • evt: any
    • touch: any

    Returns void

onDragOver

  • onDragOver(evt: any): boolean
  • 拖拽的组件再组件之上的处理函数

    Parameters

    • evt: any

    Returns boolean

onTouchMoveHandler

  • onTouchMoveHandler(evt: TouchEvent | PointerEvent): void
  • Parameters

    • evt: TouchEvent | PointerEvent

    Returns void

option

  • option(name: any, value: any): any
  • Set/get option

    Parameters

    • name: any
    • value: any

    Returns any

plugForEach

  • plugForEach(callback: (plug: SortablePluginBase) => boolean): void
  • 循环遍历插件

    Parameters

    • callback: (plug: SortablePluginBase) => boolean
        • (plug: SortablePluginBase): boolean
        • Parameters

          • plug: SortablePluginBase

          Returns boolean

    Returns void

removeAnimationState

  • removeAnimationState(target: ISortableHtmlElement): void
  • Parameters

    • target: ISortableHtmlElement

    Returns void

save

  • save(): void
  • Save the current sorting

    Returns void

sort

  • sort(order: any): void
  • Sorts the elements according to the array. 排序

    Parameters

    • order: any

      order of the items

    Returns void

toArray

  • toArray(): any[]
  • 序列化成字符串数组

    Returns any[]

Static mount

  • mount(plugin: ISortablePlugin): void
  • Mount a plugin to Sortable 装载插件

    Parameters

    • plugin: ISortablePlugin

    Returns void

Generated using TypeDoc