Skip to content

@jsvision/ui / menuSpacer

Function: menuSpacer()

menuSpacer(weight?): MenuItem

Defined in: ui/src/menu/builders.ts:260

Build a flexible gap between top-level menu titles: the titles placed after it are pushed toward the bar's right edge, so menuBar([subMenu('~F~ile', …), menuSpacer(), subMenu('~H~elp', …)]) right-aligns Help. A spacer is never a navigation target — it carries no title, hotkey, or command and is skipped by drawing, hit-testing, and ←→ navigation.

Parameters

weight?

number = 1

The gap's grow weight relative to other spacers (default 1); more weight ⇒ more slack.

Returns

MenuItem

A spacer MenuItem node.

Example

ts
import { menuBar, subMenu, item, menuSpacer } from '@jsvision/ui';

const bar = menuBar([
  subMenu('~F~ile', [item('~O~pen', 'file.open')]),
  menuSpacer(), // push Help to the right edge
  subMenu('~H~elp', [item('~A~bout', 'help.about')]),
]);