ElementHandle — Kuito Documentation

Utilisation

Fade a view on entry or removal.

Ce type est utilisé par Box

tsx

// Fade a view on entry or removal.
import { Box, fade, slide, spring } from 'kuito';

<Box enter={fade.and(slide.up(12))} exit={fade} layout={spring()} />;

Déclaration du type

export interface ElementHandle {
  readonly id: string;
  readonly parent: ElementHandle | null;
  readonly children: ElementHandle[];
  focus(): void;
  blur(): void;
  /** Sets a native prop on the view now, until its binding writes it again. */
  setProperty<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): void;
  addEventListener(
    type: string,
    fn: (e: KuitoNativeEvent) => void,
    options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal },
  ): void;
  removeEventListener(
    type: string,
    fn: (e: KuitoNativeEvent) => void,
    options?: boolean | { capture?: boolean },
  ): void;
  /**
   * Sends an event through the tree, capture to bubble, as a native one travels:
   * a `KuitoCustomEvent`, or any object with a `type`. False when a listener
   * called `preventDefault()` on a cancelable event.
   */
  dispatchEvent(event: { type: string; bubbles?: boolean; cancelable?: boolean }): boolean;
}

Membres 9

Nom	Type	Requis	Description
`id`lecture seule	`string`	Oui	—
`parent`lecture seule	`ElementHandle`	Oui	—
`children`lecture seule	`ElementHandle[]`	Oui	—
`focus`	`() => void`	Oui	—
`blur`	`() => void`	Oui	—
`setProperty`	`<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] \| null) => void`	Oui	Sets a native prop on the view now, until its binding writes it again.
`addEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}) => void`	Oui	—
`removeEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean;}) => void`	Oui	—
`dispatchEvent`	`(event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean`	Oui	Sends an event through the tree, capture to bubble, as a native one travels: a `KuitoCustomEvent`, or any object with a `type`. False when a listener called `preventDefault()` on a cancelable event.

focus — signatures de méthode

Signatures

(): void

Paramètres

Aucun paramètre.

Retourne

void

blur — signatures de méthode

Signatures

(): void

Paramètres

Aucun paramètre.

Retourne

void

setProperty — signatures de méthode

Signatures

<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] | null): void

Paramètres de type

Nom	Contrainte	Par défaut
`K`	`keyof ElementProperties`	—

Paramètres

Nom	Type	Requis	Description
`key`	`K`	Oui	—
`value`	`ElementProperties[K]`	Oui	—

Retourne

void

addEventListener — signatures de méthode

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; once?: boolean; signal?: AbortSignal; }): void

Paramètres

Nom	Type	Requis	Description
`type`	`string`	Oui	—
`fn`	`(e: KuitoNativeEvent) => void`	Oui	—
`options`	`boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}`	Non	—

Retourne

void

removeEventListener — signatures de méthode

Signatures

(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean | { capture?: boolean; }): void

Paramètres

Nom	Type	Requis	Description
`type`	`string`	Oui	—
`fn`	`(e: KuitoNativeEvent) => void`	Oui	—
`options`	`boolean \| { capture?: boolean;}`	Non	—

Retourne

void

dispatchEvent — signatures de méthode

Signatures

(event: { type: string; bubbles?: boolean; cancelable?: boolean; }): boolean

Paramètres

Nom	Type	Requis	Description
`event`	`{ type: string; bubbles?: boolean; cancelable?: boolean;}`	Oui	—

Retourne

boolean

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.