Member Junction
    Preparing search index...

    Interface FormContributionRegistration

    interface FormContributionRegistration {
        ComponentID?: string;
        ComponentSpec?: ComponentSpec;
        Configuration?: Record<string, unknown>;
        Icon?: string;
        IsPreview?: boolean;
        Metadata: FormPanelRegistrationMetadata;
        Presentation?: "panel" | "bare";
        Priority: number;
        Registration?: ClassRegistration;
        RowID?: string;
        Scope?: "User" | "Role" | "Global";
        Source?: FormContributionRegistrationSource;
        Title?: string;
    }
    Index

    Properties

    ComponentID? ComponentSpec? Configuration? Icon? IsPreview? Metadata Presentation? Priority Registration? RowID? Scope? Source? Title?

    Properties

    ComponentID?: string

    MJ: Components.ID the panel renders — metadata rows only.

    ComponentSpec?: ComponentSpec

    The component to render when it has not been saved yet, so there is no ComponentID to load. Only the placement preview sets it.

    Configuration?: Record<string, unknown>

    Parsed Configuration JSON for metadata rows.

    Icon?: string
    IsPreview?: boolean

    A panel the placement dialog is showing before it is saved. It draws its component when it carries one, else a placeholder. Only a form inside the dialog's preview sees one.

    Metadata: FormPanelRegistrationMetadata
    Presentation?: "panel" | "bare"
    Priority: number

    Rank within a contributionKey group, higher wins. For 'class' registrations this is the ClassFactory registration priority; for 'metadata' rows it is the row's Precedence column. Both mean the same thing here — higher wins — which is why one field carries both.

    Registration?: ClassRegistration

    The ClassFactory registration for compiled panels — carries the component constructor.

    RowID?: string

    MJ: Entity Form Contributions.ID for metadata rows.

    Scope?: "User" | "Role" | "Global"

    Who a metadata row is for. Absent on compiled registrations, which apply to everyone the code puts them in front of. A User row a user can see is necessarily their own — the collector only returns personal rows for the current user.

    Source?: FormContributionRegistrationSource

    Omitted on legacy call sites, which are all compiled registrations.

    Title?: string

    Settings

    Member Visibility

    On This Page

    Properties