@atlaskit/pragmatic-drag-and-drop-auto-scroll
Version:
An optional Pragmatic drag and drop package that enables automatic scrolling during a drag operation
51 lines (50 loc) • 1.81 kB
TypeScript
import type { AllDragTypes, Input } from '@atlaskit/pragmatic-drag-and-drop/types';
export type ElementGetFeedbackArgs<DragType extends AllDragTypes> = {
/**
* The users _current_ input
*/
input: Input;
/**
* The data associated with the entity being dragged
*/
source: DragType['payload'];
/**
* The element trying to be scrolled
*/
element: Element;
};
export type WindowGetFeedbackArgs<DragType extends AllDragTypes> = Omit<ElementGetFeedbackArgs<DragType>, 'element'>;
export type Spacing = {
top: number;
right: number;
bottom: number;
left: number;
};
export type Edge = keyof Spacing;
export type EngagementHistoryEntry = {
timeOfEngagementStart: number;
};
export type InternalConfig = {
startHitboxAtPercentageRemainingOfElement: Spacing;
maxScrollAtPercentageRemainingOfHitbox: Spacing;
maxPixelScrollPerSecond: number;
timeDampeningDurationMs: number;
maxMainAxisHitboxSize: number;
};
export type PublicConfig = Partial<{
maxScrollSpeed: 'standard' | 'fast';
}>;
export type ElementAutoScrollArgs<DragType extends AllDragTypes> = {
element: Element;
canScroll?: (args: ElementGetFeedbackArgs<DragType>) => boolean;
getAllowedAxis?: (args: ElementGetFeedbackArgs<DragType>) => AllowedAxis;
getConfiguration?: (args: ElementGetFeedbackArgs<DragType>) => PublicConfig;
};
export type WindowAutoScrollArgs<DragType extends AllDragTypes> = {
canScroll?: (args: WindowGetFeedbackArgs<DragType>) => boolean;
getAllowedAxis?: (args: WindowGetFeedbackArgs<DragType>) => AllowedAxis;
getConfiguration?: (args: WindowGetFeedbackArgs<DragType>) => PublicConfig;
};
export type Side = 'start' | 'end';
export type Axis = 'vertical' | 'horizontal';
export type AllowedAxis = Axis | 'all';