Skip to main content
Foldkit
On this pageFunctions

Ui/DragAndDrop/test

Functions

resolveKeyboardMove

functionsource
/**
 * Returns Story steps that resolve a pending `ResolveKeyboardMove` to the
 *  supplied container and index, then resolve `FocusItem` for `itemId`.
 * 
 *  The steps fail if either Command is missing or multiple keyboard moves are
 *  pending. Unrelated Commands stay pending.
 */
(__namedParameters: ResolveKeyboardMoveInput): Readonly<{
  _tag: "StoryStepsStep"
  steps: readonly Array<StoryStep<any, any, any>>
}>

settleFocus

functionsource
/**
 * Returns a Story step that resolves `FocusItem({ itemId })` after a keyboard
 *  drop, cancellation, or move. The step fails if no matching Command is pending
 *  and leaves unrelated Commands pending.
 */
(__namedParameters: SettleFocusInput): (simulation: StorySimulation<Model, Message, OutMessage>) => StorySimulation<Model, Message, OutMessage>

Types

ResolveKeyboardMoveInput

typesource
/** The dragged item and target position supplied to resolveKeyboardMove. */
type ResolveKeyboardMoveInput = Readonly<{
  itemId: string
  targetContainerId: string
  targetIndex: number
}>

SettleFocusInput

typesource
/** Identifies the item whose focus Command settleFocus resolves. */
type SettleFocusInput = Readonly<{
  itemId: string
}>