Member Junction
    Preparing search index...

    Interface FormToolbarActionRegistrationMetadata

    Structured metadata attached to a BaseFormToolbarAction registration via @RegisterClassEx(BaseFormToolbarAction, { key, priority?, metadata }) or RegisterFormToolbarAction.

    interface FormToolbarActionRegistrationMetadata {
        CssClass?: string;
        Description?: string;
        EntityScope?: string | readonly string[];
        Icon?: string;
        Key: string;
        MenuLabel?: string;
        Mode?: ToolbarItemMode;
        Order?: number;
        Pinnable?: boolean;
        Placement?: ToolbarItemPlacement;
        Text?: string;
        Variant?: ToolbarItemVariant;
        [key: string]: unknown;
    }

    Hierarchy

    • Record<string, unknown>
      • FormToolbarActionRegistrationMetadata

    Indexable

    • [key: string]: unknown
    Index

    Properties

    CssClass? Description? EntityScope? Icon? Key MenuLabel? Mode? Order? Pinnable? Placement? Text? Variant?

    Properties

    CssClass?: string

    Optional custom CSS class name.

    Description?: string

    Tooltip text displayed on hover.

    EntityScope?: string | readonly string[]

    Scope controlling which entity forms mount this toolbar action:

    • '*' (default): global — mounts on every entity form
    • Exact entity name (case-insensitive): e.g. 'MJ: AI Agents'
    • Glob/wildcard pattern on entity name: e.g. 'MJ_BizApps_Orders:*', '*Order*', 'MJ: AI *'
    • Schema prefix: e.g. 'schema:mj_bizapps_accounting' (matches EntityInfo.SchemaName)
    • Array of any of the above: e.g. ['Invoices', 'Credit Memos', 'MJ_BizApps_Orders:*']
    Icon?: string

    Font Awesome icon class (e.g. 'fa-solid fa-diagram-project').

    Key: string

    Unique toolbar item key (e.g. 'links', 'send-invoice', 'approve-contract'). When multiple registrations share the same Key, the registration with the highest ClassFactory Priority wins (last-wins override).

    MenuLabel?: string

    Label displayed in the toolbar's More (...) menu. Defaults to Text or Description.

    Mode?: ToolbarItemMode

    Form mode(s) in which the button appears ('read' | 'edit' | 'both'). Default: 'read'.

    Order?: number

    Numeric sort order within its placement group.

    Pinnable?: boolean

    Whether the action participates in per-user pinning (mj.form.toolbar.pinnedActions). When true, the button renders on the main bar only when pinned by the user (or in DefaultPinnedActions), and otherwise lives in the More (...) menu.

    Placement?: ToolbarItemPlacement

    Toolbar placement group ('actions' | 'right' | 'overflow'). Default: 'actions'.

    OptionalText

    Text?: string

    Optional inline button label text.

    Variant?: ToolbarItemVariant

    Visual button variant. Default: 'default'.

    Settings

    Member Visibility

    On This Page

    Properties