Utilização

Add haptic feedback to a gesture.

tsx
// Add haptic feedback to a gesture.
import { Box, haptics, pan, type Callbacks, type PanChangeEvent, type PanEvent } from 'kuito';

// Shared feedback for every draggable in the app.
const feedback: Callbacks<PanEvent, PanChangeEvent> = {
  onStart: () => void haptics.selection(),
  onEnd: (_, success) => void (success && haptics.impact('light')),
};

<Box gestures={[pan({ axis: 'x', ...feedback })]} />;

Declaração do tipo

ts
export interface Callbacks<Event, Change> {
  /** It activated. */
  onStart?: (event: Event) => void;
  /** It moved, with the change since the last move. */
  onChange?: (event: Change) => void;
  /** It ended after activating: `success` is false when it was cancelled. */
  onEnd?: (event: Event, success: boolean) => void;
}

Membros 3

NomeTipoObrigatórioDescrição
onStart(event: Event) => voidNãoIt activated.
onChange(event: Change) => voidNãoIt moved, with the change since the last move.
onEnd(event: Event, success: boolean) => voidNãoIt ended after activating: success is false when it was cancelled.
onStart — assinaturas de método

Assinaturas

ts
(event: Event): void

Parâmetros

NomeTipoObrigatórioDescrição
eventEventSim—

Devolve

void

onChange — assinaturas de método

Assinaturas

ts
(event: Change): void

Parâmetros

NomeTipoObrigatórioDescrição
eventChangeSim—

Devolve

void

onEnd — assinaturas de método

Assinaturas

ts
(event: Event, success: boolean): void

Parâmetros

NomeTipoObrigatórioDescrição
eventEventSim—
successbooleanSim—

Devolve

void

Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.