Function KanbanView

Template: Data,

Payload, ColumnType

  • KanbanView<Data, Payload, ColumnType>(props, ref): Element

  • KanbanViewInternal is a React component that renders a kanban board view. It displays items in columns and allows dragging and dropping of items between columns.

    Type Parameters

    • Data extends unknown = any

      The type of data associated with each item in the kanban board columns.

    • Payload extends unknown = any

      The type of payload to be passed to various event handlers.

    • ColumnType = any

      The type of column identifier.

    Parameters

    • props: IKanbanViewProps<Data, Payload, ColumnType>

      The props object.

    • ref: Ref<HTMLDivElement>

      A ref object to attach to the root element of the component.

    Returns Element

    • The rendered KanbanViewInternal component.

Methods

enableScrollOnDrag

Methods

enableScrollOnDrag

  • enableScrollOnDrag(ref, __namedParameters?): (() => Function)

  • Parameters

    • ref: MutableRefObject<undefined | HTMLDivElement>
    • __namedParameters: {
          speed?: number;
          threshold?: number;
      } = {}
      • Optionalspeed?: number
      • Optionalthreshold?: number

    Returns (() => Function)

      • (): Function

      • Returns Function

    Example

    useEffect(KanbanViewInternal.enableScrollOnDrag(ref), [])

Settings

Member Visibility

On This Page

Methods