@cool-office/docs-ui 0.0.0-stage → 1.2.0

package/lib/types/utils/horizontal-line.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 { IParagraph, Nullable } from '@cool-office/core';
+export declare function isHorizontalLineParagraph(dataStream: string, paragraph: Nullable<IParagraph>): boolean;

package/lib/types/utils/section-header-footer.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 { IDocumentData, IDocumentStyle, ISectionBreak, Nullable } from '@cool-office/core';
+import type { DocumentViewModel, IDocumentSkeletonPage } from '@cool-office/engine-render';
+import { HeaderFooterType } from '@cool-office/docs';
+import { DocumentEditArea } from '@cool-office/engine-render';
+export interface IDocPageSectionContext {
+    sectionId?: string;
+    sectionIndex: number;
+    sections: ISectionBreak[];
+    section?: ISectionBreak;
+    /** Effective config after applying the owning section over document defaults. */
+    config: IDocumentStyle & Partial<ISectionBreak>;
+}
+export interface IHeaderFooterTarget {
+    createType: Nullable<HeaderFooterType>;
+    headerFooterId: Nullable<string>;
+    sectionId?: string;
+}
+export declare function getDocPageSectionContext(snapshot: IDocumentData, page?: Pick<IDocumentSkeletonPage, 'sectionId'>): IDocPageSectionContext;
+export declare function getHeaderFooterTarget(viewModel: DocumentViewModel, editArea: DocumentEditArea, segmentPage: number, page?: IDocumentSkeletonPage): IHeaderFooterTarget;

package/lib/types/views/DocLayoutProgress.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 DocLayoutProgress(): import("react").JSX.Element | null;

package/lib/types/views/DocLayoutRecovery.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.
+ */
+export declare const DOC_LAYOUT_RECOVERY_COMPONENT = "DOC_LAYOUT_RECOVERY_COMPONENT";
+export declare function DocLayoutRecovery(): import("react").JSX.Element;

package/lib/types/views/DocPasteOptions.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.
+ */
+export declare const DOC_PASTE_OPTIONS_COMPONENT = "docs-ui.paste-options";
+export declare function DocPasteOptions(): import("react").JSX.Element | null;

package/lib/types/views/DocSideMenu.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 DocSideMenu(): import("react").JSX.Element | null;

package/lib/types/views/Icon.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { IconType, IIconProps } from '@cool-office/ui';
+type ColorSwatchIconProps = IIconProps & {
+    color: string;
+};
+export declare function BackgroundColorSwatchIcon({ className, style, onClick, color }: ColorSwatchIconProps): import("react").JSX.Element;
+export declare function HeaderTextColorIcon({ className, style, onClick, extend }: IIconProps): import("react").JSX.Element;
+export declare function DefaultTextColorIcon({ className, style, onClick }: IIconProps): import("react").JSX.Element;
+export declare const DocParagraphTextColorSwatchIcon0: IconType;
+export declare const DocParagraphTextColorSwatchIcon1: IconType;
+export declare const DocParagraphTextColorSwatchIcon2: IconType;
+export declare const DocParagraphTextColorSwatchIcon3: IconType;
+export declare const DocParagraphTextColorSwatchIcon4: IconType;
+export declare const DocParagraphTextColorSwatchIcon5: IconType;
+export declare const DocParagraphTextColorSwatchIcon6: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon0: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon1: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon2: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon3: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon4: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon5: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon6: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon7: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon8: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon9: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon10: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon11: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon12: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon13: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon14: IconType;
+export declare const DocParagraphBackgroundColorSwatchIcon15: IconType;
+export {};

package/lib/types/views/PageSettings.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { IConfirmChildrenProps } from '@cool-office/ui';
+import { DocumentFlavor, ModernDocumentWidthMode, PageOrientType } from '@cool-office/core';
+import { InputNumber, Select } from '@cool-office/design';
+export interface IPageSettingsProps {
+    onClose: () => void;
+    onConfirm: (settings: IPageSettings) => void;
+}
+export interface IPageSettings {
+    mode: DocumentFlavor.TRADITIONAL | DocumentFlavor.MODERN;
+    modernWidth: ModernDocumentWidthMode;
+    paperSize: string;
+    orientation: PageOrientType;
+    margins: {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
+    pageSize: {
+        width: number;
+        height: number;
+    };
+}
+export declare function PageSettings(props: IConfirmChildrenProps & {
+    InputNumberComponent?: typeof InputNumber;
+    SelectComponent?: typeof Select;
+}): import("react").JSX.Element;
+export declare const PAGE_SETTING_COMPONENT_ID = "docs.component.page-setting";

package/lib/types/views/ParagraphMenu.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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 { IDocumentBlockRange, IDocumentBody, JSONXActions } from '@cool-office/core';
+import type { IDocBlockMoveValidationContext } from '@cool-office/docs';
+import type { ITextRangeWithStyle } from '@cool-office/engine-render';
+import type { IPopup, IValueOption } from '@cool-office/ui';
+import type { CSSProperties } from 'react';
+import { NamedStyleType } from '@cool-office/core';
+import { DocBlockMoveValidatorService } from '@cool-office/docs';
+import type { IMutiPageParagraphBound } from '../services/doc-event-manager.service';
+import type { IDocBlockMenuTarget } from '../services/doc-paragraph-menu.service';
+import { DocParagraphMenuService } from '../services/doc-paragraph-menu.service';
+export declare function getParagraphMenuPopupDirection(anchorLeft: number, menuWidth?: number, viewportPadding?: number, options?: {
+    anchorRight?: number;
+    direction?: 'ltr' | 'rtl';
+    viewportWidth?: number;
+}): 'left' | 'right';
+export declare const PARAGRAPH_MENU_HOVER_OPEN_DELAY = 800;
+export declare function shouldExecuteParagraphMenuMove(validatorService: Pick<DocBlockMoveValidatorService, 'canMoveBlock'>, context: IDocBlockMoveValidationContext): boolean;
+export declare function createParagraphMenuHoverOpenScheduler(openMenu: () => void, delay?: number): {
+    schedule(): void;
+    cancel: () => void;
+    openNow(): void;
+};
+export declare function setParagraphMenuInteractionActive(docParagraphMenuService: Pick<DocParagraphMenuService, 'setParagraphMenuActive'> | null | undefined, active: boolean): void;
+export declare function isEmptyParagraphMenuTarget(dataStream: string, paragraph?: IMutiPageParagraphBound | null | void): boolean;
+export declare function getParagraphMenuTargetRange(paragraph?: IMutiPageParagraphBound | null | void): ITextRangeWithStyle | null;
+export declare function getParagraphMenuHoverBridgeStyle(anchorRect: {
+    left: number;
+    right: number;
+    top: number;
+    bottom: number;
+} | null | undefined, direction: 'left' | 'right', edgeOverlap?: number, verticalPadding?: number): CSSProperties | undefined;
+export declare function getParagraphMenuActiveHeadingCommandId(namedStyleType?: NamedStyleType): string;
+export declare function getParagraphMenuHiddenHeadingCommandIds(namedStyleType?: NamedStyleType): string[];
+export declare function getParagraphMenuCommand(params: IValueOption, targetRange?: ITextRangeWithStyle | null): {
+    commandId?: string;
+    params?: object;
+};
+export declare function getParagraphMenuResolvedCommand(option: IValueOption, targetRange?: ITextRangeWithStyle | null): {
+    commandId?: string;
+    params?: object;
+};
+export declare function getParagraphMenuCommandParams(commandId: string | undefined, commandParams: Record<string, unknown> | undefined, target: IDocBlockMenuTarget | null | undefined, unitId: string): Record<string, unknown> | undefined;
+export declare function shouldShowParagraphSettingMenu(target: IDocBlockMenuTarget | null | undefined): boolean;
+export declare function getParagraphMenuHiddenItemIds(menuType: string, target: IDocBlockMenuTarget | null | undefined, namedStyleType?: NamedStyleType): string[];
+export declare function unwrapBlockRangeBody(documentBody: IDocumentBody, blockRange: IDocumentBlockRange): {
+    body: IDocumentBody;
+    range: {
+        startOffset: number;
+        endOffset: number;
+        collapsed: boolean;
+    };
+};
+export declare function buildUnwrapBlockRangeActions(previousBody: IDocumentBody, nextBody: IDocumentBody, blockRange: IDocumentBlockRange): JSONXActions | null;
+export declare function getParagraphFormattingRange(target: IDocBlockMenuTarget | null | undefined, paragraph?: IMutiPageParagraphBound | null): ITextRangeWithStyle | null;
+export declare function getParagraphMenuCommandTargetRange(commandId: string | undefined, targetRange?: ITextRangeWithStyle | null, formattingRange?: ITextRangeWithStyle | null): ITextRangeWithStyle | null | undefined;
+export declare function finishParagraphMenuCommand(docParagraphMenuService: Pick<DocParagraphMenuService, 'hideParagraphMenu'> | null | undefined, hideMenu: () => void): void;
+export declare function getBlockRangeClipboardTargetRange(commandId: string, target: IDocBlockMenuTarget | null | undefined, paragraph?: IMutiPageParagraphBound | null | void): ITextRangeWithStyle | null;
+export declare const ParagraphMenu: ({ popup }: {
+    popup: IPopup;
+}) => import("react").JSX.Element;
+export declare const TableBlockMenu: ({ popup }: {
+    popup: IPopup;
+}) => import("react").JSX.Element;
+export declare function shouldUseInsertBelowRange(commandId: string, params: IValueOption): boolean;

package/lib/types/views/RichTextEditor.d.ts

@@ -0,0 +1,62 @@
+/**
+ * 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 { IDocumentData } from '@cool-office/core';
+import type { CSSProperties, ReactNode, RefObject } from 'react';
+import type { Editor, IEditorCanvasStyle } from '../services/editor/editor';
+import type { IEditorRuntimeConfig } from '../services/editor/editor-runtime-config';
+import type { IKeyboardEventConfig } from './rich-text-editor/hooks/use-keyboard-event';
+export interface IRichTextEditorProps {
+    /** Instance-only layout and interaction settings, never persisted in the document. */
+    renderConfig?: IEditorRuntimeConfig;
+    className?: string;
+    autoFocus?: boolean;
+    onFocusChange?: (isFocus: boolean, newValue?: string) => void;
+    initialValue?: IDocumentData | string;
+    onClickOutside?: () => void;
+    /** Keep the globally focused unit on the editor's host while this editor receives input focus. */
+    preserveHostFocus?: boolean;
+    /** Let the host own engine sizing, including a fixed backing-store ratio. */
+    cancelDefaultResizeListener?: boolean;
+    /** Fixed canvas backing-store ratio used with a host-managed layout. */
+    pixelRatio?: number;
+    /** Use an untransformed layout size when the editor DOM is displayed through a CSS transform. */
+    layoutSize?: Readonly<Pick<DOMRectReadOnly, 'width' | 'height'>>;
+    /** Keep document reflow independent from an oversized host-managed canvas. */
+    documentLayoutSize?: Readonly<Pick<DOMRectReadOnly, 'width' | 'height'>>;
+    /** Keep the editor viewport anchored while a host expands it to fit content. */
+    autoScroll?: boolean;
+    /** Let the editor create scrollbars when its content exceeds the current layout size. */
+    autoScrollbar?: boolean;
+    /** Publish transient drag ranges to the host. Defaults to false. */
+    emitSelectionWhileDragging?: boolean;
+    /** Keep host keyboard handlers active for non-collapsed selections. Defaults to false. */
+    keyboardEventsOnSelection?: boolean;
+    keyboardEventConfig?: IKeyboardEventConfig;
+    moveCursor?: boolean;
+    style?: CSSProperties;
+    isSingle?: boolean;
+    placeholder?: string;
+    editorId?: string;
+    onHeightChange?: (height: number) => void;
+    onChange?: (data: IDocumentData, str: string) => void;
+    maxHeight?: number;
+    defaultHeight?: number;
+    icon?: ReactNode;
+    editorRef?: RefObject<Editor | null> | ((editor: Editor | null) => void);
+    noStyle?: boolean;
+    canvasStyle?: IEditorCanvasStyle;
+}
+export declare const RichTextEditor: (props: IRichTextEditorProps) => import("react").JSX.Element;

package/lib/types/views/SideMenu.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { CSSProperties } from 'react';
+export interface ISideMenuItem {
+    text: string;
+    level: number;
+    id: string;
+    isTitle?: boolean;
+}
+export interface ISideMenuProps {
+    label: string;
+    menus?: ISideMenuItem[];
+    onClick?: (menu: ISideMenuItem) => void;
+    className?: string;
+    style?: CSSProperties;
+    mode?: 'float' | 'side-bar';
+    maxHeight: number;
+    activeId?: string;
+    open?: boolean;
+    onOpenChange?: (open: boolean) => void;
+    maxWidth?: number;
+    wrapperClass?: string;
+    wrapperStyle?: CSSProperties;
+    iconClass?: string;
+    iconStyle?: CSSProperties;
+}
+export interface ISideMenuInstance {
+    scrollTo: (id: string) => void;
+}
+export declare const SideMenu: import("react").ForwardRefExoticComponent<ISideMenuProps & import("react").RefAttributes<ISideMenuInstance>>;

package/lib/types/views/const.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 const COMPONENT_PREFIX = "UI_PLUGIN_DOCS";

package/lib/types/views/count-bar/CountBar.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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 ICountBarProps {
+    changeRatio?: (ratio: string) => void;
+    onChange?: (value: string) => void;
+}
+export declare function CountBar(_props: ICountBarProps): import("react").JSX.Element;
+export {};

package/lib/types/views/count-bar/ZoomSlider.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 ZoomSlider(): import("react").JSX.Element;

package/lib/types/views/count-bar/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 * from './CountBar';

package/lib/types/views/doc-footer/DocFooter.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 DocFooter(): import("react").JSX.Element | null;

package/lib/types/views/doc-footer/index.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 { DocFooter } from './DocFooter';

package/lib/types/views/doc-side-menu-layout.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 { IBoundRectNoAngle, IDocsTableRenderViewport } from '@cool-office/engine-render';
+export declare function isDocSideMenuTableOverlapping(outline: IBoundRectNoAngle, table: IBoundRectNoAngle, viewport: IDocsTableRenderViewport | null): boolean;

package/lib/types/views/doc-statistics/DocPageStatus.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { IDocumentLayoutProgress, IDocumentSkeletonPage } from '@cool-office/engine-render';
+type PageGeometry = Pick<IDocumentSkeletonPage, 'isLayoutPlaceholder' | 'isMaterializationPlaceholder' | 'pageHeight' | 'pageWidth'>;
+type LayoutProgress = Pick<IDocumentLayoutProgress, 'complete' | 'publishedPageCount'>;
+interface IDocPageStatus {
+    currentPage: number | null;
+    totalPages: number | null;
+    dragTooltip: {
+        left: number;
+        page: number;
+        top: number;
+    } | null;
+}
+export declare function resolveDocPageStatus(pages: Readonly<PageGeometry[]>, viewportCenter: number, pageGap: number, vertical: boolean, progress?: LayoutProgress | null): Pick<IDocPageStatus, 'currentPage' | 'totalPages'>;
+export declare function DocPageStatus(): import("react").JSX.Element | null;
+export {};

package/lib/types/views/doc-statistics/DocStatistics.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 DocStatistics(): import("react").JSX.Element;

package/lib/types/views/doc-statistics/use-doc-statistics.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { IDocumentStatistics, ITextRangeParam } from '@cool-office/core';
+import type { DocumentSkeleton } from '@cool-office/engine-render';
+interface IDocLayoutStatistics {
+    pages: number;
+    lines: number;
+}
+export interface IDocStatisticsViewState {
+    document: IDocumentStatistics & IDocLayoutStatistics;
+    selection: (IDocumentStatistics & IDocLayoutStatistics) | null;
+    loading: boolean;
+    showPages: boolean;
+}
+export declare function getDocLayoutStatistics(skeleton: DocumentSkeleton | null, ranges?: Readonly<ITextRangeParam>[], calculatePages?: boolean): IDocLayoutStatistics;
+export declare function useDocStatistics(calculateLayout?: boolean): IDocStatisticsViewState;
+export {};

package/lib/types/views/editor/utils.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.
+ */
+import type { IDocumentData } from '@cool-office/core';
+/**
+ *
+ * @param value The initial value of the editor.
+ * @returns snapshot generated by value.
+ */
+export declare function genSnapShotByValue(id?: string, value?: string): IDocumentData;