univer/packages/sheets-filter/README.md

@univerjs/sheets-filter

@univerjs/sheets-filter adds the core filtering model, commands, and services for Univer Sheets.

Package Overview

Package	UMD global	CSS	Locales	Facade entry
@univerjs/sheets-filter	UniverSheetsFilter	No	Yes	Yes

Installation

pnpm add @univerjs/sheets-filter
# or
npm install @univerjs/sheets-filter

Keep all @univerjs/* packages on the same version.

Usage

import { LocaleType, mergeLocales, Univer } from '@univerjs/core';
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter';
import EnUS from '@univerjs/sheets-filter/locale/en-US';

const univer = new Univer({
    locale: LocaleType.EN_US,
    locales: {
        [LocaleType.EN_US]: mergeLocales(EnUS),
    },
});

univer.registerPlugin(UniverSheetsFilterPlugin);

Integration Notes

Use this package with @univerjs/sheets-filter-ui when users need filter menus and panels.

Resources

• Documentation
• NPM package
• GitHub repository