@univerjs/sheets-data-validation NPM

@univerjs/sheets-data-validation

Package Overview

Package Name	UMD Namespace	Version	License	Downloads	Contains CSS	Contains i18n locales
`@univerjs/sheets-data-validation`	`UniverSheetsDataValidation`				️❌	❌️

Introduction

@univerjs/sheets-data-validation provides full capabilities for Univer Sheet data validation.

Usage

Installation

# Using npm
npm i @univerjs/sheets-data-validation

# Using pnpm
pnpm add

Register the plugin

import type { IWorkbookData } from '@univerjs/core';
import { DataValidationType, ICommandService, LocaleType, Univer, UniverInstanceType } from '@univerjs/core';
import { UniverDataValidationPlugin } from '@univerjs/data-validation';
import {
    DATA_VALIDATION_PLUGIN_NAME,
    UniverSheetsDataValidationPlugin,
} from '@univerjs/sheets-data-validation';

univer.registerPlugin(UniverDataValidationPlugin);
univer.registerPlugin(UniverSheetsDataValidationPlugin);

// initial data validation
// dentation: https://github.com/dream-num/univer/blob/dev/packages/core/src/types/interfaces/i-data-validation.ts#L48
const dataValidation = [
    {
        uid: 'xxx-2',
        type: DataValidationType.CHECKBOX,
        ranges: [{
            startRow: 6,
            endRow: 10,
            startColumn: 0,
            endColumn: 5,
        }],
    },
];

export const DEFAULT_WORKBOOK_DATA_DEMO: IWorkbookData = {
    id: 'workbook-01',
    locale: LocaleType.ZH_CN,
    name: 'UniverSheet Demo',
    resources: [{
        name: DATA_VALIDATION_PLUGIN_NAME,
        data: JSON.stringify({
            'sheetId-1': dataValidation,
        }),
    }],
    // ...
};

// load initial snapshot
univer.createUnit(UniverInstanceType.UNIVER_SHEET, DEFAULT_WORKBOOK_DATA_DEMO);

API

// Commands and Command params for sheet-data-validation management
import type {
    IAddSheetDataValidationCommandParams,
    IRemoveSheetDataValidationCommandParams,
    IUpdateSheetDataValidationOptionsCommandParams,
    IUpdateSheetDataValidationRangeCommandParams,
    IUpdateSheetDataValidationSettingCommandParams,
} from '@univerjs/sheets-data-validation';
import {
    AddSheetDataValidationCommand,
    DATA_VALIDATION_PLUGIN_NAME,
    RemoveSheetDataValidationCommand,
    UniverSheetsDataValidationPlugin,
    UpdateSheetDataValidationOptionsCommand,
    UpdateSheetDataValidationRangeCommand,
    UpdateSheetDataValidationSettingCommand,
    // internal service
    SheetsDataValidationValidatorService
} from '@univerjs/sheets-data-validation';

// eg. Add data validation from command
const commandService = univer.__getInjector().get(ICommandService);

commandService.executeCommand(AddSheetDataValidationCommand.id, {
    unitId: 'unitId',
    subUnitId: 'subUnitId',
    rule: {
        uid: 'xxx-2',
        type: DataValidationType.CHECKBOX,
        ranges: [{
            startRow: 6,
            endRow: 10,
            startColumn: 0,
            endColumn: 5,
        }],
    },
} as IAddSheetDataValidationCommandParams);

// Using internal service Such as validator
const sheetsDataValidationValidatorService = univer.__getInjector().get(SheetsDataValidationValidatorService);
sheetsDataValidationValidatorService.validatorWorksheet('unitId', 'sheetId')

univer

@univerjs/protocol @univerjs/core @univerjs/sheets @univerjs/sheets-formula @univerjs/engine-formula @univerjs/data-validation

jnpf-univer @univerjs-pro/edit-history-loader @univerjs/sheets-data-validation-ui @univerjs/sheets-hyper-link-ui @univerjs/preset-sheets-data-validation @univerjs/umd @univerjs/preset-sheets-node-core @univerjs/facade ct-sheet

0.6.6

6 months ago

0.6.5-nightly.202503121607

6 months ago

0.6.5

6 months ago

0.6.5-nightly.202503131607

6 months ago

0.6.6-nightly.202503151606

6 months ago

0.6.4-nightly.202503101606

6 months ago

0.6.4-nightly.202503111607

6 months ago

0.6.6-nightly.202503141606

6 months ago

0.6.3-nightly.202503041606

6 months ago

0.6.3

6 months ago

0.6.4

6 months ago

0.6.3-nightly.202503051607

6 months ago

0.6.2-nightly.202503031606

6 months ago

0.6.1-nightly.202502241606

6 months ago

0.6.1-nightly.202502231605

7 months ago

0.6.2

6 months ago

0.6.1-nightly.202502251606

6 months ago

0.6.0-nightly.202502191606

7 months ago

0.6.0-experimental.20250220-d9a8e74

7 months ago

0.6.0-nightly.202502181606

7 months ago

0.6.1

7 months ago

0.6.1-nightly.202502221605

7 months ago

0.6.0-nightly.202502171606

7 months ago

0.6.0-nightly.202502201606

7 months ago

0.6.1-nightly.202502211606

7 months ago

0.6.0-nightly.202502091605

7 months ago

0.6.0-nightly.202502151605

7 months ago

0.6.0-nightly.202502101606

7 months ago

0.6.0-nightly.202502141606

7 months ago

0.6.0-nightly.202502111606

7 months ago

0.6.0

7 months ago

0.6.0-nightly.202502131606

7 months ago

0.6.0-experimental.20250212-dbe9830

7 months ago

0.6.0-nightly.202502121606

7 months ago

0.6.0-nightly.202502161605

7 months ago

0.5.5-nightly.202501231606

8 months ago

0.5.5-experimental.20250124-fc44c59

8 months ago

0.6.0-nightly.202501261605

7 months ago

0.6.0-nightly.202501251605

7 months ago

0.6.0-alpha.0

8 months ago

0.6.0-nightly.202502041606

7 months ago

0.6.0-nightly.202501311606

7 months ago

0.6.0-experimental.20250125-1d060b9

8 months ago

0.5.5-nightly.202501241606

8 months ago

0.5.5-nightly.202501221606

8 months ago

0.6.0-nightly.202501291606

7 months ago

0.6.0-nightly.202502061605

7 months ago

0.6.0-nightly.202502031606

7 months ago

0.6.0-nightly.202501301606

7 months ago

0.6.0-nightly.202501281606

7 months ago

0.6.0-nightly.202502071606

7 months ago

0.6.0-nightly.202502021605

7 months ago

0.6.0-nightly.202502081605

7 months ago

0.5.5-experimental.20250125-1aa33c0

8 months ago

0.5.5-experimental.20250123-34738ff

8 months ago

0.6.0-nightly.202501271606

7 months ago

0.6.0-nightly.202502051606

7 months ago

0.6.0-nightly.202502011605

7 months ago

0.5.4-nightly.202501191605

8 months ago

0.5.4-nightly.202501200849

8 months ago

0.5.5-nightly.202501210925

8 months ago

0.5.5-nightly.202501201336

8 months ago

0.5.5-nightly.202501210849

8 months ago

0.5.5

8 months ago

0.5.5-nightly.202501210604

8 months ago

0.5.5-nightly.202501210734

8 months ago

0.5.5-nightly.202501220324

8 months ago

0.5.5-nightly.202501211606

8 months ago

0.5.5-nightly.202501210404

8 months ago

0.5.5-experimental.20250122-3362a4a

8 months ago

0.5.5-nightly.202501201606

8 months ago

0.5.5-nightly.202501210337

8 months ago

0.5.4-nightly.202501171120

8 months ago

0.5.4-nightly.202501141606

8 months ago

0.5.3-nightly.202501121605

8 months ago

0.5.4-nightly.202501170612

8 months ago

0.5.4

8 months ago

0.5.4-nightly.202501160704

8 months ago

0.5.4-nightly.202501160949

8 months ago

0.5.4-nightly.202501151339

8 months ago

0.5.4-nightly.202501171606

8 months ago

0.5.4-nightly.202501181312

8 months ago

0.5.4-nightly.202501131606

8 months ago

0.5.4-nightly.202501161606

8 months ago

0.5.4-nightly.202501160647

8 months ago

0.5.4-nightly.202501151252

8 months ago

0.5.4-nightly.202501150735

8 months ago

0.5.4-experimental.20250114-7c09c35

8 months ago

0.5.4-nightly.202501181605

8 months ago

0.5.4-nightly.202501151606

8 months ago

0.5.3-nightly.202501070959

8 months ago

0.5.3-nightly.202501100253

8 months ago

0.5.3-nightly.202501081606

8 months ago

0.5.3-nightly.202501061606

8 months ago

0.5.3-nightly.202501090742

8 months ago

0.5.3-nightly.202501101606

8 months ago

0.5.3-nightly.202501110940

8 months ago

0.5.3-experimental.20250106-4af1f4e

8 months ago

0.5.3-experimental.20250106-e3b7a39

8 months ago

0.5.3-nightly.202501071618

8 months ago

0.5.3-experimental.20250107-3e6579c

8 months ago

0.5.3-nightly.202501091606

8 months ago

0.5.3-nightly.202501060906

8 months ago

0.5.3-nightly.202501051605

8 months ago

0.5.3-nightly.202501111605

8 months ago

0.5.2-nightly.202501031606

8 months ago

0.5.2-nightly.202501021606

8 months ago

0.5.3-nightly.202501041605

8 months ago

0.5.2-nightly.202412311606

8 months ago

0.5.3

8 months ago

0.5.2-nightly.202412301606

8 months ago

0.5.2-nightly.202501011606

8 months ago

0.5.2-nightly.202412291605

8 months ago

0.5.2-nightly.202412281605

8 months ago

0.5.1-nightly.202412231606

9 months ago

0.5.1-nightly.202412261606

8 months ago

0.5.1-nightly.202412221605

9 months ago

0.5.1-nightly.202412241606

9 months ago

0.5.2

8 months ago

0.5.1-nightly.202412251606

9 months ago

0.5.1-nightly.202412271606

8 months ago

0.5.1-nightly.202412160721

9 months ago

0.5.1-nightly.202412211605

9 months ago

0.5.1-nightly.202412171606

9 months ago

0.5.1-nightly.202412151605

9 months ago

0.5.1-nightly.202412180740

9 months ago

0.5.1-nightly.202412190838

9 months ago

0.5.1-nightly.202412171234

9 months ago

0.5.1-nightly.202412180637

9 months ago

0.5.1-nightly.202412181606

9 months ago

0.5.1-nightly.202412201606

9 months ago

0.5.1-nightly.202412190703

9 months ago

0.5.1-nightly.202412161321

9 months ago

0.5.1-nightly.202412161606

9 months ago

0.5.1-nightly.202412171026

9 months ago

0.5.1-nightly.202412191606

9 months ago

0.5.1-nightly.202412180944

9 months ago

0.5.1-nightly.202412140448

9 months ago

0.5.1-nightly.202412120504

9 months ago

0.5.1-nightly.202412131606

9 months ago

0.5.1-nightly.202412110405

9 months ago

0.5.1-nightly.202412111606

9 months ago

0.5.1-nightly.202412121230

9 months ago

0.5.1-nightly.202412141605

9 months ago

0.5.1-nightly.202412120301

9 months ago

0.5.1-nightly.202412121606

9 months ago

0.5.1-nightly.202412111529

9 months ago

0.5.1-nightly.202412101606

9 months ago

0.5.1-nightly.202412090925

9 months ago

0.5.1-nightly.202412081606

9 months ago

0.5.1-nightly.202412090546

9 months ago

0.5.1-nightly.202412100649

9 months ago

0.5.1-nightly.202412091607

9 months ago

0.5.1-nightly.202412090639

9 months ago

0.5.1-nightly.202412061606

9 months ago

0.5.1-nightly.202412051606

9 months ago

0.5.1-nightly.202412071605

9 months ago

0.5.1-nightly.202412041606

9 months ago

0.5.1-nightly.202412031606

9 months ago

0.5.1-nightly.202412021606

9 months ago

0.5.0-nightly.202411271606

9 months ago

0.5.0-nightly.202411251606

10 months ago

0.5.0-nightly.202411291606

9 months ago

0.5.1-nightly.202412011605

9 months ago

0.5.1-nightly.202411301606

9 months ago

0.5.0-nightly.202411261607

9 months ago

0.5.1

9 months ago

0.5.0-nightly.202411281606

9 months ago

0.5.0-nightly.202411230545

10 months ago

0.5.0-nightly.202411221606

10 months ago

0.5.0-nightly.202411191606

10 months ago

0.5.0-nightly.202411201606

10 months ago

0.5.0-nightly.202411230627

10 months ago

0.5.0-nightly.202411241606

10 months ago

0.5.0

10 months ago

0.5.0-nightly.202411231605

10 months ago

0.5.0-nightly.202411211606

10 months ago

0.5.0-nightly.202411141606

10 months ago

0.5.0-nightly.202411131606

10 months ago

0.5.0-nightly.202411161605

10 months ago

0.5.0-nightly.202411151606

10 months ago

0.5.0-nightly.202411171605

10 months ago

0.5.0-nightly.202411181606

10 months ago

0.5.0-beta.1

10 months ago

0.5.0-beta.0

10 months ago

0.5.0-nightly.202411121606

10 months ago

0.5.0-nightly.202411091605

10 months ago

0.4.2-nightly.202411091134

10 months ago

0.4.2-nightly.202411051606

10 months ago

0.5.0-nightly.202411120616

10 months ago

0.4.2-nightly.202411041606

10 months ago

0.5.0-nightly.202411101605

10 months ago

0.4.2-nightly.202411071606

10 months ago

0.4.2-nightly.202411061606

10 months ago

0.5.0-alpha.0

10 months ago

0.4.2-nightly.202411081606

10 months ago

0.5.0-nightly.202411111606

10 months ago

0.4.2-nightly.202411021605

10 months ago

0.4.2-nightly.202411031606

10 months ago

0.4.2-nightly.202411011606

10 months ago

0.4.2-nightly.202410310419

10 months ago

0.4.1-nightly.202410291304

10 months ago

0.4.2-nightly.202410311606

10 months ago

0.4.1-nightly.202410291249

10 months ago

0.4.2-nightly.202410301606

10 months ago

0.4.1-nightly.202410281606

10 months ago

0.4.0-nightly.202410290723

10 months ago

0.4.1-nightly.202410271605

10 months ago

0.4.2-nightly.202410291606

10 months ago

0.4.1-nightly.202410261605

11 months ago

0.4.2

10 months ago

0.4.1-nightly.202410251606

11 months ago

0.4.1-nightly.202410241606

11 months ago

0.4.1-experimental.20241024-0ebc6ee

11 months ago

0.4.1-experimental.20241024-9717e6c

11 months ago

0.4.1-nightly.202410221606

11 months ago

0.4.1-experimental.20241023-bbb123f

11 months ago

0.4.1-experimental.20241022-507567a

11 months ago

0.4.0-experimental.20241017-da434a2

11 months ago

0.4.0-experimental.d7288c0-20241017

11 months ago

0.4.1-nightly.202410211606

11 months ago

0.4.1-nightly.202410201605

11 months ago

0.4.1-nightly.202410191605

11 months ago

0.4.0-nightly.202410171606

11 months ago

0.4.1

11 months ago

0.4.0

11 months ago

0.4.0-alpha.2

11 months ago

0.4.0-nightly.202410161605

11 months ago

0.4.0-nightly.202410151606

11 months ago

0.4.0-nightly.202410141110

11 months ago

0.4.0-nightly.202410141606

11 months ago

0.4.0-alpha.1

11 months ago

0.4.0-alpha.0

11 months ago

0.3.0-nightly.202410111606

11 months ago

0.4.0-nightly.202410131605

11 months ago

0.3.0-nightly.202410101606

11 months ago

0.4.0-nightly.202410121605

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago