@dxos/app-framework - v0.15.0
    Preparing search index...

    Variable createConst

    create: <
        T extends Record<string, any> = any,
        P extends Record<string, any> = ComponentProps<T>,
        const Id extends string = string,
    >(
        definition: Readonly<
            {
                component: ComponentType<P>;
                filter: Filter<T>;
                id: [Path<Id>] extends [never]
                    ? `Invalid id "${Id}": final segment must be camelCase — letters and digits, starting with a letter`
                    : Id;
                position?: number;
                props?: (props: ComponentProps<T>) => P;
            },
        >,
    ) => Readonly<
        {
            component: ComponentType<any>;
            filter?: (data: Record<string, unknown>, role?: string) => data is T;
            id: string;
            kind: "react";
            position?: number;
            props?: (props: ComponentProps<T>) => Record<string, any>;
            role: string | string[];
        },
    > = createSurface

    Type declaration

      • <
            T extends Record<string, any> = any,
            P extends Record<string, any> = ComponentProps<T>,
            const Id extends string = string,
        >(
            definition: Readonly<
                {
                    component: ComponentType<P>;
                    filter: Filter<T>;
                    id: [Path<Id>] extends [never]
                        ? `Invalid id "${Id}": final segment must be camelCase — letters and digits, starting with a letter`
                        : Id;
                    position?: number;
                    props?: (props: ComponentProps<T>) => P;
                },
            >,
        ): Readonly<
            {
                component: ComponentType<any>;
                filter?: (data: Record<string, unknown>, role?: string) => data is T;
                id: string;
                kind: "react";
                position?: number;
                props?: (props: ComponentProps<T>) => Record<string, any>;
                role: string | string[];
            },
        >
      • Creates a React surface definition from a typed filter.

        Type Parameters

        • T extends Record<string, any> = any
        • P extends Record<string, any> = ComponentProps<T>
        • const Id extends string = string

        Parameters

        • definition: Readonly<
              {
                  component: ComponentType<P>;
                  filter: Filter<T>;
                  id: [Path<Id>] extends [never]
                      ? `Invalid id "${Id}": final segment must be camelCase — letters and digits, starting with a letter`
                      : Id;
                  position?: number;
                  props?: (props: ComponentProps<T>) => P;
              },
          >

        Returns Readonly<
            {
                component: ComponentType<any>;
                filter?: (data: Record<string, unknown>, role?: string) => data is T;
                id: string;
                kind: "react";
                position?: number;
                props?: (props: ComponentProps<T>) => Record<string, any>;
                role: string | string[];
            },
        >