@umbraco-cms/backoffice
    Preparing search index...

    Interface MetaPropertyEditorUi

    interface MetaPropertyEditorUi {
        group: string;
        icon: string;
        label: string;
        propertyEditorSchemaAlias?: string;
        settings?: PropertyEditorSettings;
        supportsDataSource?: { enabled: boolean; forDataSourceTypes: string[] };
        supportsReadOnly?: boolean;
    }
    Index

    Properties

    group icon label propertyEditorSchemaAlias? settings? supportsDataSource? supportsReadOnly?

    Properties

    group: string

    The group that this property editor UI belongs to, which will be used to group the property editor UIs in the property editor picker. If not specified, the property editor UI will be grouped under "Common".

    "Common"

    ["Common", "Content", "Media"]
    icon: string
    label: string
    propertyEditorSchemaAlias?: string

    The alias of the property editor schema that this property editor UI is for. If not specified, the property editor UI can only be used to configure other property editors.

    ["Umbraco.TextBox", "Umbraco.TextArea", "Umbraco.Label"]
    settings?: PropertyEditorSettings
    supportsDataSource?: { enabled: boolean; forDataSourceTypes: string[] }

    Type Declaration

    • enabled: boolean

      Whether the property editor UI is enabled for use with data sources.

    • forDataSourceTypes: string[]

      A list of allowed property editor data source kinds that can be used with this property editor UI. If not specified, any data sources can be used.

      ["pickerCollection", "pickerTree"]
    supportsReadOnly?: boolean

    Settings

    Member Visibility

    On This Page

    Properties