Interface FC<Props, Exports>

Functional component type used across Kayla.

Components must return zero, one, or many KaylaElements. Returning void is allowed but produces no entities.

interface FC<
    Props extends FCProps = FCProps,
    Exports extends FCExports = FCExports,
> {
    displayName?: string;
    (
        props: Props & {
            key?: string;
            children?: KaylaElement<any> | KaylaElement<any>[];
            ref?: KaylaRef<KaylaRectEntity>;
            exportsRef?: KaylaRef<KaylaExports<any>>;
        } & Record<string, unknown> & {
            ref?: KaylaElementRef;
            exportsRef?: KaylaRef<KaylaExports<Exports>>;
        },
    ): void
    | KaylaElement<any>
    | KaylaElement<any>[];
}

Props extends FCProps = FCProps
Props the component accepts
Exports extends FCExports = FCExports
Public API the component exposes (optional)

Properties

displayName?: string