# @univerjs/sheets-filter

- Human documentation: [https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-filter](https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-filter)

- Agent Markdown: [https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-filter.md](https://docs.univer.ai/reference/packages/plugins/univerjs/sheets-filter.md)

- Requested language: `en-US`

- Content language: `en-US`

- Documentation version: `1.0.0-rc.0`

- Source: [packages/plugins/univerjs/sheets-filter.mdx](https://github.com/dream-num/documentation/blob/dev/content/reference/packages/plugins/univerjs/sheets-filter.mdx)

---

Filtering model, commands, and services for Univer Sheets.

```typescript
// [!code word:UniverSheetsFilterPlugin]
// [!code word:IUniverSheetsFilterConfig]
import { UniverSheetsFilterPlugin } from '@univerjs/sheets-filter'

univer.registerPlugin(UniverSheetsFilterPlugin, IUniverSheetsFilterConfig)
```

## Entry Points

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

## IUniverSheetsFilterConfig

```ts
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 }
}
```