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

    Interface MetaPropertyEditorUi

    interface MetaPropertyEditorUi {
        group: string;
        icon: string;
        keywords?: string[];
        label: string;
        propertyEditorSchemaAlias?: string;
        settings?: PropertyEditorSettings;
        supportsDataSource?: { enabled: boolean; forDataSourceTypes: string[] };
        supportsReadOnly?: boolean;
        supportsVariantChange?: boolean;
    }
    Index
    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".

    Core property editors use localization keys prefixed with # (e.g. "#propertyEditorUIGroups_common"). External packages can use either display-ready names (e.g. "My Group") or camelCase names (e.g. "myGroup") which will be automatically converted to title case.

    "Common"
    
    ["#propertyEditorUIGroups_common", "#propertyEditorUIGroups_richContent", "My Custom Group"]
    
    icon: string
    keywords?: string[]

    A list of keywords that can be used to search for this property editor UI in the property editor picker. If not specified, the property editor UI will not have any keywords.

    ["text", "input", "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"]
    
    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
    supportsVariantChange?: boolean

    Will be removed in a future version, as this will be enforced on all Property Editor UIs from v.19. Declares that this Property Editor UI keeps itself up to date when the variant it is bound to changes — for example, an editor that observes its own value and configuration and updates in place rather than relying on being remounted.

    When not set to true, the property re-creates the Property Editor UI element whenever it detects a variant switch, so the element always initializes fresh for the variant it is currently bound to. A variant switch is detected via the data path the property is bound to changing, so this has no effect for a property that does not vary by culture or segment, since its data path never changes on a variant switch.

    false