@univerjs/docs-ui 0.1.17 → 0.2.1

package/lib/index.css

@@ -1 +1 @@
-.univer-docs-ui-canvas-background{position:relative;width:100%;height:100%;background:rgb(var(--grey-50));z-index:1;user-select:none;pointer-events:none}
+.univer-docs-ui-canvas-background{position:relative;width:100%;height:100%;background:rgb(var(--grey-50));z-index:1;user-select:none;pointer-events:none}.univer-panel{padding-top:20px;font-size:var(--font-size-sm)}.univer-options-section{margin-top:10px;padding-bottom:10px}.univer-options-form-item{display:block;margin-bottom:5px}.univer-options-input{width:80%;margin-top:5px}.univer-options-margin-setting{display:flex}

package/lib/locale/en-US.json

@@ -24,6 +24,18 @@
     "alignLeft": "Align Left",
     "alignCenter": "Align Center",
     "alignRight": "Align Right",
-    "alignJustify": "Justify"
+    "alignJustify": "Justify",
+    "headerFooter": "Header & Footer"
+  },
+  "headerFooter": {
+    "header": "Header",
+    "footer": "Footer",
+    "panel": "Header & Footer Settings",
+    "firstPageCheckBox": "Different first page",
+    "oddEvenCheckBox": "Different odd and even pages",
+    "headerTopMargin": "Header top margin(px)",
+    "footerBottomMargin": "Footer bottom margin(px)",
+    "closeHeaderFooter": "Close header & footer",
+    "disableText": "Header & footer settings are disabled"
   }
 }

package/lib/locale/ru-RU.json

@@ -24,6 +24,18 @@
     "alignLeft": "Выровнять по левому краю",
     "alignCenter": "Выровнять по центру",
     "alignRight": "Выровнять по правому краю",
-    "alignJustify": "Выровнять по ширине"
+    "alignJustify": "Выровнять по ширине",
+    "headerFooter": "Header & Footer"
+  },
+  "headerFooter": {
+    "header": "Header",
+    "footer": "Footer",
+    "panel": "Header & Footer Settings",
+    "firstPageCheckBox": "Different first page",
+    "oddEvenCheckBox": "Different odd and even pages",
+    "headerTopMargin": "Header top margin(px)",
+    "footerBottomMargin": "Footer bottom margin(px)",
+    "closeHeaderFooter": "Close header & footer",
+    "disableText": "Header & footer settings are disabled"
   }
 }

package/lib/locale/zh-CN.json

@@ -24,6 +24,18 @@
     "alignLeft": "左对齐",
     "alignCenter": "居中对齐",
     "alignRight": "右对齐",
-    "alignJustify": "两端对齐"
+    "alignJustify": "两端对齐",
+    "headerFooter": "页眉页脚"
+  },
+  "headerFooter": {
+    "header": "页眉",
+    "footer": "页脚",
+    "panel": "页眉页脚设置",
+    "firstPageCheckBox": "首页不同",
+    "oddEvenCheckBox": "奇偶页不同",
+    "headerTopMargin": "页眉顶端距离（px）",
+    "footerBottomMargin": "页脚底端距离（px）",
+    "closeHeaderFooter": "关闭页眉页脚",
+    "disableText": "页眉页脚设置不可用"
   }
 }

package/lib/types/commands/commands/doc-header-footer.command.d.ts

@@ -0,0 +1,24 @@
+import { ICommand, BooleanNumber } from '@univerjs/core';
+import { HeaderFooterType } from '../../controllers/doc-header-footer.controller';
+
+export interface IHeaderFooterProps {
+    marginHeader?: number;
+    marginFooter?: number;
+    useFirstPageHeaderFooter?: BooleanNumber;
+    evenAndOddHeaders?: BooleanNumber;
+}
+export interface ICoreHeaderFooterParams {
+    unitId: string;
+    createType?: HeaderFooterType;
+    segmentId?: string;
+    headerFooterProps?: IHeaderFooterProps;
+}
+export declare const CoreHeaderFooterCommandId = "doc.command.core-header-footer";
+/**
+ * The command to update header and footer or create them.
+ */
+export declare const CoreHeaderFooterCommand: ICommand<ICoreHeaderFooterParams>;
+interface IOpenHeaderFooterPanelParams {
+}
+export declare const OpenHeaderFooterPanelCommand: ICommand<IOpenHeaderFooterPanelParams>;
+export {};

package/lib/types/commands/operations/doc-header-footer-panel.operation.d.ts

@@ -0,0 +1,6 @@
+import { ICommand } from '@univerjs/core';
+
+export interface IUIComponentCommandParams {
+    value: string;
+}
+export declare const SidebarDocHeaderFooterPanelOperation: ICommand;

package/lib/types/controllers/doc-header-footer.controller.d.ts

@@ -0,0 +1,35 @@
+import { DocumentDataModel, Disposable, ICommandService, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { IRenderContext, IRenderModule, IRenderManagerService, ITextSelectionRenderManager } from '@univerjs/engine-render';
+import { ComponentManager, IEditorService } from '@univerjs/ui';
+import { DocSkeletonManagerService } from '@univerjs/docs';
+
+export declare enum HeaderFooterType {
+    FIRST_PAGE_HEADER = 0,
+    FIRST_PAGE_FOOTER = 1,
+    DEFAULT_HEADER = 2,
+    DEFAULT_FOOTER = 3,
+    EVEN_PAGE_HEADER = 4,
+    EVEN_PAGE_FOOTER = 5
+}
+export declare class DocHeaderFooterController extends Disposable implements IRenderModule {
+    private readonly _context;
+    private readonly _commandService;
+    private readonly _editorService;
+    private readonly _instanceSrv;
+    private readonly _renderManagerService;
+    private readonly _docSkeletonManagerService;
+    private readonly _textSelectionRenderManager;
+    private readonly _localeService;
+    private readonly _componentManager;
+    private _loadedMap;
+    constructor(_context: IRenderContext<DocumentDataModel>, _commandService: ICommandService, _editorService: IEditorService, _instanceSrv: IUniverInstanceService, _renderManagerService: IRenderManagerService, _docSkeletonManagerService: DocSkeletonManagerService, _textSelectionRenderManager: ITextSelectionRenderManager, _localeService: LocaleService, _componentManager: ComponentManager);
+    private _initialize;
+    private _registerCommands;
+    private _initCustomComponents;
+    private _init;
+    private _initialMain;
+    private _getTransformCoordForDocumentOffset;
+    private _drawHeaderFooterLabel;
+    private _isEditorReadOnly;
+    private _getDocDataModel;
+}

package/lib/types/controllers/menu/menu.d.ts

@@ -10,6 +10,7 @@ export declare function SuperscriptMenuItemFactory(accessor: IAccessor): IMenuBu
 export declare function FontFamilySelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<string>;
 export declare function FontSizeSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<number>;
 export declare function TextColorSelectorMenuItemFactory(accessor: IAccessor): IMenuSelectorItem<string>;
+export declare function HeaderFooterMenuItemFactory(accessor: IAccessor): IMenuButtonItem;
 export declare function AlignLeftMenuItemFactory(accessor: IAccessor): IMenuButtonItem;
 export declare function AlignCenterMenuItemFactory(accessor: IAccessor): IMenuButtonItem;
 export declare function AlignRightMenuItemFactory(accessor: IAccessor): IMenuButtonItem;

package/lib/types/controllers/render-controllers/back-scroll.render-controller.d.ts

@@ -1,14 +1,18 @@
-import { DocumentDataModel, RxDisposable } from '@univerjs/core';
-import { DocSkeletonManagerService, TextSelectionManagerService } from '@univerjs/docs';
-import { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { DocumentDataModel, ITextRange, Nullable, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { TextSelectionManagerService } from '@univerjs/docs';
+import { INodePosition, IRenderContext, IRenderModule, IRenderManagerService } from '@univerjs/engine-render';
 import { IEditorService } from '@univerjs/ui';
 
 export declare class DocBackScrollRenderController extends RxDisposable implements IRenderModule {
     private readonly _context;
-    private readonly _docSkeletonManagerService;
     private readonly _textSelectionManagerService;
     private readonly _editorService;
-    constructor(_context: IRenderContext<DocumentDataModel>, _docSkeletonManagerService: DocSkeletonManagerService, _textSelectionManagerService: TextSelectionManagerService, _editorService: IEditorService);
+    private readonly _univerInstanceService;
+    private readonly _renderManagerService;
+    constructor(_context: IRenderContext<DocumentDataModel>, _textSelectionManagerService: TextSelectionManagerService, _editorService: IEditorService, _univerInstanceService: IUniverInstanceService, _renderManagerService: IRenderManagerService);
     private _init;
+    scrollToRange(unitId: string, range: ITextRange): void;
+    scrollToNode(unitId: string, startNodePosition: Nullable<INodePosition>): void;
     private _scrollToSelection;
+    private _getDocObject;
 }

package/lib/types/controllers/render-controllers/doc.render-controller.d.ts

@@ -1,6 +1,6 @@
 import { DocumentDataModel, ICommandService, IConfigService, RxDisposable } from '@univerjs/core';
 import { DocSkeletonManagerService } from '@univerjs/docs';
-import { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { IRenderContext, IRenderModule, IRenderManagerService } from '@univerjs/engine-render';
 import { IEditorService } from '@univerjs/ui';
 
 export declare class DocRenderController extends RxDisposable implements IRenderModule {
@@ -9,7 +9,9 @@ export declare class DocRenderController extends RxDisposable implements IRender
     private readonly _docSkeletonManagerService;
     private readonly _configService;
     private readonly _editorService;
-    constructor(_context: IRenderContext<DocumentDataModel>, _commandService: ICommandService, _docSkeletonManagerService: DocSkeletonManagerService, _configService: IConfigService, _editorService: IEditorService);
+    private readonly _renderManagerService;
+    constructor(_context: IRenderContext<DocumentDataModel>, _commandService: ICommandService, _docSkeletonManagerService: DocSkeletonManagerService, _configService: IConfigService, _editorService: IEditorService, _renderManagerService: IRenderManagerService);
+    reRender(unitId: string): void;
     private _addNewRender;
     private _addComponent;
     private _initRenderRefresh;

package/lib/types/controllers/render-controllers/text-selection.render-controller.d.ts

@@ -16,6 +16,7 @@ export declare class DocTextSelectionRenderController extends Disposable impleme
     private _initialize;
     private _init;
     private _initialMain;
+    private _getTransformCoordForDocumentOffset;
     private _isEditorReadOnly;
     private _setEditorFocus;
     private _commandExecutedListener;

package/lib/types/index.d.ts

@@ -13,6 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+export { whenDocAndEditorFocused } from './shortcuts/utils';
+export { IDocClipboardService } from './services/clipboard/clipboard.service';
+export { DocBackScrollRenderController } from './controllers/render-controllers/back-scroll.render-controller';
 export * from './basics';
 export * from './docs-ui-plugin';
 export { DocRenderController } from './controllers/render-controllers/doc.render-controller';
@@ -20,3 +23,4 @@ export * from './services';
 export { DocsRenderService } from './services/docs-render.service';
 export { DocCanvasPopManagerService } from './services/doc-popup-manager.service';
 export { docDrawingPositionToTransform, transformToDocDrawingPosition } from './basics/transform-position';
+export { DocCopyCommand, DocCutCommand, DocPasteCommand } from './commands/commands/clipboard.command';

package/lib/types/locale/zh-CN.d.ts

@@ -40,6 +40,18 @@ declare const locale: {
         alignCenter: string;
         alignRight: string;
         alignJustify: string;
+        headerFooter: string;
+    };
+    headerFooter: {
+        header: string;
+        footer: string;
+        panel: string;
+        firstPageCheckBox: string;
+        oddEvenCheckBox: string;
+        headerTopMargin: string;
+        footerBottomMargin: string;
+        closeHeaderFooter: string;
+        disableText: string;
     };
 };
 export default locale;

package/lib/types/services/clipboard/clipboard.service.d.ts

@@ -1,4 +1,4 @@
-import { Disposable, ICommandService, ILogService, IUniverInstanceService } from '@univerjs/core';
+import { IDocumentBody, Disposable, ICommandService, ILogService, IUniverInstanceService } from '@univerjs/core';
 import { IClipboardInterfaceService } from '@univerjs/ui';
 import { IDisposable } from '@wendellhu/redi';
 import { TextSelectionManagerService } from '@univerjs/docs';
@@ -8,6 +8,7 @@ export interface IClipboardPropertyItem {
 export interface IDocClipboardHook {
     onCopyProperty?(start: number, end: number): IClipboardPropertyItem;
     onCopyContent?(start: number, end: number): string;
+    onBeforePaste?: (body: IDocumentBody) => IDocumentBody;
 }
 export interface IDocClipboardService {
     copy(): Promise<boolean>;

package/lib/types/services/doc-mark-selection.service.d.ts

@@ -0,0 +1,27 @@
+import { IUniverInstanceService } from '@univerjs/core';
+import { BaseObject, IRenderManagerService, ITextRangeWithStyle } from '@univerjs/engine-render';
+
+export interface IDocMarkSelectionService {
+    addShape(selection: ITextRangeWithStyle, zIndex?: number): string | null;
+    removeShape(id: string): void;
+    removeAllShapes(): void;
+    refreshShapes(): void;
+    getShapeMap(): Map<string, IDocMarkSelectionInfo>;
+}
+export interface IDocMarkSelectionInfo {
+    control: BaseObject[] | null;
+    unitId: string;
+    selection: ITextRangeWithStyle;
+    zIndex: number;
+}
+export declare class DocMarkSelectionService implements IDocMarkSelectionService {
+    private readonly _univerInstanceService;
+    private readonly _renderManagerService;
+    private _shapeMap;
+    constructor(_univerInstanceService: IUniverInstanceService, _renderManagerService: IRenderManagerService);
+    addShape(selection: ITextRangeWithStyle, zIndex?: number): string | null;
+    removeShape(id: string): void;
+    removeAllShapes(): void;
+    refreshShapes(): void;
+    getShapeMap(): Map<string, IDocMarkSelectionInfo>;
+}

package/lib/types/services/doc-popup-manager.service.d.ts

@@ -1,4 +1,4 @@
-import { Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
+import { ITextRange, Disposable, ICommandService, IUniverInstanceService } from '@univerjs/core';
 import { IRenderManagerService, BaseObject, IBoundRectNoAngle, Scene } from '@univerjs/engine-render';
 import { IPopup, ICanvasPopupService } from '@univerjs/ui';
 import { IDisposable } from '@wendellhu/redi';
@@ -19,6 +19,7 @@ export declare class DocCanvasPopManagerService extends Disposable {
     private readonly _commandService;
     constructor(_globalPopupManagerService: ICanvasPopupService, _renderManagerService: IRenderManagerService, _univerInstanceService: IUniverInstanceService, _commandService: ICommandService);
     private _createObjectPositionObserver;
+    private _createRangePositionObserver;
     /**
      * attach a popup to canvas object
      * @param targetObject target canvas object
@@ -26,4 +27,5 @@ export declare class DocCanvasPopManagerService extends Disposable {
      * @returns disposable
      */
     attachPopupToObject(targetObject: BaseObject, popup: IDocCanvasPopup): IDisposable;
+    attachPopupToRange(range: ITextRange, popup: IDocCanvasPopup): IDisposable;
 }

package/lib/types/views/header-footer/panel/DocHeaderFooterOptions.d.ts

@@ -0,0 +1,6 @@
+import { default as React } from 'react';
+
+export interface IDocHeaderFooterOptionsProps {
+    unitId: string;
+}
+export declare const DocHeaderFooterOptions: (props: IDocHeaderFooterOptionsProps) => React.JSX.Element;

package/lib/types/views/header-footer/panel/DocHeaderFooterPanel.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+
+export declare const DocHeaderFooterPanel: () => React.JSX.Element;

package/lib/types/views/header-footer/panel/component-name.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare const COMPONENT_DOC_HEADER_FOOTER_PANEL = "COMPONENT_DOC_HEADER_FOOTER_PANEL";

package/lib/types/views/header-footer/text-bubble.d.ts

@@ -0,0 +1,20 @@
+import { IShapeProps, UniverRenderingContext, Shape } from '@univerjs/engine-render';
+
+export declare const COLLAB_CURSOR_LABEL_HEIGHT = 18;
+export declare const COLLAB_CURSOR_LABEL_MAX_WIDTH = 200;
+export declare const COLLAB_CURSOR_LABEL_TEXT_PADDING_LR = 6;
+export declare const COLLAB_CURSOR_LABEL_TEXT_PADDING_TB = 4;
+export interface ITextBubbleShapeProps extends IShapeProps {
+    color: string;
+    text: string;
+}
+/**
+ * Render a single collaborated cursor on the canvas.
+ */
+export declare class TextBubbleShape<T extends ITextBubbleShapeProps = ITextBubbleShapeProps> extends Shape<T> {
+    color: string;
+    text: string;
+    constructor(key: string, props: T);
+    static drawWith(ctx: CanvasRenderingContext2D, props: ITextBubbleShapeProps): void;
+    protected _draw(ctx: UniverRenderingContext): void;
+}