FlingOptions — Kuito Documentation

Usage

Configure a directional flick.

tsx

// Configure a directional flick.
import { Box, fling, haptics, type FlingOptions } from 'kuito';

function swipeTo(direction: 'left' | 'right', action: () => void): FlingOptions {
  return {
    direction,
    hitArea: { horizontal: 20 },
    onEnd: (_, success) => {
      if (!success) return;
      void haptics.impact('light');
      action();
    },
  };
}

<Box
  gestures={[
    fling(swipeTo('left', () => console.log('archive'))),
    fling(swipeTo('right', () => console.log('pin'))),
  ]}
/>;

Type declaration

export interface FlingOptions extends Common, Callbacks<FlingEvent, FlingEvent> {
  /** Where it may go; right by default. */
  direction?: FlingDirection | readonly FlingDirection[];
}

Members 6

Name	Type	Required	Description
`direction`	`FlingDirection \| readonly FlingDirection[]`	No	Where it may go; right by default.
`disabled`	`boolean`	No	Ignores touches, like a disabled `Pressable`.
`hitArea`	`HitArea`	No	Insets of the area that takes touches: one for every edge, or by edge.
`onStart`	`(event: PositionEvent) => void`	No	It activated.
`onChange`	`(event: PositionEvent) => void`	No	It moved, with the change since the last move.
`onEnd`	`(event: PositionEvent, success: boolean) => void`	No	It ended after activating: `success` is false when it was cancelled.

onStart — method signatures

Signatures

(event: PositionEvent): void

Parameters

Name	Type	Required	Description
`event`	`PositionEvent`	Yes	—

Returns

void

onChange — method signatures

Signatures

(event: PositionEvent): void

Parameters

Name	Type	Required	Description
`event`	`PositionEvent`	Yes	—

Returns

void

onEnd — method signatures

Signatures

(event: PositionEvent, success: boolean): void

Parameters

Name	Type	Required	Description
`event`	`PositionEvent`	Yes	—
`success`	`boolean`	Yes	—

Returns

void

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.