@3dsource/metabox-front-api
    Preparing search index...

    Class ShowEmbeddedMenu

    Represents a command to toggle the embedded Metabox menu. This command can only be used when using the metabox menu.

    Shows the embedded menu interface. Only works when using the MetaBox native menu (not in standalone/custom menu mode).

    Toggles the native MetaBox right sidebar menu. Takes a boolean parameter. Pass false to hide when building custom UI. In standalone mode, the menu is already hidden — this is only relevant in default (non-standalone) mode.

    In standalone mode ({standalone:true}), this is unnecessary (menu already hidden). In default mode, call new ShowEmbeddedMenu(false) early in initialization to hide built-in UI before rendering custom controls. Pattern for custom UI: ShowEmbeddedMenu(false) + ShowOverlayInterface(false).

    import { ShowEmbeddedMenu, Communicator } from '@3dsource/metabox-front-api';
    window.env3DSource.apiReady = (api: Communicator) => {
      api.sendCommandToMetabox(new ShowEmbeddedMenu(true));
    };

    A flag indicating whether the embedded menu should be visible.

    Index

    Constructors

    constructor

    Properties

    data

    Constructors

    Properties

    data: ToMetaBoxMessageEnvelope

    The message envelope populated by subclass constructors and sent via Communicator.sendCommandToMetabox.

    Settings

    Member Visibility

    On This Page

    What does it unlock?Practical ApplicationAI Coding Best Practices
    Constructors
    Properties