@hmiproject/helio-sdk
    Preparing search index...

    Variable propsConst

    props: {
        Action: <O extends TypeOptions<HelioAction>>(
            options: O,
        ) => PropDef<HelioAction, O>;
        Boolean: <O extends TypeOptions<HelioBoolean>>(
            options: O,
        ) => PropDef<HelioBoolean, O>;
        Children: (
            options: ChildrenTypeOptions,
        ) => WithDefaultValue<
            PropDef<HelioChildren, TypeOptions<HelioChildren>>,
            InstanceRefListSchema,
        >;
        DynamicProperty: <
            O extends DynamicPropertyTypeOptions<HelioDynamicProperty>,
        >(
            options: O,
        ) => PropDef<HelioDynamicProperty, O>;
        Enum: {
            <V extends string | number, O extends readonly OptionItem<V>[]>(
                options: ConditionalTypeOptions & {
                    description?: string;
                    editor?: EnumEditor;
                    label: string;
                    options: O;
                    propGroup?: string;
                } & { defaultValue?: OptionValueOf<O>; optional: true },
            ): EnumDef<V, O> & {
                defaultValue: OptionValueOf<O> | undefined;
                optional: true;
            };
            <V extends string | number, O extends readonly OptionItem<V>[]>(
                options: ConditionalTypeOptions & {
                    description?: string;
                    editor?: EnumEditor;
                    label: string;
                    options: O;
                    propGroup?: string;
                } & { defaultValue: OptionValueOf<O>; optional: false },
            ): EnumDef<V, O> & { defaultValue: OptionValueOf<O>; optional: false };
        };
        File: <O extends OptionalTypeOptions<HelioFile>>(
            options: O,
        ) => PropDef<HelioFile, O>;
        List: {
            <Item extends ListItemDef>(
                options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                    description?: string;
                    item: Item;
                    label: string;
                } & { defaultValue?: Item["type"][]; optional: true },
            ): ListDef<Item> & {
                defaultValue: Item["type"][] | undefined;
                optional: true;
                type: Item["type"][] | undefined;
            };
            <Item extends ListItemDef>(
                options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                    description?: string;
                    item: Item;
                    label: string;
                } & { defaultValue?: Item["type"][]; optional: false },
            ): ListDef<Item> & {
                defaultValue: Item["type"][];
                enabledIf: undefined;
                optional: false;
                type: Item["type"][];
            };
        };
        Number: <O extends NumberTypeOptions>(
            options: O,
        ) => PropDef<HelioNumber, O>;
        Object: {
            <Shape extends SchemaDef>(
                options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                    description?: string;
                    label: string;
                    shape: Shape;
                } & { defaultValue?: Values<Shape>; optional: true },
            ): ObjectDef<Shape> & {
                defaultValue: Values<Shape> | undefined;
                optional: true;
                type: Values<Shape> | undefined;
            };
            <Shape extends SchemaDef>(
                options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                    description?: string;
                    label: string;
                    shape: Shape;
                } & { defaultValue?: Values<Shape>; optional: false },
            ): ObjectDef<Shape> & {
                defaultValue: Values<Shape>;
                optional: false;
                type: Values<Shape>;
            };
        };
        String: <O extends TypeOptions<HelioString>>(
            options: O & { multiline?: boolean },
        ) => PropDef<HelioString, O> & { multiline: boolean };
    } = ...

    Helpers for declaring props in a PropsSchema

    Use these for schema declarations using createPropsSchema.

    Type Declaration

    • Action: <O extends TypeOptions<HelioAction>>(options: O) => PropDef<HelioAction, O>
    • Boolean: <O extends TypeOptions<HelioBoolean>>(options: O) => PropDef<HelioBoolean, O>
    • Children: (
          options: ChildrenTypeOptions,
      ) => WithDefaultValue<
          PropDef<HelioChildren, TypeOptions<HelioChildren>>,
          InstanceRefListSchema,
      >
    • DynamicProperty: <O extends DynamicPropertyTypeOptions<HelioDynamicProperty>>(
          options: O,
      ) => PropDef<HelioDynamicProperty, O>
    • Enum: {
          <V extends string | number, O extends readonly OptionItem<V>[]>(
              options: ConditionalTypeOptions & {
                  description?: string;
                  editor?: EnumEditor;
                  label: string;
                  options: O;
                  propGroup?: string;
              } & { defaultValue?: OptionValueOf<O>; optional: true },
          ): EnumDef<V, O> & {
              defaultValue: OptionValueOf<O> | undefined;
              optional: true;
          };
          <V extends string | number, O extends readonly OptionItem<V>[]>(
              options: ConditionalTypeOptions & {
                  description?: string;
                  editor?: EnumEditor;
                  label: string;
                  options: O;
                  propGroup?: string;
              } & { defaultValue: OptionValueOf<O>; optional: false },
          ): EnumDef<V, O> & { defaultValue: OptionValueOf<O>; optional: false };
      }
    • File: <O extends OptionalTypeOptions<HelioFile>>(options: O) => PropDef<HelioFile, O>
    • List: {
          <Item extends ListItemDef>(
              options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                  description?: string;
                  item: Item;
                  label: string;
              } & { defaultValue?: Item["type"][]; optional: true },
          ): ListDef<Item> & {
              defaultValue: Item["type"][] | undefined;
              optional: true;
              type: Item["type"][] | undefined;
          };
          <Item extends ListItemDef>(
              options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                  description?: string;
                  item: Item;
                  label: string;
              } & { defaultValue?: Item["type"][]; optional: false },
          ): ListDef<Item> & {
              defaultValue: Item["type"][];
              enabledIf: undefined;
              optional: false;
              type: Item["type"][];
          };
      }
    • Number: <O extends NumberTypeOptions>(options: O) => PropDef<HelioNumber, O>
    • Object: {
          <Shape extends SchemaDef>(
              options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                  description?: string;
                  label: string;
                  shape: Shape;
              } & { defaultValue?: Values<Shape>; optional: true },
          ): ObjectDef<Shape> & {
              defaultValue: Values<Shape> | undefined;
              optional: true;
              type: Values<Shape> | undefined;
          };
          <Shape extends SchemaDef>(
              options: Omit<ConditionalTypeOptions, "enabledIf"> & {
                  description?: string;
                  label: string;
                  shape: Shape;
              } & { defaultValue?: Values<Shape>; optional: false },
          ): ObjectDef<Shape> & {
              defaultValue: Values<Shape>;
              optional: false;
              type: Values<Shape>;
          };
      }
    • String: <O extends TypeOptions<HelioString>>(
          options: O & { multiline?: boolean },
      ) => PropDef<HelioString, O> & { multiline: boolean }