react-beautiful-dnd/src/state/move-in-direction/move-to-next-index/move-to-next-index-types.js

Beautiful, accessible drag and drop for lists with React.js

// @flow
import { type Position } from 'css-box-model';
import type {
  DraggableId,
  DragImpact,
  DroppableDimension,
  DraggableDimensionMap,
  Viewport,
} from '../../../types';

export type Args = {|
  isMovingForward: boolean,
  draggableId: DraggableId,
  previousPageBorderBoxCenter: Position,
  previousImpact: DragImpact,
  droppable: DroppableDimension,
  draggables: DraggableDimensionMap,
  viewport: Viewport,
|};

export type Result = {|
  // the new page center position of the element
  pageBorderBoxCenter: Position,
  // the impact of the movement
  impact: DragImpact,
  // Any scroll that is required for the movement.
  // If this is present then the pageBorderBoxCenter and impact
  // will just be the same as the previous drag
  scrollJumpRequest: ?Position,
|};