Type alias UIExtensionProps

Type declaration

• extension: {
      fieldTypes: FieldType[];
      name: string;
      parameters?: {
          installation?: ParameterDefinition<InstallationParameterType>[];
          instance?: ParameterDefinition[];
      };
      sidebar?: boolean;
      src?: string;
      srcdoc?: string;
  }

  • fieldTypes: FieldType[]

    Field types where an extension can be used

  • name: string

    Extension name

  • Optional parameters?: {
        installation?: ParameterDefinition<InstallationParameterType>[];
        instance?: ParameterDefinition[];
    }

    Parameter definitions

    • Optional installation?: ParameterDefinition<InstallationParameterType>[]

    • Optional instance?: ParameterDefinition[]

  • Optional sidebar?: boolean

    Controls the location of the extension. If true it will be rendered on the sidebar instead of replacing the field's editing control

  • Optional src?: string

    URL where the root HTML document of the extension can be found

  • Optional srcdoc?: string

    String representation of the extension (e.g. inline HTML code)

• Optional parameters?: DefinedParameters

  Values for installation parameters

• sys: ExtensionSysProps