@univerjs/ui v0.1.17 • Docs
Interface: IMenuSelectorItem<V, T>
Extends
IMenuItemBase<V>
Type Parameters
| Type Parameter | Default type |
|---|---|
V | MenuItemDefaultValueType |
T | undefined |
Properties
| Property | Type | Description | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
activated$? | Observable<boolean> | If type is MenuItemType.BUTTON_SELECTOR, this determines if the button is activated. | - | - | packages/ui/src/services/menu/menu.ts:132 (opens in a new tab) |
description? | string | - | - | IMenuItemBase.description | packages/ui/src/services/menu/menu.ts:64 (opens in a new tab) |
disabled$? | Observable<boolean> | - | - | IMenuItemBase.disabled$ | packages/ui/src/services/menu/menu.ts:88 (opens in a new tab) |
group? | MenuGroup | The group that the item belongs to. | - | IMenuItemBase.group | packages/ui/src/services/menu/menu.ts:69 (opens in a new tab) |
hidden$? | Observable<boolean> | - | - | IMenuItemBase.hidden$ | packages/ui/src/services/menu/menu.ts:87 (opens in a new tab) |
icon? | string | Observable<string> | - | - | IMenuItemBase.icon | packages/ui/src/services/menu/menu.ts:65 (opens in a new tab) |
id | string | ID of the menu item. Normally it should be the same as the ID of the command that it would invoke. | - | IMenuItemBase.id | packages/ui/src/services/menu/menu.ts:61 (opens in a new tab) |
label? | string | { hoverable: boolean; name: string; props: Record<string, any>; } | Custom label component id. | - | IMenuItemBase.label | packages/ui/src/services/menu/menu.ts:79 (opens in a new tab) |
positions | OneOrMany<string> | In what menu should the item display. | - | IMenuItemBase.positions | packages/ui/src/services/menu/menu.ts:72 (opens in a new tab) |
selections? | IValueOption<T>[] | Observable<IValueOption<T>[]> | Options or IDs of registered components. | - | - | packages/ui/src/services/menu/menu.ts:129 (opens in a new tab) |
subId? | string | - | - | IMenuItemBase.subId | packages/ui/src/services/menu/menu.ts:62 (opens in a new tab) |
title? | string | - | - | IMenuItemBase.title | packages/ui/src/services/menu/menu.ts:63 (opens in a new tab) |
tooltip? | string | - | - | IMenuItemBase.tooltip | packages/ui/src/services/menu/menu.ts:66 (opens in a new tab) |
type | SELECTOR | BUTTON_SELECTOR | SUBITEMS | - | IMenuItemBase.type | - | packages/ui/src/services/menu/menu.ts:122 (opens in a new tab) |
value$? | Observable<V> | On observable value that should emit the value of the corresponding selection component. | - | IMenuItemBase.value$ | packages/ui/src/services/menu/menu.ts:90 (opens in a new tab) |