ElementHandle — Kuito Documentação

Utilização

Fade a view on entry or removal.

Este tipo é usado por 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()} />;

Declaração do tipo

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;
}

Membros 9

Nome	Tipo	Obrigatório	Descrição
`id`só de leitura	`string`	Sim	—
`parent`só de leitura	`ElementHandle`	Sim	—
`children`só de leitura	`ElementHandle[]`	Sim	—
`focus`	`() => void`	Sim	—
`blur`	`() => void`	Sim	—
`setProperty`	`<K extends keyof ElementProperties>(key: K, value: ElementProperties[K] \| null) => void`	Sim	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`	Sim	—
`removeEventListener`	`(type: string, fn: (e: KuitoNativeEvent) => void, options?: boolean \| { capture?: boolean;}) => void`	Sim	—
`dispatchEvent`	`(event: { type: string; bubbles?: boolean; cancelable?: boolean;}) => boolean`	Sim	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 — assinaturas de método

Assinaturas

(): void

Parâmetros

Sem parâmetros.

Devolve

void

blur — assinaturas de método

Assinaturas

(): void

Parâmetros

Sem parâmetros.

Devolve

void

setProperty — assinaturas de método

Assinaturas

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

Parâmetros de tipo

Nome	Restrição	Predefinição
`K`	`keyof ElementProperties`	—

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`key`	`K`	Sim	—
`value`	`ElementProperties[K]`	Sim	—

Devolve

void

addEventListener — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`type`	`string`	Sim	—
`fn`	`(e: KuitoNativeEvent) => void`	Sim	—
`options`	`boolean \| { capture?: boolean; once?: boolean; signal?: AbortSignal;}`	Não	—

Devolve

void

removeEventListener — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`type`	`string`	Sim	—
`fn`	`(e: KuitoNativeEvent) => void`	Sim	—
`options`	`boolean \| { capture?: boolean;}`	Não	—

Devolve

void

dispatchEvent — assinaturas de método

Assinaturas

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

Parâmetros

Nome	Tipo	Obrigatório	Descrição
`event`	`{ type: string; bubbles?: boolean; cancelable?: boolean;}`	Sim	—

Devolve

boolean

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.