API Reference
@univerjs
@univerjs/docs-ui
Readme

@univerjs/docs-ui v0.4.2Docs


@univerjs/docs-ui

Enumerations

EnumerationDescription
ChangeListNestingLevelType-
DOCS_VIEW_KEYCopyright 2023-present DreamNum Inc.
VIEWPORT_KEY-

Classes

ClassDescription
DocAutoFormatServiceservice for auto-formatting, handle shortcut like Space or Tab.
DocBackScrollRenderControllerEvery render module should implement this interface.
DocCanvasPopManagerService-
DocEventManagerServiceEvery render module should implement this interface.
DocIMEInputManagerServiceEvery render module should implement this interface.
DocRenderControllerEvery render module should implement this interface.
DocSelectionRenderServiceEvery render module should implement this interface.
DocStateChangeManagerService-
DocUIController-
DocsRenderService-
Editor-
EditorService-
NodePositionConvertToCursor-
NodePositionConvertToRectRange-
RangeSelectorService-
RectRange-
TextRange-
UniverDocsUIPluginPlug-in base class, all plug-ins must inherit from this base class. Provide basic methods.

Interfaces

InterfaceDescription
DocContainerConfig-
DocToolbarConfig-
ICoverCommandParams-
ICreateDocTableCommandParams-
IDeleteCommandParams-
IDeleteCustomBlockParams-
IDocClipboardService-
IDocObjectParam-
IDocRange-
IDocTableDeleteColumnsCommandParams-
IDocTableDeleteRowsCommandParams-
IDocTableDeleteTableCommandParams-
IDocTableInsertColumnCommandParams-
IDocTableInsertColumnLeftCommandParams-
IDocTableInsertColumnRightCommandParams-
IDocTableInsertRowAboveCommandParams-
IDocTableInsertRowBellowCommandParams-
IDocTableInsertRowCommandParams-
IDocTableTabCommandParams-
IEditorInputConfig-
IEditorService-
IInnerCutCommandParams-
IInsertCommandParams-
ILayoutCopyright 2023-present DreamNum Inc.
IPastePlugin-
IRangeSelectorRangeRange data of Unit
IRangeSelectorService-
ISetDocZoomRatioOperationParams-
ITabCommandParams-
IUpdateCommandParams-

Variables

VariableDescription
AfterSpaceCommand-
AlignCenterCommand-
AlignJustifyCommand-
AlignLeftCommand-
AlignOperationCommand-
AlignRightCommand-
BreakLineCommand-
BulletListCommand-
ChangeListNestingLevelCommand-
ChangeListTypeCommand-
CheckListCommand-
CoverContentCommand-
CreateDocTableCommandThe command to create a table at cursor point.
CutContentCommand-
DOCS_COMPONENT_BACKGROUND_LAYER_INDEX-
DOCS_COMPONENT_DEFAULT_Z_INDEX-
DOCS_COMPONENT_HEADER_LAYER_INDEX-
DOCS_COMPONENT_MAIN_LAYER_INDEX-
DOC_UI_PLUGIN_NAMECopyright 2023-present DreamNum Inc.
DOC_VERTICAL_PADDINGCopyright 2023-present DreamNum Inc.
DefaultDocContainerConfig-
DefaultToolbarConfigCopyright 2023-present DreamNum Inc.
DeleteCommandThe command to delete text, mainly used in BACKSPACE and DELETE when collapsed is true. ONLY handle collapsed range!!!
DeleteCustomBlockCommand-
DeleteLeftCommand-
DeleteRightCommand-
DocCopyCommand-
DocCreateTableOperation-
DocCutCommand-
DocPasteCommand-
DocTableDeleteColumnsCommand-
DocTableDeleteRowsCommand-
DocTableDeleteTableCommand-
DocTableInsertColumnCommandThe command to insert table column.
DocTableInsertColumnLeftCommand-
DocTableInsertColumnRightCommand-
DocTableInsertRowAboveCommand-
DocTableInsertRowBellowCommand-
DocTableInsertRowCommandThe command to insert table row.
DocTableTabCommand-
EditorInsertTextCommandId-
EnterCommand-
IMEInputCommand-
InnerPasteCommand-
InsertCommandThe command to insert text. The changed range could be non-collapsed, mainly use in line break and normal input.
ListOperationCommand-
MergeTwoParagraphCommand-
MoveCursorOperationThe operation to move cursor in the current document.
MoveSelectionOperationThe operation to move selection in the current document.
NORMAL_TEXT_SELECTION_PLUGIN_NAME-
OrderListCommand-
PastePluginLark-
PastePluginUniver-
PastePluginWord-
QuickListCommand-
ReplaceContentCommand-
ReplaceSnapshotCommand-
ResetInlineFormatTextBackgroundColorCommand-
SelectAllOperation-
SetDocZoomRatioCommand-
SetDocZoomRatioOperation-
SetInlineFormatBoldCommand-
SetInlineFormatCommand-
SetInlineFormatFontFamilyCommand-
SetInlineFormatFontSizeCommand-
SetInlineFormatItalicCommand-
SetInlineFormatStrikethroughCommand-
SetInlineFormatSubscriptCommand-
SetInlineFormatSuperscriptCommand-
SetInlineFormatTextBackgroundColorCommand-
SetInlineFormatTextColorCommand-
SetInlineFormatUnderlineCommand-
TEXT_RANGE_LAYER_INDEX-
TabCommand-
ToggleCheckListCommand-
UpdateCommandThe command to update text properties, mainly used in BACKSPACE.
menuSchema-

Functions

FunctionDescription
IDocClipboardService-
IEditorService-
IRangeSelectorService-
RangeSelector-
TextEditorThe component to render toolbar item label and menu item label.
addCustomDecorationBySelectionFactory-
addCustomDecorationFactory-
addCustomRangeBySelectionFactory-
addCustomRangeFactory-
convertPositionsToRectRanges-
deleteCustomDecorationFactory-
deleteCustomRangeFactory-
docDrawingPositionToTransform-
genTableSource-
generateParagraphs-
getAnchorBounding-
getCanvasOffsetByEngine-
getCommandSkeletonGet the skeleton of the command's target.
getCursorWhenDelete-
getCustomBlockIdsInSelections-
getCutActionsFromDocRanges-
getDocObject-
getDocObjectById-
getEmptyTableCell-
getEmptyTableRow-
getLineBounding-
getOneTextSelectionRange-
getParagraphsInRange-
getParagraphsInRanges-
getRichTextEditPath-
getTableColumn-
hasParagraphInTable-
isInSameTableCell-
isValidRectRange-
neoGetDocObject-
replaceSelectionFactory-
transformToDocDrawingPosition-
whenDocAndEditorFocused-

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