Utilisation

Recognize a directional swipe.

Ce type est utilisé par fling

tsx
// Recognize a directional swipe.
import { Box, fling, signal } from 'kuito';

const page = signal(0);

const swipe = fling({
  direction: ['left', 'right'],
  onEnd: (event, success) => {
    if (success) page.value += 1;
  },
});

<Box gestures={[swipe]} />;

Déclaration du type

ts
export interface Gesture {
  readonly __kuitoGesture: 'gesture';
  readonly type: GestureType;
  readonly kind: GestureKind;
  readonly config: Readonly<Record<string, unknown>>;
  readonly callbacks: Readonly<Callbacks<never, never>>;
  /** How the motion values following it let go when it ends. */
  readonly releasing?: Animation<unknown>;
  /**
   * The same gesture, letting go with `animation`: each follower runs it with
   * the gesture's velocity, toward its own home (its first value) unless the
   * animation names a target.
   */
  release(animation: Animation<unknown>): this;
  /** 1 while it is active, 0 otherwise. */
  readonly active: GestureSource;
}

Membres 7

NomTypeRequisDescription
typelecture seuleGestureTypeOui—
kindlecture seuleGestureKindOui—
configlecture seuleReadonly<Record<string, unknown>>Oui—
callbackslecture seuleReadonly<Callbacks<never, never>>Oui—
releasinglecture seuleAnimation<unknown>NonHow the motion values following it let go when it ends.
release(animation: Animation<unknown>) => GestureOuiThe same gesture, letting go with animation: each follower runs it with the gesture's velocity, toward its own home (its first value) unless the animation names a target.
activelecture seuleGestureSourceOui1 while it is active, 0 otherwise.
release — signatures de méthode

Signatures

ts
(animation: Animation<unknown>): Gesture

Paramètres

NomTypeRequisDescription
animationAnimation<unknown>Oui—

Retourne

Gesture

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.