BlockSuite API Documentation / @blocksuite/block-std / AutoScroll
Type Alias: AutoScroll<PayloadEntity, PayloadFrom>
AutoScroll<
PayloadEntity
,PayloadFrom
> =object
Defined in: packages/framework/block-std/src/extension/dnd/index.ts:190
Type Parameters
PayloadEntity
PayloadEntity
extends DragEntity
PayloadFrom
PayloadFrom
extends DragFrom
Properties
canScroll()?
optional
canScroll: (args
) =>void
Defined in: packages/framework/block-std/src/extension/dnd/index.ts:195
Parameters
args
ElementDragEventBaseArgs
<DragPayload
<PayloadEntity
, PayloadFrom
>>
Returns
void
element
element:
HTMLElement
Defined in: packages/framework/block-std/src/extension/dnd/index.ts:194
getAllowedAxis()?
optional
getAllowedAxis: (args
) =>ReturnType
<Required
<OriginalAutoScrollOption
>["getAllowedAxis"
]>
Defined in: packages/framework/block-std/src/extension/dnd/index.ts:198
Parameters
args
ElementDragEventBaseArgs
<DragPayload
<PayloadEntity
, PayloadFrom
>>
Returns
ReturnType
<Required
<OriginalAutoScrollOption
>["getAllowedAxis"
]>
getConfiguration()?
optional
getConfiguration: (args
) =>ReturnType
<Required
<OriginalAutoScrollOption
>["getConfiguration"
]>
Defined in: packages/framework/block-std/src/extension/dnd/index.ts:201
Parameters
args
ElementDragEventBaseArgs
<DragPayload
<PayloadEntity
, PayloadFrom
>>
Returns
ReturnType
<Required
<OriginalAutoScrollOption
>["getConfiguration"
]>