LongPressOptions — Kuito Documentation

Usage

Read a long press location and duration.

This type is used by longPress

tsx

// Read a long press location and duration.
import { Box, longPress, signal, type LongPressEvent } from 'kuito';

const menuAt = signal<{ x: number; y: number } | null>(null);

// Opens a menu where the finger rests, once it has been held.
const open = (event: LongPressEvent) => {
  menuAt.value = { x: event.absoluteX, y: event.absoluteY };
};

<Box gestures={[longPress({ after: 400, onStart: open })]} height={64} />;

Type declaration

export interface LongPressOptions extends Common, Callbacks<LongPressEvent, LongPressEvent> {
  /** Milliseconds held before it activates; 500 by default. */
  after?: number;
  maxDistance?: number;
}

Members 7

Name	Type	Required	Description
`after`	`number`	No	Milliseconds held before it activates; 500 by default.
`maxDistance`	`number`	No	—
`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: LongPressEvent) => void`	No	It activated.
`onChange`	`(event: LongPressEvent) => void`	No	It moved, with the change since the last move.
`onEnd`	`(event: LongPressEvent, success: boolean) => void`	No	It ended after activating: `success` is false when it was cancelled.

onStart — method signatures

Signatures

(event: LongPressEvent): void

Parameters

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

Returns

void

onChange — method signatures

Signatures

(event: LongPressEvent): void

Parameters

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

Returns

void

onEnd — method signatures

Signatures

(event: LongPressEvent, success: boolean): void

Parameters

Name	Type	Required	Description
`event`	`LongPressEvent`	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.