@univerjs/docs-ui 1.0.2 → 1.0.4

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

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type { DocumentDataModel } from '@univerjs/core';
+import type { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { Disposable, IUniverInstanceService } from '@univerjs/core';
+import { DocSkeletonManagerService } from '@univerjs/docs';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { IRibbonService } from '@univerjs/ui';
+export declare class DocHeaderFooterRibbonController extends Disposable implements IRenderModule {
+    private readonly _context;
+    private readonly _instanceService;
+    private readonly _ribbonService;
+    private readonly _renderManager;
+    private _visible;
+    constructor(_context: IRenderContext<DocumentDataModel>, skeletonManager: DocSkeletonManagerService, _instanceService: IUniverInstanceService, _ribbonService: IRibbonService, _renderManager: IRenderManagerService);
+    private _focusedDocumentEditsHeaderFooter;
+    dispose(): void;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type { DocumentDataModel } from '@univerjs/core';
+import type { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { Disposable, IUniverInstanceService, ThemeService } from '@univerjs/core';
+import { DocSelectionManagerService } from '@univerjs/docs';
+import { DocEventManagerService } from '../../services/doc-event-manager.service';
+export declare class DocFieldRenderController extends Disposable implements IRenderModule {
+    private readonly _context;
+    private readonly _events;
+    private readonly _selections;
+    private readonly _instances;
+    private _hovered;
+    private _shade;
+    constructor(_context: IRenderContext<DocumentDataModel>, _events: DocEventManagerService, _selections: DocSelectionManagerService, theme: ThemeService, _instances: IUniverInstanceService);
+    private _drawFields;
+    private _getActiveFields;
+}

package/lib/types/controllers/ui.controller.d.ts

@@ -32,6 +32,7 @@ export declare class DocUIController extends Disposable {
     private _initShortCut;
     private _init;
     private _initCommands;
+    private _initDateTimeFields;
     private _initFocusHandler;
     private _shouldPreserveEmbedFocus;
 }

package/lib/types/index.d.ts

@@ -116,6 +116,7 @@ export { DocsRenderService } from './services/docs-render.service';
 export { Editor } from './services/editor/editor';
 export { EditorService, IEditorService } from './services/editor/editor-manager.service';
 export type { IEditorRuntimeConfig } from './services/editor/editor-runtime-config';
+export { getEditorRuntimeConfig, registerEditorRuntimeConfig } from './services/editor/editor-runtime-config';
 export { DocFloatMenuService } from './services/float-menu.service';
 export { isInSameTableCell, isValidRectRange, NodePositionConvertToRectRange, } from './services/selection/convert-rect-range';
 export { findDocRangeNodePositions } from './services/selection/convert-text-range';

package/lib/types/locale/en-US.d.ts

@@ -16,6 +16,7 @@
 declare const locale: {
     'docs-ui': {
         pasteOptions: {
+            special: string;
             title: string;
             source: string;
             destination: string;
@@ -114,6 +115,18 @@ declare const locale: {
             deleteTable: string;
         };
         headerFooter: {
+            navigation: string;
+            options: string;
+            position: string;
+            refreshFields: string;
+            pageNumber: string;
+            currentPage: string;
+            totalPages: string;
+            dateTime: string;
+            updateAutomatically: string;
+            insertFailed: string;
+            goToHeader: string;
+            goToFooter: string;
             header: string;
             footer: string;
             panel: string;

package/lib/types/menu/context-menu.d.ts

@@ -36,3 +36,4 @@ export declare function DeleteRowsMenuItemFactory(accessor: IAccessor): IMenuBut
 export declare function DeleteColumnsMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function DeleteTableMenuItemFactory(accessor: IAccessor): IMenuButtonItem<LocaleKey>;
 export declare function PasteSpecialMenuFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;
+export declare function PasteRibbonMenuFactory(accessor: IAccessor): IMenuSelectorItem<LocaleKey>;

package/lib/types/menu/header-footer-ribbon.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+import type { MenuSchemaType } from '@univerjs/ui';
+export declare const headerFooterRibbonSchema: MenuSchemaType;

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

@@ -39,6 +39,8 @@ export interface IDocClipboardPasteContext {
     targetUnitId: string;
 }
 export interface IDocClipboardHook {
+    /** Opt an internal rich-text editor into the post-paste format menu. */
+    supportsPasteOptions?(unitId: string): boolean;
     /** Supply a rich fragment for selections owned by a plugin rather than native text ranges. */
     onCopySelection?(unitId: string): {
         documentData: IDocumentData;
@@ -73,6 +75,7 @@ export interface IDocClipboardService {
     pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
     legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
     readonly pasteOptions$: Observable<IDocPasteOptionsState | null>;
+    isPasteOptionsEnabled(unitId: string): boolean;
     setNextPasteMode(mode: DocPasteMode): void;
     dismissPasteOptions(): void;
     changePasteMode(mode: DocPasteMode): Promise<boolean>;
@@ -107,6 +110,7 @@ export declare class DocClipboardService extends Disposable implements IDocClipb
     cut(ranges?: ITextRangeWithStyle[]): Promise<boolean>;
     pasteFromClipboard(mode?: DocPasteMode): Promise<boolean>;
     paste(items?: ClipboardItem[], mode?: DocPasteMode): Promise<boolean>;
+    isPasteOptionsEnabled(unitId: string): boolean;
     setNextPasteMode(mode: DocPasteMode): void;
     legacyPaste(options: IDocClipboardPayload): Promise<boolean>;
     dismissPasteOptions(): void;

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

@@ -169,6 +169,7 @@ export declare class DocEventManagerService extends Disposable implements IRende
     isPointerOnInteractiveRange(offsetX: number, offsetY: number): boolean;
     isPointerOnNonChecklistBullet(offsetX: number, offsetY: number): boolean;
     getBulletBounds(): IBulletBound[];
+    getCustomRangeBounds(): ICustomRangeBound[];
     getListContextMenuBulletByOffset(offsetX: number, offsetY: number): Nullable<IBulletBound>;
     private _buildCustomRangeBoundsBySegment;
     private _buildCustomRangeBounds;

package/lib/types/services/editor/editor-runtime-config.d.ts

@@ -19,6 +19,8 @@ export interface IEditorRuntimeConfig {
     layout?: IDocumentLayoutPresentation;
     inheritParagraphStartStyle?: boolean;
     disableSelectionAutoScroll?: boolean;
+    /** The host editor provides its own hyperlink menus and pointer interaction. */
+    customHyperLinkUI?: boolean;
 }
 export declare function registerEditorRuntimeConfig(model: DocumentDataModel, config: IEditorRuntimeConfig): IDisposable;
 export declare function getEditorRuntimeConfig(model: DocumentDataModel): IEditorRuntimeConfig | undefined;

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

@@ -92,6 +92,8 @@ export declare class DocSelectionRenderService extends RxDisposable implements I
     get hasPendingSelection(): boolean;
     get isOnPointerEvent(): boolean;
     get isFocusing(): boolean;
+    get inputElement(): HTMLDivElement;
+    get selectionContainer(): HTMLDivElement;
     get isEditing(): boolean;
     get canFocusing(): boolean;
     cancelPointerSelection(): void;

package/lib/types/services/selection/text-range.d.ts

@@ -41,6 +41,7 @@ export declare class TextRange implements IDocRange {
     style: ITextSelectionStyle;
     private _segmentId;
     private _segmentPage;
+    private _logicalRange?;
     rangeType: DOC_RANGE_TYPE;
     private _current;
     private _rangeShape;
@@ -48,7 +49,10 @@ export declare class TextRange implements IDocRange {
     private _cursorList;
     private _anchorBlinkTimer;
     private _anchorActiveStroke;
-    constructor(_scene: Scene, _document: Documents, _docSkeleton: DocumentSkeleton, anchorNodePosition?: Nullable<INodePosition>, focusNodePosition?: Nullable<INodePosition>, style?: ITextSelectionStyle, _segmentId?: string, _segmentPage?: number);
+    constructor(_scene: Scene, _document: Documents, _docSkeleton: DocumentSkeleton, anchorNodePosition?: Nullable<INodePosition>, focusNodePosition?: Nullable<INodePosition>, style?: ITextSelectionStyle, _segmentId?: string, _segmentPage?: number, _logicalRange?: {
+        startOffset: number;
+        endOffset: number;
+    } | undefined);
     private _anchorBlink;
     get startOffset(): number | undefined;
     get endOffset(): number | undefined;
@@ -73,6 +77,7 @@ export declare class TextRange implements IDocRange {
     dispose(): void;
     isIntersection(compareRange: TextRange): boolean;
     refresh(): void;
+    private _refreshLogicalRangePositions;
     private _isEmpty;
     private _isCollapsed;
     private _createOrUpdateRange;

package/lib/types/services/selection/word-boundary.d.ts

@@ -19,4 +19,5 @@ export interface IWordBoundary {
     endOffset: number;
 }
 export declare function getWordBoundaryByIndex(content: string, nodeIndex: number, paragraphStartOffset: number): IWordBoundary | null;
+export declare function getWordSelectionByIndex(content: string, nodeIndex: number, paragraphStartOffset: number, isBack: boolean): IWordBoundary | null;
 export declare function getNextWordBoundaryOffset(content: string, nodeIndex: number, paragraphStartOffset: number, direction: Direction): number | null;

package/lib/types/shortcuts/core-editing.shortcut.d.ts

@@ -19,3 +19,7 @@ export declare const SoftBreakLineShortcut: IShortcutItem;
 export declare const DeleteLeftShortcut: IShortcutItem;
 export declare const DeleteRightShortcut: IShortcutItem;
 export declare const CloseHeaderFooterShortcut: IShortcutItem;
+export declare const DeleteWordLeftShortcut: IShortcutItem;
+export declare const DeleteWordRightShortcut: IShortcutItem;
+export declare const DeleteLineStartShortcut: IShortcutItem;
+export declare const DeleteLineEndShortcut: IShortcutItem;

package/lib/types/shortcuts/format.shortcut.d.ts

@@ -15,4 +15,5 @@
  */
 import type { IShortcutItem } from '@univerjs/ui';
 export declare const TabShortCut: IShortcutItem;
+export declare const UpdateDocFieldsShortcut: IShortcutItem;
 export declare const ShiftTabShortCut: IShortcutItem;

package/lib/types/shortcuts/utils.d.ts

@@ -14,5 +14,6 @@
  * limitations under the License.
  */
 import type { IContextService } from '@univerjs/core';
+export declare function whenTextEditorFocused(contextService: IContextService): boolean;
 export declare function whenDocAndEditorFocused(contextService: IContextService): boolean;
 export declare function whenDocAndEditorFocusedWithBreakLine(contextService: IContextService): boolean;

package/lib/types/utils/date-time-field.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 type DateTimeFieldFormat = 'short' | 'long' | 'time';
+export declare function createDateTimeField(format: DateTimeFieldFormat, locale: string, date: Date): {
+    fieldType: string;
+    instruction: string;
+    cachedResult: string;
+};
+export declare function resolveDateTimeField(instruction: string, locale: string, date: Date): string | undefined;

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

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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 function DocHeaderFooterFields({ unitId, disabled }: {
+    unitId: string;
+    disabled: boolean;
+}): import("react").JSX.Element;

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

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * 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.
+ */
+interface IHeaderFooterRibbonControlProps {
+    kind: 'insertion' | 'navigation' | 'options' | 'position';
+}
+export declare function DocHeaderFooterRibbonControl(props: IHeaderFooterRibbonControlProps): import("react").JSX.Element | null;
+export {};

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

@@ -14,3 +14,5 @@
  * limitations under the License.
  */
 export declare const COMPONENT_DOC_HEADER_FOOTER_PANEL = "COMPONENT_DOC_HEADER_FOOTER_PANEL";
+export declare const DOC_HEADER_FOOTER_RIBBON_TAB = "docs-ui.ribbon.header-footer";
+export declare const DOC_HEADER_FOOTER_RIBBON_CONTROL = "DocHeaderFooterRibbonControl";

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

@@ -19,7 +19,7 @@ export declare function useHeaderFooterOptions(unitId: string): {
     linkedToPrevious: boolean;
     options: IHeaderFooterProps;
     handleLinkToPreviousChange: (linked: boolean) => Promise<void>;
-    handleCheckboxChange: (val: boolean, type: "useFirstPageHeaderFooter" | "evenAndOddHeaders") => void;
+    handleCheckboxChange: (val: boolean, type: "useFirstPageHeaderFooter" | "evenAndOddHeaders") => Promise<void>;
     handleMarginChange: (val: number, type: "marginHeader" | "marginFooter") => Promise<void>;
-    closeHeaderFooter: () => void;
+    closeHeaderFooter: () => Promise<boolean>;
 };