@univerjs/sheets-formula-ui 0.4.2 → 0.5.0-beta.0

package/lib/types/services/render-services/ref-selections.render-service.d.ts

@@ -1,7 +1,7 @@
-import { IDisposable, Workbook, Injector, ThemeService } from '@univerjs/core';
-import { IRenderContext, IRenderModule } from '@univerjs/engine-render';
+import { IDisposable, Nullable, Workbook, Injector, RANGE_TYPE, ThemeService } from '@univerjs/core';
+import { IMouseEvent, IPointerEvent, IRenderContext, IRenderModule, Scene, SpreadsheetSkeleton, Viewport, ScrollTimerType } from '@univerjs/engine-render';
 import { ISelectionWithStyle, SheetsSelectionsService } from '@univerjs/sheets';
-import { BaseSelectionRenderService, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
+import { BaseSelectionRenderService, SelectionControl, SheetSkeletonManagerService } from '@univerjs/sheets-ui';
 import { IShortcutService } from '@univerjs/ui';
 /**
  * This service extends the existing `SelectionRenderService` to provide the rendering of prompt selections
@@ -34,6 +34,12 @@ export declare class RefSelectionsRenderService extends BaseSelectionRenderServi
     enableSelectionChanging(): IDisposable;
     private _disableSelectionChanging;
     private _initCanvasEventListeners;
+    /**
+     * Add a selection in spreadsheet, create a new SelectionControl and then update this control by range derives from selection.
+     * For ref selection, create selectionShapeExtension to handle user action.
+     * @param {ISelectionWithCoord} selectionWithStyle
+     */
+    protected _addSelectionControlByModelData(selectionWithStyle: ISelectionWithStyle): SelectionControl;
     /**
      * Update selectionModel in this._workbookSelections by user action in spreadsheet area.
      */
@@ -41,7 +47,25 @@ export declare class RefSelectionsRenderService extends BaseSelectionRenderServi
     private _updateSelections;
     private _initSelectionChangeListener;
     private _initSkeletonChangeListener;
-    protected _refreshSelectionControl(selectionsData: readonly ISelectionWithStyle[]): void;
     private _getActiveViewport;
     private _getSheetObject;
+    /**
+     * Handle pointer down event, bind pointermove & pointerup handler.
+     * then trigger selectionMoveStart$.
+     *
+     * @param evt
+     * @param _zIndex
+     * @param rangeType
+     * @param viewport
+     * @param scrollTimerType
+     */
+    protected _onPointerDown(evt: IPointerEvent | IMouseEvent, _zIndex: number | undefined, rangeType: RANGE_TYPE | undefined, viewport: Nullable<Viewport>, scrollTimerType?: ScrollTimerType): void;
+    /**
+     * Diff between normal selection, no highlightHeader for ref selections.
+     * @param scene
+     * @param skeleton
+     * @param selectionWithCoord
+     * @returns {SelectionControl} selectionControl just created
+     */
+    newSelectionControl(scene: Scene, skeleton: SpreadsheetSkeleton, selection: ISelectionWithStyle): SelectionControl;
 }

package/lib/types/sheets-formula-ui.plugin.d.ts

@@ -13,7 +13,6 @@ export declare class UniverSheetsFormulaUIPlugin extends Plugin {
     static type: UniverInstanceType;
     constructor(_config: Partial<IUniverSheetsFormulaBaseConfig> | undefined, _injector: Injector, _renderManagerService: IRenderManagerService, _configService: IConfigService);
     onStarting(): void;
-    onReady(): void;
     onRendered(): void;
     onSteady(): void;
 }

package/lib/types/views/formula-editor/help-function/HelpFunction.d.ts

@@ -0,0 +1,11 @@
+import { IFunctionInfo } from '@univerjs/engine-formula';
+import { default as React } from 'react';
+interface IHelpFunctionProps {
+    functionInfo?: IFunctionInfo;
+    paramIndex: number;
+    editorId: string;
+    onParamsSwitch?: (index: number) => void;
+    onClose?: () => void;
+}
+export declare function HelpFunction(props: IHelpFunctionProps): React.JSX.Element;
+export {};

package/lib/types/views/formula-editor/hooks/useFormulaDescribe.d.ts

@@ -0,0 +1,7 @@
+import { Editor } from '@univerjs/docs-ui';
+import { IFunctionInfo } from '@univerjs/engine-formula';
+export declare const useFormulaDescribe: (isNeed: boolean, formulaText: string, editor?: Editor) => {
+    functionInfo: IFunctionInfo | undefined;
+    paramIndex: number;
+    reset: () => void;
+};

package/lib/types/views/formula-editor/hooks/useFormulaSearch.d.ts

@@ -0,0 +1,12 @@
+import { Editor } from '@univerjs/docs-ui';
+import { ISearchItem } from '@univerjs/sheets-formula';
+import { INode } from '../../range-selector/hooks/useFormulaToken';
+export declare const useFormulaSearch: (isNeed: boolean, nodes?: INode[], editor?: Editor) => {
+    searchList: ISearchItem[];
+    searchText: string;
+    handlerFormulaReplace: (formulaName: string) => {
+        text: string;
+        offset: number;
+    } | undefined;
+    reset: () => void;
+};

package/lib/types/views/formula-editor/hooks/useResizeScrollObserver.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+type Callback = () => void;
+export declare const useResizeScrollObserver: (callback: Callback, delay?: number) => void;
+export default useResizeScrollObserver;

package/lib/types/views/formula-editor/hooks/useSelectionAdd.d.ts

@@ -0,0 +1,19 @@
+import { Editor } from '@univerjs/docs-ui';
+import { INode } from '../../range-selector/utils/filterReferenceNode';
+/**
+ * 根据输入内容,以及当前光标位置判断下一个 mouseDown 事件是不是需要新增选区
+ *
+ * @param {string} unitId
+ * @param {INode[]} sequenceNodes
+ * @param {Editor} [editor]
+ * @return {*}
+ */
+export declare const useSelectionAdd: (unitId: string, sequenceNodes: INode[], editor?: Editor) => {
+    setIsAddSelection: (v: boolean) => void;
+    getIsNeedAddSelection: () => boolean;
+    isLockSelectionEvent: {
+        getValue: () => boolean;
+        setValue: (v: boolean) => void;
+        reset: () => void;
+    };
+};

package/lib/types/views/formula-editor/hooks/useSheetSelectionChange.d.ts

@@ -0,0 +1,3 @@
+import { Editor } from '@univerjs/docs-ui';
+import { INode } from '../../range-selector/utils/filterReferenceNode';
+export declare const useSheetSelectionChange: (isNeed: boolean, unitId: string, subUnitId: string, sequenceNodes: INode[], isSupportAcrossSheet: boolean, editor?: Editor, handleRangeChange?: ((refString: string, offset: number, isEnd: boolean) => void)) => void;

package/lib/types/views/formula-editor/hooks/useStateRef.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 useStateRef: <T = any>(value: T) => {
+    current: T;
+};

package/lib/types/views/formula-editor/hooks/useVerify.d.ts

@@ -0,0 +1,2 @@
+import { IFormulaEditorProps } from '../index';
+export declare const useVerify: (isNeed: boolean, onVerify: IFormulaEditorProps["onVerify"], formulaText: string) => void;

package/lib/types/views/formula-editor/index.d.ts

@@ -0,0 +1,17 @@
+import { ReactNode, default as React } from 'react';
+export interface IFormulaEditorProps {
+    unitId: string;
+    subUnitId: string;
+    initValue: `=${string}`;
+    onChange: (text: string) => void;
+    errorText?: string | ReactNode;
+    onVerify?: (res: boolean, result: string) => void;
+    isFocus?: boolean;
+    onFocus?: () => void;
+    onBlur?: () => void;
+    isSupportAcrossSheet?: boolean;
+    actions?: {
+        handleOutClick?: (e: MouseEvent, cb: () => void) => void;
+    };
+}
+export declare function FormulaEditor(props: IFormulaEditorProps): React.JSX.Element;

package/lib/types/views/formula-editor/search-function/SearchFunction.d.ts

@@ -0,0 +1,12 @@
+import { ISearchItem } from '@univerjs/sheets-formula';
+import { default as React } from 'react';
+interface ISearchFunctionProps {
+    searchList: ISearchItem[];
+    searchText: string;
+    onSelect: (functionName: string) => void;
+    onChange?: (functionName: string) => void;
+    editorId: string;
+    onClose?: () => void;
+}
+export declare const SearchFunction: React.ForwardRefExoticComponent<ISearchFunctionProps & React.RefAttributes<HTMLElement>>;
+export {};

package/lib/types/{controllers/utils/__tests__/ref-range-formula.spec.d.ts → views/formula-editor/utils/getFormulaText.d.ts}

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+export declare const getFormulaText: (formula: string) => string;

package/lib/types/views/range-selector/hooks/useEmitChange.d.ts

@@ -0,0 +1,3 @@
+import { Editor } from '@univerjs/docs-ui';
+import { INode } from './useFormulaToken';
+export declare const useEmitChange: (sequenceNodes: INode[], onChange: (v: string) => void, editor?: Editor) => () => boolean;

package/lib/types/views/range-selector/hooks/useFirstHighlightDoc.d.ts

@@ -0,0 +1,3 @@
+import { Editor } from '@univerjs/docs-ui';
+import { useDocHight, useSheetHighlight } from './useHighlight';
+export declare const useFirstHighlightDoc: (text: string, leadingCharacter: string, isNeed: boolean, highlightDoc: ReturnType<typeof useDocHight>, highlightSheet: ReturnType<typeof useSheetHighlight>, editor?: Editor) => void;

package/lib/types/views/range-selector/hooks/useFocus.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from '@univerjs/docs-ui';
+export declare const useFocus: (editor?: Editor) => () => void;

package/lib/types/views/range-selector/hooks/useFormulaToken.d.ts

@@ -1,5 +1,3 @@
 import { ISequenceNode } from '@univerjs/engine-formula';
-export declare const useFormulaToken: (text: string) => {
-    sequenceNodes: (string | ISequenceNode)[];
-    sequenceNodesSet: import('react').Dispatch<import('react').SetStateAction<(string | ISequenceNode)[]>>;
-};
+export type INode = (string | ISequenceNode);
+export declare const useFormulaToken: () => (text: string) => (string | ISequenceNode)[];

package/lib/types/views/range-selector/hooks/useHighlight.d.ts

@@ -1,5 +1,7 @@
 import { ITextRun } from '@univerjs/core';
+import { Editor } from '@univerjs/docs-ui';
 import { ISequenceNode } from '@univerjs/engine-formula';
+import { INode } from './useFormulaToken';
 import { IDescriptionService } from '@univerjs/sheets-formula';
 interface IRefSelection {
     refIndex: number;
@@ -11,8 +13,8 @@ interface IRefSelection {
  * @param {string} subUnitId 打开面板的时候传入的 sheetId
  * @param {IRefSelection[]} refSelections
  */
-export declare function useSheetHighlight(isNeed: boolean, unitId: string, subUnitId: string, refSelections: IRefSelection[]): void;
-export declare function useDocHight(editorId: string, sequenceNodes: (string | ISequenceNode)[]): IRefSelection[];
+export declare function useSheetHighlight(unitId: string): (refSelections: IRefSelection[]) => void;
+export declare function useDocHight(_leadingCharacter?: string): (editor: Editor, sequenceNodes: INode[], isNeedResetSelection?: boolean) => IRefSelection[];
 export declare function useColor(): {
     formulaRefColors: string[];
     numberColor: string;

package/lib/types/views/range-selector/hooks/useLeftAndRightArrow.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from '@univerjs/docs-ui';
+export declare const useLeftAndRightArrow: (isNeed: boolean, editor?: Editor) => void;

package/lib/types/views/range-selector/hooks/useOnlyOneRange.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 useOnlyOneRange: (unitId: string, isOnlyOneRange: boolean) => void;

package/lib/types/views/range-selector/hooks/useRefactorEffect.d.ts

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export declare const useRefactorEffect: (isNeed: boolean, unitId: string, isOnlyOneRange: boolean) => void;
+export declare const useRefactorEffect: (isNeed: boolean, unitId: string) => void;

package/lib/types/{controllers/utils/__tests__/offset-formula-data.spec.d.ts → views/range-selector/hooks/useRefocus.d.ts}

@@ -13,4 +13,4 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-export {};
+export declare const useRefocus: () => void;

package/lib/types/views/range-selector/hooks/useResetSelection.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 useResetSelection: (isNeed: boolean) => () => void;

package/lib/types/views/range-selector/hooks/useSheetSelectionChange.d.ts

@@ -1,2 +1,2 @@
 import { INode } from '../utils/filterReferenceNode';
-export declare const useSheetSelectionChange: (isNeed: boolean, unitId: string, _subUnitId: string, sequenceNodes: INode[], isSupportAcrossSheet: boolean, isOnlyOneRange: boolean, handleRangeChange: (refString: string, offset: number) => void) => void;
+export declare const useSheetSelectionChange: (isNeed: boolean, unitId: string, _subUnitId: string, sequenceNodes: INode[], isSupportAcrossSheet: boolean, isOnlyOneRange: boolean, handleRangeChange: (refString: string, offset: number, isEnd: boolean) => void) => void;

package/lib/types/views/range-selector/hooks/useSwitchSheet.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 useSwitchSheet: (isNeed: boolean, unitId: string, isSupportAcrossSheet: boolean, isFocusSet: (v: boolean) => void, onBlur: () => void, refresh: () => void) => void;

package/lib/types/views/range-selector/hooks/useVerify.d.ts

@@ -1,3 +1,3 @@
 import { IRangeSelectorProps } from '../';
-import { useFormulaToken } from './useFormulaToken';
-export declare const useVerify: (onVerify: IRangeSelectorProps["onVerify"], sequenceNodes: ReturnType<typeof useFormulaToken>["sequenceNodes"]) => void;
+import { INode } from './useFormulaToken';
+export declare const useVerify: (isNeed: boolean, onVerify: IRangeSelectorProps["onVerify"], sequenceNodes: INode[]) => void;

package/lib/types/views/range-selector/index.d.ts

@@ -10,13 +10,9 @@ export interface IRangeSelectorProps {
     placeholder?: string;
     isFocus?: boolean;
     onBlur?: () => void;
-    /**
-     * 暂无效果
-     * @memberof IRangeSelectorProps
-     */
     onFocus?: () => void;
     actions?: {
-        handleOutClick?: (e: React.MouseEvent<HTMLDivElement, MouseEvent>, cb: (v: boolean) => void) => void;
+        handleOutClick?: (e: MouseEvent, cb: () => void) => void;
     };
     /**
      * 是否只允许最多一个 range 区域,默认为 false。

package/lib/types/views/range-selector/utils/unitRangesToText.d.ts

@@ -1,4 +1,4 @@
 import { IUnitRangeName, IUniverInstanceService } from '@univerjs/core';
 export declare function getSheetIdByName(univerInstanceService: IUniverInstanceService, unitId: string, name: string): string;
 export declare function getSheetNameById(univerInstanceService: IUniverInstanceService, unitId: string, sheetId: string): string;
-export declare const unitRangesToText: (ranges: IUnitRangeName[], isSupportAcrossSheet?: boolean) => string[];
+export declare const unitRangesToText: (ranges: IUnitRangeName[], isNeedSheetName?: boolean) => string[];