NativeViewEvent — Kuito Documentation

Usage

Type an event emitted by a module view.

tsx

// Type an event emitted by a module view.
import { defineModule, view, type NativeViewEvent } from 'kuito';

// modules/rating/rating.ts: a native star rating view and the event it sends.
export type RatingEvent = NativeViewEvent<'rate', { stars: number }>;

export type RatingProps = {
  stars?: number;
  onRate?: (event: RatingEvent) => void;
};

export default defineModule('Rating', {
  view: view<RatingProps>({ events: ['rate'] }),
  ios: { class: 'RatingModule' },
  android: { class: 'com.example.myapp.modules.rating.RatingModule' },
});

Type declaration

export type NativeViewEvent<
  Type extends string,
  Payload = Record<never, never>,
> = KuitoEvent<Type> & Payload;

Members 3

Name	Type	Required	Description
`type`	`Type`	Yes	—
`target`	`unknown`	Yes	—
`isTrusted`	`boolean`	Yes	—

Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.