Skip to content

Build your own AI office with Univer Office SDK. Bring editing, calculation, collaboration, and file processing into your product for people and AI agents. Built on an extensible open-source core.

feat(sheets-data-validation): support dropdown filter & fix paste error on data-validation cell (#3057)

zhangwe2e7d2a0cc35
diff --git a/examples/src/data/sheets/demo/default-workbook-data-demo.ts b/examples/src/data/sheets/demo/default-workbook-data-demo.ts
index ffb203b329..2b6473b361 100644
--- a/examples/src/data/sheets/demo/default-workbook-data-demo.ts
+++ b/examples/src/data/sheets/demo/default-workbook-data-demo.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import type { IDocumentData, IWorkbookData } from '@univerjs/core';
+import type { IDataValidationRule, IDocumentData, IWorkbookData } from '@univerjs/core';
import { BooleanNumber, DataValidationErrorStyle, DataValidationOperator, DataValidationType, LocaleType } from '@univerjs/core';
import { DATA_VALIDATION_PLUGIN_NAME } from '@univerjs/sheets-data-validation';
@@ -102,7 +102,7 @@ const richTextDemo1: IDocumentData = {
},
};
-const dataValidation = [
+const dataValidation: IDataValidationRule[] = [
{
uid: 'xxx-1',
type: DataValidationType.DECIMAL,
@@ -150,6 +150,7 @@ const dataValidation = [
endColumn: 5,
}],
formula1: '1,2,3,hahaha,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18',
+ renderMode: 1,
},
{
uid: 'xxx-4',
diff --git a/packages/core/src/types/const/const.ts b/packages/core/src/types/const/const.ts
index 465c7608ac..febd7f5a07 100644
--- a/packages/core/src/types/const/const.ts
+++ b/packages/core/src/types/const/const.ts
@@ -152,6 +152,7 @@ export const DEFAULT_STYLES = {
b: 0,
l: 0,
},
+ n: null,
};
export const DEFAULT_SLIDE = {
diff --git a/packages/sheets-data-validation/package.json b/packages/sheets-data-validation/package.json
index 4dcddefc0f..8fcadacbef 100644
--- a/packages/sheets-data-validation/package.json
+++ b/packages/sheets-data-validation/package.json
@@ -65,6 +65,7 @@
"@univerjs/core": "workspace:*",
"@univerjs/data-validation": "workspace:*",
"@univerjs/design": "workspace:*",
+ "@univerjs/docs": "workspace:*",
"@univerjs/engine-formula": "workspace:*",
"@univerjs/engine-render": "workspace:*",
"@univerjs/sheets": "workspace:*",
@@ -84,6 +85,7 @@
"@univerjs/core": "workspace:*",
"@univerjs/data-validation": "workspace:*",
"@univerjs/design": "workspace:*",
+ "@univerjs/docs": "workspace:*",
"@univerjs/engine-formula": "workspace:*",
"@univerjs/engine-render": "workspace:*",
"@univerjs/shared": "workspace:*",
diff --git a/packages/sheets-data-validation/src/controllers/dv-render.controller.ts b/packages/sheets-data-validation/src/controllers/dv-render.controller.ts
index 24364c71b4..80142fd186 100644
--- a/packages/sheets-data-validation/src/controllers/dv-render.controller.ts
+++ b/packages/sheets-data-validation/src/controllers/dv-render.controller.ts
@@ -390,7 +390,7 @@ export class SheetsDataValidationMobileRenderController extends RxDisposable {
INTERCEPTOR_POINT.CELL_CONTENT,
{
priority: 200,
- // eslint-disable-next-line max-lines-per-function
+ // eslint-disable-next-line max-lines-per-function, complexity
handler: (cell, pos, next) => {
const { row, col, unitId, subUnitId, workbook, worksheet } = pos;
const manager = this._dataValidationModel.ensureManager(unitId, subUnitId) as SheetDataValidationManager;
diff --git a/packages/sheets-data-validation/src/validators/date-validator.ts b/packages/sheets-data-validation/src/validators/date-validator.ts
index 45dfb4082d..9103943788 100644
--- a/packages/sheets-data-validation/src/validators/date-validator.ts
+++ b/packages/sheets-data-validation/src/validators/date-validator.ts
@@ -27,6 +27,7 @@ import { getFormulaResult } from '../utils/formula';
import { DATE_DROPDOWN_KEY } from '../views';
import { DateOperatorErrorTitleMap, DateOperatorNameMap, DateOperatorTitleMap } from '../common/date-text-map';
import { DateShowTimeOption } from '../views/show-time';
+import { getCellValueOrigin } from '../utils/get-cell-data-origin';
const FORMULA1 = '{FORMULA1}';
const FORMULA2 = '{FORMULA2}';
@@ -87,19 +88,11 @@ export class DateValidator extends BaseDataValidator<number> {
}
override async isValidType(info: IValidatorCellInfo): Promise<boolean> {
- const { value, worksheet, row, column, workbook } = info;
- if (typeof value === 'string') {
- return dayjs(value, 'YYYY-MM-DD HH:mm:ss', true).isValid();
- }
-
- if (typeof value === 'number') {
- const cell = worksheet.getCellRaw(row, column);
- if (cell && cell.s) {
- const style = workbook.getStyles().get(cell.s);
- if (style?.n?.pattern.indexOf('yyyy-MM-dd') === 0) {
- return true;
- }
- }
+ const { value, worksheet, row, column } = info;
+ const cell = worksheet.getCell(row, column);
+ const interceptValue = getCellValueOrigin(cell);
+ if (typeof interceptValue === 'string' && typeof value === 'number') {
+ return dayjs(interceptValue).isValid();
}
return false;
diff --git a/packages/sheets-data-validation/src/views/list-dropdown/index.tsx b/packages/sheets-data-validation/src/views/list-dropdown/index.tsx
index 04f4205f15..9e8355e367 100644
--- a/packages/sheets-data-validation/src/views/list-dropdown/index.tsx
+++ b/packages/sheets-data-validation/src/views/list-dropdown/index.tsx
@@ -14,10 +14,11 @@
* limitations under the License.
*/
-import { DataValidationRenderMode, DataValidationType, ICommandService, LocaleService, useDependency } from '@univerjs/core';
+import type { DocumentDataModel } from '@univerjs/core';
+import { DataValidationRenderMode, DataValidationType, ICommandService, IUniverInstanceService, LocaleService, UniverInstanceType, useDependency } from '@univerjs/core';
import type { ISetRangeValuesCommandParams } from '@univerjs/sheets';
import { SetRangeValuesCommand } from '@univerjs/sheets';
-import React, { useMemo, useState } from 'react';
+import React, { useEffect, useMemo, useState } from 'react';
import { CheckMarkSingle } from '@univerjs/icons';
import { IEditorBridgeService } from '@univerjs/sheets-ui';
import { KeyCode, useObservable } from '@univerjs/ui';
@@ -25,6 +26,8 @@ import { DeviceInputEventType } from '@univerjs/engine-render';
import { RectPopup, Scrollbar } from '@univerjs/design';
import { DataValidationModel } from '@univerjs/data-validation';
import { debounceTime } from 'rxjs';
+import type { IRichTextEditingMutationParams } from '@univerjs/docs';
+import { getPlainTextFormDocument, RichTextEditingMutation } from '@univerjs/docs';
import type { ListMultipleValidator } from '../../validators/list-multiple-validator';
import { deserializeListOptions, getDataValidationCellValue, serializeListOptions } from '../../validators/util';
import type { IDropdownComponentProps } from '../../services/dropdown-manager.service';
@@ -40,11 +43,14 @@ interface ISelectListProps {
title?: string;
onEdit?: () => void;
style?: React.CSSProperties;
+ filter?: string;
}
const SelectList = (props: ISelectListProps) => {
- const { value, onChange, multiple, options, title, onEdit, style } = props;
+ const { value, onChange, multiple, options, title, onEdit, style, filter } = props;
const localeService = useDependency(LocaleService);
+ const lowerFilter = filter?.toLowerCase();
+ const filteredOptions = options.filter((item) => lowerFilter ? item.label.toLowerCase().includes(lowerFilter) : true);
return (
<div className={styles.dvListDropdown} style={style}>
@@ -52,9 +58,9 @@ const SelectList = (props: ISelectListProps) => {
{title}
</div>
<div className={styles.dvListDropdownList}>
- <Scrollbar>
+ <Scrollbar key={filter}>
<div className={styles.dvListDropdownListContainer}>
- {options.map((item, i) => {
+ {filteredOptions.map((item, i) => {
const selected = value.indexOf(item.value) > -1;
const handleClick = () => {
let set: Set<string>;
@@ -72,9 +78,21 @@ const SelectList = (props: ISelectListProps) => {
onChange(newValue);
};
+
+ const index = item.label.toLocaleLowerCase().indexOf(lowerFilter!);
return (
<div key={i} className={styles.dvListDropdownItemContainer} onClick={handleClick}>
- <div className={styles.dvListDropdownItem} style={{ background: item.color || DROP_DOWN_DEFAULT_COLOR }}>{item.label}</div>
+ <div className={styles.dvListDropdownItem} style={{ background: item.color || DROP_DOWN_DEFAULT_COLOR }}>
+ {lowerFilter && item.label.toLowerCase().includes(lowerFilter)
+ ? (
+ <>
+ <span>{item.label.substring(0, index)}</span>
+ <span style={{ fontWeight: 'bold' }}>{item.label.substring(index, index + lowerFilter.length)}</span>
+ <span>{item.label.substring(index + lowerFilter.length)}</span>
+ </>
+ )
+ : item.label}
+ </div>
<div className={styles.dvListDropdownSelectedIcon}>
{selected ? <CheckMarkSingle /> : null}
</div>
@@ -96,14 +114,36 @@ export function ListDropDown(props: IDropdownComponentProps) {
const { location, hideFn } = props;
const { worksheet, row, col, unitId, subUnitId } = location;
const dataValidationModel = useDependency(DataValidationModel);
+ const [editingText, setEditingText] = useState('');
const commandService = useDependency(ICommandService);
const localeService = useDependency(LocaleService);
const [localValue, setLocalValue] = useState('');
const editorBridgeService = useDependency(IEditorBridgeService);
+ const instanceService = useDependency(IUniverInstanceService);
const ruleChange$ = useMemo(() => dataValidationModel.ruleChange$.pipe(debounceTime(16)), []);
useObservable(ruleChange$);
const anchorRect = RectPopup.useContext();
const cellWidth = anchorRect.right - anchorRect.left;
+
+ useEffect(() => {
+ const dispose = commandService.onCommandExecuted((command) => {
+ if (command.id === RichTextEditingMutation.id) {
+ const params = command.params as IRichTextEditingMutationParams;
+ const { unitId } = params;
+ const unit = instanceService.getUnit<DocumentDataModel>(unitId, UniverInstanceType.UNIVER_DOC);
+ if (!unit) {
+ return;
+ }
+ const text = getPlainTextFormDocument(unit.getSnapshot());
+ setEditingText(text);
+ }
+ });
+
+ return () => {
+ dispose.dispose();
+ };
+ }, [commandService, instanceService]);
+
if (!worksheet) {
return null;
}
@@ -113,7 +153,7 @@ export function ListDropDown(props: IDropdownComponentProps) {
const validator = cellData?.dataValidation?.validator as ListMultipleValidator | undefined;
const showColor = rule?.renderMode === DataValidationRenderMode.CUSTOM || rule?.renderMode === undefined;
- if (!cellData || !rule || !validator) {
+ if (!cellData || !rule || !validator || validator.id.indexOf(DataValidationType.LIST) !== 0) {
return;
}
@@ -129,6 +169,12 @@ export function ListDropDown(props: IDropdownComponentProps) {
hideFn();
};
+ const options = list.map((item) => ({
+ label: item.label,
+ value: item.label,
+ color: showColor ? item.color : 'transparent',
+ }));
+
return (
<SelectList
style={{ minWidth: cellWidth, maxWidth: Math.max(cellWidth, 200) }}
@@ -172,12 +218,9 @@ export function ListDropDown(props: IDropdownComponentProps) {
hideFn();
}
}}
- options={list.map((item) => ({
- label: item.label,
- value: item.label,
- color: showColor ? item.color : 'transparent',
- }))}
+ options={options}
onEdit={handleEdit}
+ filter={editingText}
/>
);
}
diff --git a/packages/sheets-data-validation/src/widgets/dropdown-widget.ts b/packages/sheets-data-validation/src/widgets/dropdown-widget.ts
index b1158241c5..f5bf984534 100644
--- a/packages/sheets-data-validation/src/widgets/dropdown-widget.ts
+++ b/packages/sheets-data-validation/src/widgets/dropdown-widget.ts
@@ -14,7 +14,7 @@
* limitations under the License.
*/
-import { BooleanNumber, DataValidationRenderMode, DEFAULT_EMPTY_DOCUMENT_VALUE, DocumentDataModel, HorizontalAlign, ICommandService, Inject, LocaleService, Tools, VerticalAlign, WrapStrategy } from '@univerjs/core';
+import { BooleanNumber, DataValidationRenderMode, DataValidationType, DEFAULT_EMPTY_DOCUMENT_VALUE, DEFAULT_STYLES, DocumentDataModel, HorizontalAlign, ICommandService, Inject, LocaleService, Tools, VerticalAlign, WrapStrategy } from '@univerjs/core';
import type { ICellRenderContext, IDocumentData, IPaddingData, IStyleData, Nullable } from '@univerjs/core';
import { Documents, DocumentSkeleton, DocumentViewModel, getDocsSkeletonPageSize, Rect } from '@univerjs/engine-render';
import type { IMouseEvent, IPointerEvent, ISheetFontRenderExtension, SpreadsheetSkeleton, UniverRenderingContext, UniverRenderingContext2D } from '@univerjs/engine-render';
@@ -25,7 +25,7 @@ import { DROP_DOWN_DEFAULT_COLOR } from '../common/const';
import type { ListValidator } from '../validators';
const PADDING_H = 4;
-const ICON_SIZE = 6;
+const ICON_SIZE = 4;
const ICON_PLACE = 14;
const MARGIN_H = 6;
const MARGIN_V = 4;
@@ -110,18 +110,19 @@ function createDocuments(text: string, localeService: LocaleService, style?: Nul
};
}
-function calcPadding(cellWidth: number, cellHeight: number, fontWidth: number, fontHeight: number, vt: VerticalAlign, ht: HorizontalAlign) {
+function calcPadding(cellWidth: number, cellHeight: number, fontWidth: number, fontHeight: number, vt: VerticalAlign, ht: HorizontalAlign, margin = true) {
let paddingTop = 0;
+ const realMargin = margin ? MARGIN_V : 0;
switch (vt) {
case VerticalAlign.BOTTOM:
- paddingTop = (cellHeight - (MARGIN_V * 2) - fontHeight) + MARGIN_V;
+ paddingTop = (cellHeight - (realMargin * 2) - fontHeight) + realMargin;
break;
case VerticalAlign.MIDDLE:
- paddingTop = ((cellHeight - (MARGIN_V * 2) - fontHeight) / 2) + MARGIN_V;
+ paddingTop = ((cellHeight - (realMargin * 2) - fontHeight) / 2) + realMargin;
break;
default:
- paddingTop = MARGIN_V;
+ paddingTop = realMargin;
break;
}
@@ -152,12 +153,12 @@ export interface IDropdownInfo {
}
export class DropdownWidget implements IBaseDataValidationWidget {
- static padding: IPaddingData = {
- l: MARGIN_H + PADDING_H,
- r: ICON_PLACE + MARGIN_H,
- t: MARGIN_V,
- b: MARGIN_V,
- };
+ // static padding: IPaddingData = {
+ // l: MARGIN_H + PADDING_H,
+ // r: ICON_PLACE + MARGIN_H,
+ // t: MARGIN_V,
+ // b: MARGIN_V,
+ // };
private _dropdownInfoMap: Map<string, Map<string, IDropdownInfo>> = new Map();
@@ -186,18 +187,28 @@ export class DropdownWidget implements IBaseDataValidationWidget {
return `${row}.${col}`;
}
- private _drawDownIcon(ctx: UniverRenderingContext2D, cellBounding: { startX: number; startY: number }, cellWidth: number, cellHeight: number, vt: VerticalAlign) {
- const left = cellWidth - ICON_PLACE + 4;
- let top = 9;
+ private _drawDownIcon(
+ ctx: UniverRenderingContext2D,
+ cellBounding: { startX: number; startY: number },
+ cellWidth: number,
+ cellHeight: number,
+ fontHeight: number,
+ vt: VerticalAlign,
+ pd: IPaddingData
+ ) {
+ const { t = DEFAULT_STYLES.pd.t, b = DEFAULT_STYLES.pd.b } = pd;
+ const left = cellWidth - ICON_PLACE;
+ let top;
switch (vt) {
case VerticalAlign.MIDDLE:
- top = ((cellHeight - ICON_PLACE) / 2) + 4;
+ top = (cellHeight - ICON_SIZE) / 2;
break;
case VerticalAlign.BOTTOM:
- top = (cellHeight - ICON_PLACE) - 1;
+ top = cellHeight - (ICON_SIZE / 2) - b - (fontHeight / 2);
break;
default:
+ top = t + (fontHeight / 2) - (ICON_SIZE / 2);
break;
}
@@ -208,7 +219,7 @@ export class DropdownWidget implements IBaseDataValidationWidget {
ctx.restore();
}
- // eslint-disable-next-line max-lines-per-function
+ // eslint-disable-next-line max-lines-per-function, complexity
drawWith(ctx: UniverRenderingContext2D, info: ICellRenderContext, skeleton: SpreadsheetSkeleton): void {
const { primaryWithCoord, row, col, style, data, subUnitId } = info;
const _cellBounding = primaryWithCoord.isMergedMainCell ? primaryWithCoord.mergeInfo : primaryWithCoord;
@@ -218,7 +229,7 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const fontRenderExtension = data.fontRenderExtension as ISheetFontRenderExtension['fontRenderExtension'];
const { leftOffset = 0, rightOffset = 0, topOffset = 0, downOffset = 0 } = fontRenderExtension || {};
- if (!rule || !validator) {
+ if (!rule || !validator || !validator || validator.id.indexOf(DataValidationType.LIST) !== 0) {
return;
}
@@ -242,19 +253,15 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const value = getCellValueOrigin(data);
const valueStr = `${value ?? ''}`;
const activeItem = list.find((i) => i.label === valueStr);
- let { tb, vt, ht } = style || {};
+ let { tb, vt, ht, pd } = style || {};
tb = tb ?? WrapStrategy.WRAP;
vt = vt ?? VerticalAlign.BOTTOM;
- ht = ht ?? HorizontalAlign.LEFT;
- if (rule.renderMode === DataValidationRenderMode.ARROW) {
- this._drawDownIcon(ctx, cellBounding, cellWidth, cellHeight, vt);
- ctx.save();
- ctx.translateWithPrecision(cellBounding.startX, cellBounding.startY);
- ctx.beginPath();
- ctx.rect(0, 0, cellWidth, cellHeight);
- ctx.clip();
+ ht = ht ?? DEFAULT_STYLES.ht;
+ pd = pd ?? DEFAULT_STYLES.pd;
- const realWidth = cellWidth - ICON_PLACE;
+ if (rule.renderMode === DataValidationRenderMode.ARROW) {
+ const { l = DEFAULT_STYLES.pd.l, t = DEFAULT_STYLES.pd.t, r = DEFAULT_STYLES.pd.r, b = DEFAULT_STYLES.pd.b } = pd;
+ const realWidth = cellWidth - l - r - ICON_PLACE;
const { documentSkeleton, documents, docModel } = createDocuments(valueStr, this._localeService, style);
if (
@@ -268,9 +275,16 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const textLayout = getDocsSkeletonPageSize(documentSkeleton)!;
const { height: fontHeight, width: fontWidth } = textLayout;
- const { paddingTop, paddingLeft } = calcPadding(realWidth, cellHeight, fontWidth, fontHeight, vt, ht);
+ const { paddingTop, paddingLeft } = calcPadding(realWidth, cellHeight - t - b, fontWidth, fontHeight, vt, ht, false);
+
+ this._drawDownIcon(ctx, cellBounding, cellWidth, cellHeight, fontHeight, vt, pd);
+ ctx.save();
+ ctx.translateWithPrecision(cellBounding.startX + l, cellBounding.startY + t);
+ ctx.beginPath();
+ ctx.rect(0, 0, cellWidth - l - r, cellHeight - t - b);
+ ctx.clip();
- ctx.translate(0, paddingTop);
+ ctx.translateWithPrecision(0, paddingTop);
ctx.save();
ctx.translateWithPrecision(PADDING_H, 0);
ctx.beginPath();
@@ -283,10 +297,10 @@ export class DropdownWidget implements IBaseDataValidationWidget {
ctx.restore();
map.set(key, {
- left: cellBounding.endX + skeleton.rowHeaderWidth - ICON_PLACE,
- top: cellBounding.startY + skeleton.columnHeaderHeight,
+ left: cellBounding.endX + l + skeleton.rowHeaderWidth - ICON_PLACE,
+ top: cellBounding.startY + t + skeleton.columnHeaderHeight,
width: ICON_PLACE,
- height: cellHeight,
+ height: cellHeight - t - b,
});
} else {
ctx.save();
@@ -307,7 +321,7 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const { height: fontHeight, width: fontWidth } = textLayout;
const { paddingTop, paddingLeft } = calcPadding(realWidth, cellHeight, fontWidth, fontHeight, vt, ht);
- ctx.translate(MARGIN_H, paddingTop);
+ ctx.translateWithPrecision(MARGIN_H, paddingTop);
const rectWidth = Math.max(cellWidth - MARGIN_H * 2, 1);
const rectHeight = fontHeight;
Rect.drawWith(ctx as UniverRenderingContext, {
@@ -324,7 +338,7 @@ export class DropdownWidget implements IBaseDataValidationWidget {
ctx.translateWithPrecision(paddingLeft, 0);
documents.render(ctx as UniverRenderingContext);
ctx.restore();
- ctx.translate(realWidth + PADDING_H + 4, (fontHeight - ICON_SIZE) / 2);
+ ctx.translateWithPrecision(realWidth + PADDING_H + 4, (fontHeight - ICON_SIZE) / 2);
ctx.fillStyle = DROP_DOWN_ICON_COLOR;
ctx.fill(downPath);
ctx.restore();
@@ -367,8 +381,8 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const value = getCellValueOrigin(data);
const valueStr = `${value ?? ''}`;
- let { tb } = style || {};
-
+ let { tb, pd } = style || {};
+ const { t = DEFAULT_STYLES.pd.t, b = DEFAULT_STYLES.pd.b } = (pd ?? {});
tb = tb ?? WrapStrategy.WRAP;
if (rule.renderMode === DataValidationRenderMode.ARROW) {
@@ -386,7 +400,7 @@ export class DropdownWidget implements IBaseDataValidationWidget {
const { height: fontHeight } = textLayout;
- return fontHeight;
+ return fontHeight + t + b;
} else {
const realWidth = cellWidth - (MARGIN_H * 2) - PADDING_H - ICON_PLACE;
const { documentSkeleton, docModel } = createDocSkeleton(valueStr, this._localeService, style);
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 81ee937723..6d0236862f 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -1832,6 +1832,9 @@ importers:
'@univerjs/design':
specifier: workspace:*
version: link:../design
+ '@univerjs/docs':
+ specifier: workspace:*
+ version: link:../docs
'@univerjs/engine-formula':
specifier: workspace:*
version: link:../engine-formula