Options
All
  • Public
  • Public/Protected
  • All
Menu

react-sortly

Index

Type aliases

Variables

Functions

Type aliases

Connectable

Connectable: RefObject<Element | undefined> | Element

ContextProviderProps

ContextProviderProps: object

Type declaration

  • children: ReactElement | ReactElement[]

DragObject

DragObject: DragObjectWithType & object

ID

ID: number | string

ItemContext

ItemContext<D>: object

Type parameters

  • D

Type declaration

  • depth: number
  • id: ID
  • index: number
  • type: string | symbol

ItemData

ItemData<D>: object & D

Type parameters

  • D

ItemRendererProps

ItemRendererProps<D>: object

Type parameters

  • D

Type declaration

  • data: D
  • depth: number
  • id: D extends { id: ID; } ? D["id"] : ID
  • index: number

SortlyProps

SortlyProps<D>: object

Type parameters

  • D

Type declaration

  • children: function
  • Optional horizontal?: undefined | false | true
  • items: ItemData<D>[]
  • Optional maxDepth?: undefined | number
  • onChange: function
  • Optional threshold?: undefined | number
  • Optional type?: string | symbol | function

Variables

Const context

context: Context<object> = React.createContext<ItemContext>({})

Functions

Const ContextProvider

  • Parameters

    Returns Element

Sortly

  • Type parameters

    • D

    Parameters

    Returns Element

Const add

  • add<T>(items: T[], data: Optional<T, "depth"> | Optional<T, "depth">[]): T[]

  • Type parameters

    Parameters

    • items: T[]
    • data: Optional<T, "depth"> | Optional<T, "depth">[]

    Returns T[]

Const buildTree

  • buildTree<T>(items: ItemData<T>[], depth?: number): (T & object)[]

  • Type parameters

    • T: ObjectLiteral

    Parameters

    • items: ItemData<T>[]
    • Default value depth: number = 0

    Returns (T & object)[]

Const convert

  • convert<T>(items: T[], parentId?: null | ID, depth?: undefined | number): ItemData<T>[]

  • Type parameters

    • T: ObjectLiteral & object

    Parameters

    • items: T[]
    • Optional parentId: null | ID
    • Optional depth: undefined | number

    Returns ItemData<T>[]

Const findDeepestDescendant

  • findDeepestDescendant<T>(items: T[], index: number): null | T

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns null | T

Const findDescendants

  • findDescendants<T>(items: T[], index: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns T[]

Const findNextSibling

  • findNextSibling<T>(items: T[], index: number): null | T

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns null | T

Const findParent

  • findParent<T>(items: T[], index: number): null | T

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns null | T

Const findPrevSibling

  • findPrevSibling<T>(items: T[], index: number): null | T

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns null | T

Const flatten

  • flatten<T>(items: T[]): (object & object)[]

  • Type parameters

    Parameters

    • items: T[]

    Returns (object & object)[]

Const getSiblings

  • getSiblings<T>(items: T[], index: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns T[]

Const insert

  • insert<T>(items: T[], data: Optional<T, "depth"> | Optional<T, "depth">[], targetIndex: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • data: Optional<T, "depth"> | Optional<T, "depth">[]
    • targetIndex: number

    Returns T[]

Const isClosestOf

  • isClosestOf<T>(items: T[], index: number, descendantIndex: number): boolean

  • Type parameters

    Parameters

    • items: T[]
    • index: number
    • descendantIndex: number

    Returns boolean

Const isDescendantOf

  • isDescendantOf<T>(items: T[], index: number, closestIndex: number): boolean

  • Type parameters

    Parameters

    • items: T[]
    • index: number
    • closestIndex: number

    Returns boolean

Const isNextSibling

  • isNextSibling<T>(items: T[], index: number, siblingIndex: number): boolean

  • Type parameters

    Parameters

    • items: T[]
    • index: number
    • siblingIndex: number

    Returns boolean

Const isPrevSibling

  • isPrevSibling<T>(items: T[], index: number, siblingIndex: number): boolean

  • Type parameters

    Parameters

    • items: T[]
    • index: number
    • siblingIndex: number

    Returns boolean

Const move

  • move<T>(items: T[], sourceIndex: number, targetIndex: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • sourceIndex: number
    • targetIndex: number

    Returns T[]

Const remove

  • remove<T>(items: T[], index: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • index: number

    Returns T[]

Const updateDepth

  • updateDepth<T>(items: T[], index: number, depth: number, maxDepth?: number): T[]

  • Type parameters

    Parameters

    • items: T[]
    • index: number
    • depth: number
    • Default value maxDepth: number = Infinity

    Returns T[]

useDrag

  • useDrag<DragObject, DropResult, CollectedProps>(spec?: Partial<DragSourceHookSpec<DragObject & object, DropResult, CollectedProps>>): [CollectedProps, ConnectDragSource, ConnectDragPreview]

  • Type parameters

    • DragObject: ObjectLiteral

    • DropResult

    • CollectedProps

    Parameters

    • Optional spec: Partial<DragSourceHookSpec<DragObject & object, DropResult, CollectedProps>>

    Returns [CollectedProps, ConnectDragSource, ConnectDragPreview]

useDraggingItem

  • useDraggingItem(): undefined | null | object & object

  • Returns undefined | null | object & object

useDrop

  • useDrop<DragObject, DropResult, CollectedProps>(spec?: Partial<DropTargetHookSpec<DragObject, DropResult, CollectedProps>>): [CollectedProps, ConnectDropTarget]

  • Type parameters

    • DragObject: DragObjectWithType

    • DropResult

    • CollectedProps

    Parameters

    • Optional spec: Partial<DropTargetHookSpec<DragObject, DropResult, CollectedProps>>

    Returns [CollectedProps, ConnectDropTarget]

useIsClosestDragging

  • useIsClosestDragging(index?: undefined | number): boolean

  • Parameters

    • Optional index: undefined | number

    Returns boolean

useItem

  • useItem<D>(): object

  • Type parameters

    • D

    Returns object

    • data: D
    • depth: number
    • id: D extends { id: ID; } ? D["id"] : ID
    • index: number

useItems

  • useItems<D>(): D[]

  • Type parameters

    Returns D[]

Generated using TypeDoc