element-vir - v26.14.0
    Preparing search index...

    Type Alias RenderParams<TagName, Inputs, State, EventsInit, HostClassKeys, CssVarKeys, SlotNames, TestIds>

    The full parameters object passed to render, init, and cleanup element definition methods.

    type RenderParams<
        TagName extends CustomElementTagName,
        Inputs extends PropertyInitMapBase,
        State extends PropertyInitMapBase,
        EventsInit extends EventsInitMap,
        HostClassKeys extends BaseStringName<TagName>,
        CssVarKeys extends BaseStringName<TagName>,
        SlotNames extends ReadonlyArray<string>,
        TestIds extends ReadonlyArray<string>,
    > = {
        cssVars: Readonly<CssVars<TagName, CssVarKeys>>;
        dispatch: <EventTypeName extends keyof EventsInit>(
            event:
                | TypedEvent<
                    EventTypeName extends string ? EventTypeName : never,
                    EventInitMapEventDetailExtractor<EventTypeName, EventsInit>,
                >
                | Event,
        ) => boolean;
        events: EventDescriptorMap<TagName, EventsInit>;
        host: DeclarativeElementHost<
            TagName,
            Inputs,
            State,
            EventsInit,
            HostClassKeys,
            CssVarKeys,
            SlotNames,
            TestIds,
        >;
        inputs: Readonly<Inputs>;
        slotNames: Readonly<StringNameMap<TagName, "slot", SlotNames>>;
        state: Readonly<State>;
        testIds: Readonly<StringNameMap<TagName, "test-id", TestIds>>;
        updateState: UpdateStateCallback<State>;
    }

    Type Parameters

    Index

    Properties

    cssVars: Readonly<CssVars<TagName, CssVarKeys>>
    dispatch: <EventTypeName extends keyof EventsInit>(
        event:
            | TypedEvent<
                EventTypeName extends string ? EventTypeName : never,
                EventInitMapEventDetailExtractor<EventTypeName, EventsInit>,
            >
            | Event,
    ) => boolean

    Dispatch an event from the current element.

    host: DeclarativeElementHost<
        TagName,
        Inputs,
        State,
        EventsInit,
        HostClassKeys,
        CssVarKeys,
        SlotNames,
        TestIds,
    >
    inputs: Readonly<Inputs>
    slotNames: Readonly<StringNameMap<TagName, "slot", SlotNames>>
    state: Readonly<State>
    testIds: Readonly<StringNameMap<TagName, "test-id", TestIds>>