@univerjs/sheets-data-validation-ui 0.3.0-nightly.202410101606

package/lib/types/services/dropdown-manager.service.d.ts

@@ -0,0 +1,40 @@
+import { Nullable, Disposable, IUniverInstanceService } from '@univerjs/core';
+import { DataValidatorRegistryService } from '@univerjs/data-validation';
+import { IRenderManagerService } from '@univerjs/engine-render';
+import { ISheetLocation, SheetsSelectionsService } from '@univerjs/sheets';
+import { SheetDataValidationModel } from '@univerjs/sheets-data-validation';
+import { SheetCanvasPopManagerService } from '@univerjs/sheets-ui';
+import { IZenZoneService } from '@univerjs/ui';
+export interface IDropdownParam {
+    location: ISheetLocation;
+    onHide?: () => void;
+    componentKey: string;
+    trigger?: 'editor-bridge';
+}
+export interface IDropdownComponentProps {
+    componentKey: string;
+    location: ISheetLocation;
+    hideFn: () => void;
+}
+export declare class DataValidationDropdownManagerService extends Disposable {
+    private readonly _canvasPopupManagerService;
+    private readonly _univerInstanceService;
+    private readonly _dataValidatorRegistryService;
+    private readonly _zenZoneService;
+    private readonly _renderManagerService;
+    private readonly _dataValidationModel;
+    private readonly _sheetsSelectionsService;
+    private _activeDropdown;
+    private _activeDropdown$;
+    private _currentPopup;
+    activeDropdown$: import('rxjs').Observable<Nullable<IDropdownParam>>;
+    private _zenVisible;
+    get activeDropdown(): Nullable<IDropdownParam>;
+    constructor(_canvasPopupManagerService: SheetCanvasPopManagerService, _univerInstanceService: IUniverInstanceService, _dataValidatorRegistryService: DataValidatorRegistryService, _zenZoneService: IZenZoneService, _renderManagerService: IRenderManagerService, _dataValidationModel: SheetDataValidationModel, _sheetsSelectionsService: SheetsSelectionsService);
+    private _init;
+    private _getDropdownByCell;
+    private _initSelectionChange;
+    showDropdown(param: IDropdownParam, closeOnOutSide?: boolean): void;
+    hideDropdown(): void;
+    showDataValidationDropdown(unitId: string, subUnitId: string, row: number, col: number, onHide?: () => void): void;
+}

package/lib/types/views/components/date-dropdown/index.d.ts

@@ -0,0 +1,3 @@
+import { IDropdownComponentProps } from '../../../services/dropdown-manager.service';
+import { default as React } from 'react';
+export declare function DateDropdown(props: IDropdownComponentProps): React.JSX.Element | undefined;

package/lib/types/views/components/detail/index.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function DataValidationDetail(): React.JSX.Element | null;

package/lib/types/views/components/drop-down/CellDropdown.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function CellDropdown(): React.JSX.Element | null;

package/lib/types/views/components/drop-down/index.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 { CellDropdown } from './CellDropdown';
+declare const DROP_DOWN_KEY = "sheet.ui.dropdown";
+export { DROP_DOWN_KEY };

package/lib/types/views/components/formula-input/base-formula-input.d.ts

@@ -0,0 +1,3 @@
+import { IFormulaInputProps } from '@univerjs/data-validation';
+import { default as React } from 'react';
+export declare const BaseFormulaInput: (props: IFormulaInputProps) => React.JSX.Element;

package/lib/types/views/components/formula-input/checkbox-formula-input.d.ts

@@ -0,0 +1,3 @@
+import { IFormulaInputProps } from '@univerjs/data-validation';
+import { default as React } from 'react';
+export declare function CheckboxFormulaInput(props: IFormulaInputProps): React.JSX.Element;

package/lib/types/views/components/formula-input/custom-formula-input.d.ts

@@ -0,0 +1,3 @@
+import { IFormulaInputProps } from '@univerjs/data-validation';
+import { default as React } from 'react';
+export declare function CustomFormulaInput(props: IFormulaInputProps): React.JSX.Element;

package/lib/types/views/components/formula-input/formula-input.d.ts

@@ -0,0 +1,4 @@
+import { FormulaInputType } from '@univerjs/data-validation';
+export declare const BASE_FORMULA_INPUT_NAME = "data-validation.formula-input";
+export declare const LIST_FORMULA_INPUT_NAME = "data-validation.list-formula-input";
+export declare const FORMULA_INPUTS: [string, FormulaInputType][];

package/lib/types/views/components/formula-input/index.d.ts

@@ -0,0 +1,6 @@
+import { FormulaInputType } from '@univerjs/data-validation';
+export declare const CUSTOM_FORMULA_INPUT_NAME = "data-validation.custom-formula-input";
+export declare const BASE_FORMULA_INPUT_NAME = "data-validation.formula-input";
+export declare const LIST_FORMULA_INPUT_NAME = "data-validation.list-formula-input";
+export declare const CHECKBOX_FORMULA_INPUT_NAME = "data-validation.checkbox-formula-input";
+export declare const FORMULA_INPUTS: [string, FormulaInputType][];

package/lib/types/views/components/formula-input/list-formula-input.d.ts

@@ -0,0 +1,3 @@
+import { IFormulaInputProps } from '@univerjs/data-validation';
+import { default as React } from 'react';
+export declare function ListFormulaInput(props: IFormulaInputProps): React.JSX.Element;

package/lib/types/views/components/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * 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 { DateDropdown } from './date-dropdown';
+export { ListDropDown } from './list-dropdown';
+export { DataValidationPanel } from './panel';
+export declare const LIST_DROPDOWN_KEY = "data-validation.list.dropdown";
+export declare const DATE_DROPDOWN_KEY = "data-validation.date.dropdown";

package/lib/types/views/components/item/index.d.ts

@@ -0,0 +1,10 @@
+import { ISheetDataValidationRule } from '@univerjs/core';
+import { default as React } from 'react';
+export interface IDataValidationDetailProps {
+    rule: ISheetDataValidationRule;
+    onClick: () => void;
+    unitId: string;
+    subUnitId: string;
+    disable?: boolean;
+}
+export declare const DataValidationItem: (props: IDataValidationDetailProps) => React.JSX.Element;

package/lib/types/views/components/list/index.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function DataValidationList(): React.JSX.Element | null;

package/lib/types/views/components/list-dropdown/index.d.ts

@@ -0,0 +1,3 @@
+import { IDropdownComponentProps } from '../../../services/dropdown-manager.service';
+import { default as React } from 'react';
+export declare function ListDropDown(props: IDropdownComponentProps): React.JSX.Element | null | undefined;

package/lib/types/views/components/options/index.d.ts

@@ -0,0 +1,8 @@
+import { IDataValidationRuleOptions } from '@univerjs/core';
+import { default as React } from 'react';
+export interface IDataValidationOptionsParams {
+    value: IDataValidationRuleOptions;
+    onChange: (value: IDataValidationRuleOptions) => void;
+    extraComponent?: string;
+}
+export declare function DataValidationOptions(props: IDataValidationOptionsParams): React.JSX.Element;

package/lib/types/views/components/panel/index.d.ts

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

package/lib/types/views/components/render-mode/index.d.ts

@@ -0,0 +1,10 @@
+import { IDataValidationRuleOptions } from '@univerjs/core';
+import { default as React } from 'react';
+export interface IListRenderModeInputProps {
+    value: IDataValidationRuleOptions;
+    onChange: (value: IDataValidationRuleOptions) => void;
+}
+export declare function ListRenderModeInput(props: IListRenderModeInputProps): React.JSX.Element;
+export declare namespace ListRenderModeInput {
+    var componentKey: string;
+}

package/lib/types/views/components/show-time/index.d.ts

@@ -0,0 +1,10 @@
+import { IDataValidationRuleOptions } from '@univerjs/core';
+import { default as React } from 'react';
+export interface IDateShowTimeOptionProps {
+    value: IDataValidationRuleOptions;
+    onChange: (value: IDataValidationRuleOptions) => void;
+}
+export declare function DateShowTimeOption(props: IDateShowTimeOptionProps): React.JSX.Element;
+export declare namespace DateShowTimeOption {
+    var componentKey: string;
+}

package/lib/types/views/detail/index.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare function DataValidationDetail(): React.JSX.Element | null;

package/lib/types/views/validator-views/checkbox-validator-view.d.ts

@@ -0,0 +1,8 @@
+import { DataValidationType } from '@univerjs/core';
+import { CheckboxRender } from '../widgets/checkbox-widget';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class CheckboxValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    canvasRender: CheckboxRender;
+    formulaInput: string;
+}

package/lib/types/views/validator-views/custom-validator-view.d.ts

@@ -0,0 +1,6 @@
+import { DataValidationType } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class CustomFormulaValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    formulaInput: string;
+}

package/lib/types/views/validator-views/date-validator-view.d.ts

@@ -0,0 +1,8 @@
+import { DataValidationType } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class DateValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    formulaInput: string;
+    optionsInput: string;
+    dropdown: string;
+}

package/lib/types/views/validator-views/decimal-validator-view.d.ts

@@ -0,0 +1,6 @@
+import { DataValidationType } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class DecimalValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    formulaInput: string;
+}

package/lib/types/views/validator-views/list-multiple-view.d.ts

@@ -0,0 +1,7 @@
+import { DataValidationType } from '@univerjs/core';
+import { DropdownMultipleWidget } from '../widgets/dropdown-multiple-widget';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class ListMultipleValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    canvasRender: DropdownMultipleWidget;
+}

package/lib/types/views/validator-views/list-validator-view.d.ts

@@ -0,0 +1,10 @@
+import { IBaseDataValidationWidget } from '@univerjs/data-validation';
+import { DataValidationType, Nullable } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class ListValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    canvasRender: Nullable<IBaseDataValidationWidget>;
+    dropdown: string | undefined;
+    optionsInput: string | undefined;
+    formulaInput: string;
+}

package/lib/types/views/validator-views/sheet-validator-view.d.ts

@@ -0,0 +1,14 @@
+import { IBaseDataValidationWidget } from '@univerjs/data-validation';
+import { Injector, Nullable } from '@univerjs/core';
+/**
+ * This is the base class for all sheet data validator views. It is used to extend {@link BaseDataValidator}.
+ */
+export declare abstract class BaseSheetDataValidatorView {
+    protected readonly injector: Injector;
+    canvasRender: Nullable<IBaseDataValidationWidget>;
+    dropdown: string | undefined;
+    optionsInput: string | undefined;
+    abstract id: string;
+    formulaInput: string;
+    constructor(injector: Injector);
+}

package/lib/types/views/validator-views/text-length-validator.view.d.ts

@@ -0,0 +1,6 @@
+import { DataValidationType } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class TextLengthValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    formulaInput: string;
+}

package/lib/types/views/validator-views/whole-validator-view.d.ts

@@ -0,0 +1,6 @@
+import { DataValidationType } from '@univerjs/core';
+import { BaseSheetDataValidatorView } from './sheet-validator-view';
+export declare class WholeValidatorView extends BaseSheetDataValidatorView {
+    id: DataValidationType;
+    formulaInput: string;
+}

package/lib/types/views/widgets/checkbox-widget.d.ts

@@ -0,0 +1,19 @@
+import { ICellRenderContext, ICommandService, ThemeService } from '@univerjs/core';
+import { IBaseDataValidationWidget } from '@univerjs/data-validation';
+import { IMouseEvent, IPointerEvent, UniverRenderingContext2D } from '@univerjs/engine-render';
+import { DataValidationFormulaService } from '@univerjs/sheets-data-validation';
+export declare class CheckboxRender implements IBaseDataValidationWidget {
+    private readonly _commandService;
+    private readonly _formulaService;
+    private readonly _themeService;
+    private _calc;
+    constructor(_commandService: ICommandService, _formulaService: DataValidationFormulaService, _themeService: ThemeService);
+    calcCellAutoHeight(info: ICellRenderContext): number | undefined;
+    private _parseFormula;
+    drawWith(ctx: UniverRenderingContext2D, info: ICellRenderContext): void;
+    isHit(evt: {
+        x: number;
+        y: number;
+    }, info: ICellRenderContext): boolean;
+    onPointerDown(info: ICellRenderContext, evt: IPointerEvent | IMouseEvent): Promise<void>;
+}

package/lib/types/views/widgets/dropdown-multiple-widget.d.ts

@@ -0,0 +1,19 @@
+import { ICellRenderContext, ICommandService } from '@univerjs/core';
+import { IBaseDataValidationWidget } from '@univerjs/data-validation';
+import { IMouseEvent, IPointerEvent, Spreadsheet, SpreadsheetSkeleton, UniverRenderingContext2D } from '@univerjs/engine-render';
+export declare class DropdownMultipleWidget implements IBaseDataValidationWidget {
+    private readonly _commandService;
+    zIndex?: number | undefined;
+    private _dropdownInfoMap;
+    constructor(_commandService: ICommandService);
+    private _ensureMap;
+    private _generateKey;
+    private _drawDownIcon;
+    drawWith(ctx: UniverRenderingContext2D, info: ICellRenderContext, skeleton: SpreadsheetSkeleton, spreadsheets: Spreadsheet): void;
+    calcCellAutoHeight(info: ICellRenderContext): number | undefined;
+    isHit(position: {
+        x: number;
+        y: number;
+    }, info: ICellRenderContext): boolean;
+    onPointerDown(info: ICellRenderContext, evt: IPointerEvent | IMouseEvent): void;
+}

package/lib/types/views/widgets/dropdown-widget.d.ts

@@ -0,0 +1,28 @@
+import { ICellRenderContext, ICommandService, LocaleService } from '@univerjs/core';
+import { IBaseDataValidationWidget } from '@univerjs/data-validation';
+import { IMouseEvent, IPointerEvent, SpreadsheetSkeleton, UniverRenderingContext2D } from '@univerjs/engine-render';
+export interface IDropdownInfo {
+    top: number;
+    left: number;
+    width: number;
+    height: number;
+}
+export declare class DropdownWidget implements IBaseDataValidationWidget {
+    private readonly _localeService;
+    private readonly _commandService;
+    private _dropdownInfoMap;
+    constructor(_localeService: LocaleService, _commandService: ICommandService);
+    zIndex?: number | undefined;
+    onPointerEnter?: ((info: ICellRenderContext) => void) | undefined;
+    onPointerLeave?: ((info: ICellRenderContext) => void) | undefined;
+    private _ensureMap;
+    private _generateKey;
+    private _drawDownIcon;
+    drawWith(ctx: UniverRenderingContext2D, info: ICellRenderContext, skeleton: SpreadsheetSkeleton): void;
+    calcCellAutoHeight(info: ICellRenderContext): number | undefined;
+    isHit(position: {
+        x: number;
+        y: number;
+    }, info: ICellRenderContext): boolean;
+    onPointerDown(info: ICellRenderContext, evt: IPointerEvent | IMouseEvent): void;
+}

package/lib/types/views/widgets/shape/dropdown.d.ts

@@ -0,0 +1,12 @@
+import { IShapeProps, UniverRenderingContext, Shape } from '@univerjs/engine-render';
+import { IDropdownLayoutInfo } from './layout';
+export interface IDropdownProps extends IShapeProps {
+    fontString: string;
+    fontFamily: string;
+    fontSize: number;
+    info: IDropdownLayoutInfo;
+    color: string;
+}
+export declare class Dropdown extends Shape<IDropdownProps> {
+    static drawWith(ctx: UniverRenderingContext, props: IDropdownProps): void;
+}

package/lib/types/views/widgets/shape/index.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 { Dropdown } from './dropdown';
+export type { IDropdownProps } from './dropdown';
+export * from './layout';

package/lib/types/views/widgets/shape/layout.d.ts

@@ -0,0 +1,37 @@
+import { IStyleData, Nullable } from '@univerjs/core';
+import { IDocumentSkeletonFontStyle } from '@univerjs/engine-render';
+export declare const PADDING_H = 4;
+export declare const PADDING_V = 0;
+export declare const MARGIN_H = 4;
+export declare const MARGIN_V = 4;
+export declare const CELL_PADDING_H = 6;
+export declare const CELL_PADDING_V = 6;
+export declare const ICON_PLACE = 14;
+export declare function measureDropdownItemText(text: string, style: Nullable<IStyleData>): import('@univerjs/engine-render').IDocumentSkeletonBoundingBox;
+export declare function getDropdownItemSize(text: string, fontStyle: IDocumentSkeletonFontStyle): {
+    width: number;
+    height: number;
+    ba: number;
+};
+export interface IDropdownLayoutInfo {
+    layout: {
+        width: number;
+        height: number;
+        ba: number;
+    };
+    text: string;
+}
+export interface IDropdownLine {
+    width: number;
+    height: number;
+    items: (IDropdownLayoutInfo & {
+        left: number;
+    })[];
+}
+export declare function layoutDropdowns(items: string[], fontStyle: IDocumentSkeletonFontStyle, cellWidth: number, cellHeight: number): {
+    lines: IDropdownLine[];
+    totalHeight: number;
+    contentWidth: number;
+    contentHeight: number;
+    cellAutoHeight: number;
+};