Skip to content

Latest commit

 

History

History

sheets-filter-ui

README.md

@univerjs/sheets-filter-ui

npm version license downloads

@univerjs/sheets-filter-ui adds filter menus, panels, and interaction UI for Univer Sheets.

Package Overview

Package UMD global CSS Locales Facade entry Worker entry
@univerjs/sheets-filter-ui UniverSheetsFilterUi Yes Yes No Yes

Installation

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

Usage

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 '@univerjs/sheets-filter-ui/lib/index.css';
import EnUS from '@univerjs/sheets-filter-ui/locale/en-US';
import { UniverSheetsFilterUIPlugin } from '@univerjs/sheets-filter-ui';

univer.registerPlugin(UniverSheetsFilterUIPlugin);

// Merge EnUS into your Univer locale map when this package contributes UI text.

Main-thread plugin classes:

  • UniverSheetsFilterUIPlugin
  • UniverSheetsFilterMobileUIPlugin

Worker usage

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

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

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

univer.registerPlugin(UniverSheetsFilterUIWorkerPlugin);

Resources