API Reference

@univerjs/sheets-filter

Filtering model, commands, and services for Univer Sheets.

TypeScript
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter'univer.registerPlugin(UniverSheetsFilterPlugin, IUniverSheetsFilterConfig)

Entry Points

  • Facade: @univerjs/sheets-filter/facade
  • Locale: @univerjs/sheets-filter/locale/*

IUniverSheetsFilterConfig

TypeScript
export interface IUniverSheetsFilterConfig {  /**   * Whether to display the filter sync switch in the filter panel.   * This configuration can be used in a collaboration scenario to allow users to choose whether to enable filter synchronization.   * If set to a defaultValue object, the filter sync switch will be displayed and its initial state will be determined by the defaultValue property.   * @default false   */  enableSyncSwitch?: boolean | { defaultValue: boolean }}

How is this guide?

© 2026 DreamNum Co., Ltd.