@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

3 months ago

0.6.5-nightly.202503121607

3 months ago

0.6.5

3 months ago

0.6.5-nightly.202503131607

3 months ago

0.6.6-nightly.202503151606

3 months ago

0.6.4-nightly.202503101606

3 months ago

0.6.4-nightly.202503111607

3 months ago

0.6.6-nightly.202503141606

3 months ago

0.6.3-nightly.202503041606

3 months ago

0.6.3

3 months ago

0.6.4

3 months ago

0.6.3-nightly.202503051607

3 months ago

0.6.2-nightly.202503031606

4 months ago

0.6.1-nightly.202502241606

4 months ago

0.6.1-nightly.202502231605

4 months ago

0.6.2

4 months ago

0.6.1-nightly.202502251606

4 months ago

0.6.0-nightly.202502191606

4 months ago

0.6.0-experimental.20250220-d9a8e74

4 months ago

0.6.0-nightly.202502181606

4 months ago

0.6.1

4 months ago

0.6.1-nightly.202502221605

4 months ago

0.6.0-nightly.202502171606

4 months ago

0.6.0-nightly.202502201606

4 months ago

0.6.1-nightly.202502211606

4 months ago

0.6.0-nightly.202502091605

4 months ago

0.6.0-nightly.202502151605

4 months ago

0.6.0-nightly.202502101606

4 months ago

0.6.0-nightly.202502141606

4 months ago

0.6.0-nightly.202502111606

4 months ago

0.6.0

4 months ago

0.6.0-nightly.202502131606

4 months ago

0.6.0-experimental.20250212-dbe9830

4 months ago

0.6.0-nightly.202502121606

4 months ago

0.6.0-nightly.202502161605

4 months ago

0.5.5-nightly.202501231606

5 months ago

0.5.5-experimental.20250124-fc44c59

5 months ago

0.6.0-nightly.202501261605

5 months ago

0.6.0-nightly.202501251605

5 months ago

0.6.0-alpha.0

5 months ago

0.6.0-nightly.202502041606

4 months ago

0.6.0-nightly.202501311606

5 months ago

0.6.0-experimental.20250125-1d060b9

5 months ago

0.5.5-nightly.202501241606

5 months ago

0.5.5-nightly.202501221606

5 months ago

0.6.0-nightly.202501291606

5 months ago

0.6.0-nightly.202502061605

4 months ago

0.6.0-nightly.202502031606

4 months ago

0.6.0-nightly.202501301606

5 months ago

0.6.0-nightly.202501281606

5 months ago

0.6.0-nightly.202502071606

4 months ago

0.6.0-nightly.202502021605

4 months ago

0.6.0-nightly.202502081605

4 months ago

0.5.5-experimental.20250125-1aa33c0

5 months ago

0.5.5-experimental.20250123-34738ff

5 months ago

0.6.0-nightly.202501271606

5 months ago

0.6.0-nightly.202502051606

4 months ago

0.6.0-nightly.202502011605

5 months ago

0.5.4-nightly.202501191605

5 months ago

0.5.4-nightly.202501200849

5 months ago

0.5.5-nightly.202501210925

5 months ago

0.5.5-nightly.202501201336

5 months ago

0.5.5-nightly.202501210849

5 months ago

0.5.5

5 months ago

0.5.5-nightly.202501210604

5 months ago

0.5.5-nightly.202501210734

5 months ago

0.5.5-nightly.202501220324

5 months ago

0.5.5-nightly.202501211606

5 months ago

0.5.5-nightly.202501210404

5 months ago

0.5.5-experimental.20250122-3362a4a

5 months ago

0.5.5-nightly.202501201606

5 months ago

0.5.5-nightly.202501210337

5 months ago

0.5.4-nightly.202501171120

5 months ago

0.5.4-nightly.202501141606

5 months ago

0.5.3-nightly.202501121605

5 months ago

0.5.4-nightly.202501170612

5 months ago

0.5.4

5 months ago

0.5.4-nightly.202501160704

5 months ago

0.5.4-nightly.202501160949

5 months ago

0.5.4-nightly.202501151339

5 months ago

0.5.4-nightly.202501171606

5 months ago

0.5.4-nightly.202501181312

5 months ago

0.5.4-nightly.202501131606

5 months ago

0.5.4-nightly.202501161606

5 months ago

0.5.4-nightly.202501160647

5 months ago

0.5.4-nightly.202501151252

5 months ago

0.5.4-nightly.202501150735

5 months ago

0.5.4-experimental.20250114-7c09c35

5 months ago

0.5.4-nightly.202501181605

5 months ago

0.5.4-nightly.202501151606

5 months ago

0.5.3-nightly.202501070959

5 months ago

0.5.3-nightly.202501100253

5 months ago

0.5.3-nightly.202501081606

5 months ago

0.5.3-nightly.202501061606

5 months ago

0.5.3-nightly.202501090742

5 months ago

0.5.3-nightly.202501101606

5 months ago

0.5.3-nightly.202501110940

5 months ago

0.5.3-experimental.20250106-4af1f4e

5 months ago

0.5.3-experimental.20250106-e3b7a39

5 months ago

0.5.3-nightly.202501071618

5 months ago

0.5.3-experimental.20250107-3e6579c

5 months ago

0.5.3-nightly.202501091606

5 months ago

0.5.3-nightly.202501060906

5 months ago

0.5.3-nightly.202501051605

5 months ago

0.5.3-nightly.202501111605

5 months ago

0.5.2-nightly.202501031606

5 months ago

0.5.2-nightly.202501021606

6 months ago

0.5.3-nightly.202501041605

5 months ago

0.5.2-nightly.202412311606

6 months ago

0.5.3

5 months ago

0.5.2-nightly.202412301606

6 months ago

0.5.2-nightly.202501011606

6 months ago

0.5.2-nightly.202412291605

6 months ago

0.5.2-nightly.202412281605

6 months ago

0.5.1-nightly.202412231606

6 months ago

0.5.1-nightly.202412261606

6 months ago

0.5.1-nightly.202412221605

6 months ago

0.5.1-nightly.202412241606

6 months ago

0.5.2

6 months ago

0.5.1-nightly.202412251606

6 months ago

0.5.1-nightly.202412271606

6 months ago

0.5.1-nightly.202412160721

6 months ago

0.5.1-nightly.202412211605

6 months ago

0.5.1-nightly.202412171606

6 months ago

0.5.1-nightly.202412151605

6 months ago

0.5.1-nightly.202412180740

6 months ago

0.5.1-nightly.202412190838

6 months ago

0.5.1-nightly.202412171234

6 months ago

0.5.1-nightly.202412180637

6 months ago

0.5.1-nightly.202412181606

6 months ago

0.5.1-nightly.202412201606

6 months ago

0.5.1-nightly.202412190703

6 months ago

0.5.1-nightly.202412161321

6 months ago

0.5.1-nightly.202412161606

6 months ago

0.5.1-nightly.202412171026

6 months ago

0.5.1-nightly.202412191606

6 months ago

0.5.1-nightly.202412180944

6 months ago

0.5.1-nightly.202412140448

6 months ago

0.5.1-nightly.202412120504

6 months ago

0.5.1-nightly.202412131606

6 months ago

0.5.1-nightly.202412110405

6 months ago

0.5.1-nightly.202412111606

6 months ago

0.5.1-nightly.202412121230

6 months ago

0.5.1-nightly.202412141605

6 months ago

0.5.1-nightly.202412120301

6 months ago

0.5.1-nightly.202412121606

6 months ago

0.5.1-nightly.202412111529

6 months ago

0.5.1-nightly.202412101606

6 months ago

0.5.1-nightly.202412090925

6 months ago

0.5.1-nightly.202412081606

6 months ago

0.5.1-nightly.202412090546

6 months ago

0.5.1-nightly.202412100649

6 months ago

0.5.1-nightly.202412091607

6 months ago

0.5.1-nightly.202412090639

6 months ago

0.5.1-nightly.202412061606

6 months ago

0.5.1-nightly.202412051606

6 months ago

0.5.1-nightly.202412071605

6 months ago

0.5.1-nightly.202412041606

6 months ago

0.5.1-nightly.202412031606

7 months ago

0.5.1-nightly.202412021606

7 months ago

0.5.0-nightly.202411271606

7 months ago

0.5.0-nightly.202411251606

7 months ago

0.5.0-nightly.202411291606

7 months ago

0.5.1-nightly.202412011605

7 months ago

0.5.1-nightly.202411301606

7 months ago

0.5.0-nightly.202411261607

7 months ago

0.5.1

7 months ago

0.5.0-nightly.202411281606

7 months ago

0.5.0-nightly.202411230545

7 months ago

0.5.0-nightly.202411221606

7 months ago

0.5.0-nightly.202411191606

7 months ago

0.5.0-nightly.202411201606

7 months ago

0.5.0-nightly.202411230627

7 months ago

0.5.0-nightly.202411241606

7 months ago

0.5.0

7 months ago

0.5.0-nightly.202411231605

7 months ago

0.5.0-nightly.202411211606

7 months ago

0.5.0-nightly.202411141606

7 months ago

0.5.0-nightly.202411131606

7 months ago

0.5.0-nightly.202411161605

7 months ago

0.5.0-nightly.202411151606

7 months ago

0.5.0-nightly.202411171605

7 months ago

0.5.0-nightly.202411181606

7 months ago

0.5.0-beta.1

7 months ago

0.5.0-beta.0

7 months ago

0.5.0-nightly.202411121606

7 months ago

0.5.0-nightly.202411091605

7 months ago

0.4.2-nightly.202411091134

7 months ago

0.4.2-nightly.202411051606

7 months ago

0.5.0-nightly.202411120616

7 months ago

0.4.2-nightly.202411041606

7 months ago

0.5.0-nightly.202411101605

7 months ago

0.4.2-nightly.202411071606

7 months ago

0.4.2-nightly.202411061606

7 months ago

0.5.0-alpha.0

7 months ago

0.4.2-nightly.202411081606

7 months ago

0.5.0-nightly.202411111606

7 months ago

0.4.2-nightly.202411021605

8 months ago

0.4.2-nightly.202411031606

8 months ago

0.4.2-nightly.202411011606

8 months ago

0.4.2-nightly.202410310419

8 months ago

0.4.1-nightly.202410291304

8 months ago

0.4.2-nightly.202410311606

8 months ago

0.4.1-nightly.202410291249

8 months ago

0.4.2-nightly.202410301606

8 months ago

0.4.1-nightly.202410281606

8 months ago

0.4.0-nightly.202410290723

8 months ago

0.4.1-nightly.202410271605

8 months ago

0.4.2-nightly.202410291606

8 months ago

0.4.1-nightly.202410261605

8 months ago

0.4.2

8 months ago

0.4.1-nightly.202410251606

8 months ago

0.4.1-nightly.202410241606

8 months ago

0.4.1-experimental.20241024-0ebc6ee

8 months ago

0.4.1-experimental.20241024-9717e6c

8 months ago

0.4.1-nightly.202410221606

8 months ago

0.4.1-experimental.20241023-bbb123f

8 months ago

0.4.1-experimental.20241022-507567a

8 months ago

0.4.0-experimental.20241017-da434a2

8 months ago

0.4.0-experimental.d7288c0-20241017

8 months ago

0.4.1-nightly.202410211606

8 months ago

0.4.1-nightly.202410201605

8 months ago

0.4.1-nightly.202410191605

8 months ago

0.4.0-nightly.202410171606

8 months ago

0.4.1

8 months ago

0.4.0

8 months ago

0.4.0-alpha.2

8 months ago

0.4.0-nightly.202410161605

8 months ago

0.4.0-nightly.202410151606

8 months ago

0.4.0-nightly.202410141110

8 months ago

0.4.0-nightly.202410141606

8 months ago

0.4.0-alpha.1

8 months ago

0.4.0-alpha.0

8 months ago

0.3.0-nightly.202410111606

8 months ago

0.4.0-nightly.202410131605

8 months ago

0.3.0-nightly.202410101606

8 months ago

0.4.0-nightly.202410121605

8 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

10 months ago

10 months ago

10 months ago

10 months ago

10 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

11 months ago

11 months ago

11 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