Interface UxpMenuItems

Class describing the menu of a panel.

interface UxpMenuItems {
    getItem: (id: string) => UxpMenuItem;
    getItemAt: (index: number) => UxpMenuItem;
    insertAt: (index: number, newItem: MenuItem | "-") => void;
    removeAt: (index: number) => void;
    size: number;
}

Properties

getItem: (id: string) => UxpMenuItem

Get menu item with specified ID.

- (id: string): UxpMenuItem
- Parameters
  - id: string
  Returns UxpMenuItem
  Menu item with specified ID.

getItemAt: (index: number) => UxpMenuItem

Get menu item at specified index.

- (index: number): UxpMenuItem
- Parameters
  - index: number
  Returns UxpMenuItem
  Menu item at specified index.

insertAt: (index: number, newItem: MenuItem | "-") => void

Inserts/replaces the menu item at the specified index with the new menu item.

removeAt: (index: number) => void

Removes menu item from specified index.

size: number

Get number of menu items.