PsyTask | API Docs
    Preparing search index...

    Class Scene<T>

    Disposable event emitter, use Set to manage listeners

    Type Parameters

    • T extends MaybeGenericComponent

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    data listeners options props root show

    Methods

    [dispose] close emit off on once

    Constructors

    Properties

    data: T extends MaybeGenericComponent<_, D> ? () => D : undefined
    listeners: {
        close?: Set<(e: undefined) => void>;
        dispose?: Set<(e: undefined) => void>;
        frame?: Set<(e: number) => void>;
        show?: Set<(e: undefined) => void>;
    } = {}
    options: SceneOptions<T>

    SceneOptions

    props: LooseObject
    root: HTMLDivElement
    show: T extends Component<P, D>
        ? (patchProps?: Partial<P>) => Promise<Merge<D, BuiltinData>>
        : T = ...

    Show DOM and update props one-time

    Basic usage

    await scene.show({ text: 'new' }); // show with new props
    await scene.show(); // show with default props

    Methods

    • If called in frame, close in current frame (as microtask), else in next frame

      Returns void

    • Emit event listeners

      Type Parameters

      • K extends "dispose" | (keyof SceneEventMap)

      Parameters

      Returns Scene<T>

    • Add one-time event listener, can not be removed manually

      Type Parameters

      • K extends "dispose" | (keyof SceneEventMap)

      Parameters

      Returns Scene<T>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods