@needle-tools/engine/lib/engine-components/NeedleMenu.d.ts

Needle Engine is a web-based runtime for 3D apps. It runs on your machine for development with great integrations into editors like Unity or Blender - and can be deployed onto any device! It is flexible, extensible and networking and XR are built-in.

import { Behaviour } from './Component.js';
/**
 * Provides configuration options for the built-in Needle Menu.
 * Needle Menu uses HTML in 2D mode, and automatically switches to a 3D menu in VR/AR mode.
 *
 * Controls display options, button visibility, and menu positioning.
 * From code, you can access the menu via {@link Context.menu}.
 * @category User Interface
 * @group Components
 **/
export declare class NeedleMenu extends Behaviour {
    /**
     * Determines the vertical positioning of the menu on the screen
     */
    position: "top" | "bottom";
    /**
     * Controls the visibility of the Needle logo in the menu (requires PRO license)
     */
    showNeedleLogo: boolean;
    /**
     * When enabled, displays the menu in VR/AR mode when the user looks up
     * @default undefined
     */
    showSpatialMenu?: boolean;
    /**
     * When enabled, adds a fullscreen toggle button to the menu
     * @default undefined
     */
    createFullscreenButton?: boolean;
    /**
     * When enabled, adds an audio mute/unmute button to the menu
     * @default undefined
     */
    createMuteButton?: boolean;
    /**
     * When enabled, adds a button to display a QR code for sharing the application.
     * The QR code is only displayed on desktop devices.
     * @default undefined
     */
    createQRCodeButton?: boolean;
    /**
     * Applies the configured menu options when the component is enabled
     * @hidden
     */
    onEnable(): void;
    /**
     * Applies all configured options to the active {@link Context.menu}.
     */
    applyOptions(): void;
}