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

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

Start with the integration setup for your document type, including its required plugins, styles, and locale resources. The snippet below assumes that setup is complete.

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);

On the main thread, import UniverSheetsFilterPlugin from @univerjs/sheets-filter.

In the worker entry, import UniverSheetsFilterPlugin from @univerjs/sheets-filter/worker:

import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter/worker';

univer.registerPlugin(UniverSheetsFilterPlugin);

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

• Import @univerjs/sheets-filter/facade when using this package through Univer Facade APIs.

• Documentation
• NPM package
• GitHub repository