API Reference
@univerjs
@univerjs/ui
Readme

@univerjs/ui v0.4.2Docs


@univerjs/ui

Enumerations

EnumerationDescription
BuiltInUIPart-
ContextMenuGroup-
ContextMenuPosition-
KeyCodeKeyCode that maps to browser standard keycode.
MenuGroup-
MenuItemType-
MenuManagerPositionCopyright 2023-present DreamNum Inc.
MenuPosition-
MetaKeysDefine meta key numbers.
RibbonDataGroup-
RibbonFormulasGroup-
RibbonInsertGroup-
RibbonOthersGroup-
RibbonPosition-
RibbonStartGroup-
RibbonViewGroup-

Classes

ClassDescription
BrowserClipboardServiceThis interface provides an interface to access system's clipboard.
CanvasFloatDomService-
CanvasPopupService-
ComponentManager-
ContextMenuService-
DesktopBeforeCloseService-
DesktopConfirmService-
DesktopDialogService-
DesktopGlobalZoneService-
DesktopLayoutServiceThis service is responsible for storing layout information of the current Univer application instance.
DesktopLocalFileService-
DesktopLocalStorageService-
DesktopMessageService-
DesktopNotificationService-
DesktopSidebarService-
DesktopUIController-
DesktopZenZoneService-
ErrorController-
MenuManagerService-
MenuService-
PlatformServiceA service to provide context info of the host service.
SharedControllerDefine shared UI behavior across Univer business. Including undo / redo and clipboard operations.
ShortcutPanelControllerThis controller add a side panel to the application to display the shortcuts.
ShortcutPanelService-
UIPartsService-
UniverUIPluginUI plugin provides basic interaction with users. Including workbench (menus, UI parts, notifications etc.), copy paste, shortcut.
ZIndexManagerCopyright 2023-present DreamNum Inc.

Interfaces

InterfaceDescription
IBeforeCloseService-
ICanvasPopupService-
IClipboardInterfaceServiceThis interface provides an interface to access system's clipboard.
IComponentContainerProps-
IConfirmService-
IContextMenuHandler-
IContextMenuService-
ICustomComponentProps-
IDialogService-
IFloatDomLayoutProperties of selection data
IGlobalZoneService-
ILayoutService-
ILocalFileService-
IMenuButtonItem-
IMenuGroup-
IMenuManagerService-
IMenuSchema-
IMenuSelectorItem-
IMenuServiceBreaking changes to IMenuService are expected in the next version. Use with caution. by
IMessageService-
INotificationOptions-
INotificationService-
IOpenFileOptions-
IPlatformServiceA service to provide context info of the host service.
IPopup-
IReactComponent-
IShortcutItemA shortcut item that could be registered to the IShortcutService.
IShortcutServiceThe interface of the shortcut service.
ISidebarMethodOptions-
ISidebarService-
IUIController-
IUIPartsService-
IUniverUIConfig-
IValueOption-
IVue3Component-
IWorkbenchOptions-
IZenZoneService-

Type Aliases

Type aliasDescription
ComponentList-
ComponentType-
IConfirmPartMethodOptions-
ICustomLabelProps-
IDialogPartMethodOptions-
IDisplayMenuItem-
IMenuItem-
IMenuItemFactory-
MenuConfig-
MenuItemDefaultValueType-
MenuSchemaType-
NotificationType-

Variables

VariableDescription
CopyCommand-
CopyShortcutItem-
CutCommand-
CutShortcutItem-
DEFAULT_BACKGROUND_COLOR_RGB-
DEFAULT_BACKGROUND_COLOR_RGBA-
DISABLE_AUTO_FOCUS_KEY-
FONT_FAMILY_LIST-
FONT_SIZE_LIST-
HTML_CLIPBOARD_MIME_TYPE-
PLAIN_TEXT_CLIPBOARD_MIME_TYPE-
PLUGIN_CONFIG_KEY-
PasteCommand-
RedoShortcutItem-
SetEditorResizeOperation-
ToggleShortcutPanelOperation-
UNIVER_UI_PLUGIN_NAME-
UndoShortcutItem-
builtInGlobalComponents-
menuSchema-

Functions

FunctionDescription
CanvasPopup-
ComponentContainer-
ContextMenu-
CustomLabelThe component to render toolbar item label and menu item label.
FloatDom-
FontFamily-
FontFamilyItem-
FontSize-
GlobalZone-
IBeforeCloseService-
ICanvasPopupService-
IClipboardInterfaceService-
IConfirmService-
IContextMenuService-
IDialogService-
IGlobalZoneService-
ILayoutService-
ILeftSidebarService-
ILocalFileService-
IMenuManagerService-
IMenuService-
IMessageService-
INotificationService-
IPlatformService-
IShortcutService-
ISidebarService-
IUIController-
IUIPartsService-
IZenZoneService-
Menu-
MobileContextMenu-
ProgressBar-
Ribbon-
Sidebar-
ToolbarButtonButton Component
ToolbarItem-
VueComponentWrapper-
ZenZone-
getHeaderFooterMenuHiddenObservable-
getMenuHiddenObservable-
handelExcelToJson-
handelTableToJson-
handleDomToJsonThe entire list of DOM spans is parsed into a rich-text JSON style sheet
handlePlainToJson-
handleStringToStyleA single span parses out the ITextStyle style sheet
handleTableColgroup-
handleTableMergeData-
handleTableRowGroup-
mergeMenuConfigs-
splitSpanTextsplit span text
t-
textTrimCopyright 2023-present DreamNum Inc.
useComponentsOfPartGet a set of render functions to render components of a part.
useEvent-
useObservable-
useScrollYOverContainerAllow the element to scroll when its height over the container height
useSimpleToolbarGroups-
useToolbarGroupsIf your custom toolbar component need to render menu items by their category, you can use this hook to get the toolbar status.
useToolbarItemStatusSubscribe to a menu item's status change and return the latest status.
useVirtualList-

Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.