API

@univerjs/sheets-conditional-formatting-ui

この API ページの本文は現在英語です。コードのシグネチャと識別子は表示言語によって変わりません。

Conditional formatting UI for Univer Sheets.

TypeScript
import { UniverSheetsConditionalFormattingUIPlugin } from '@univerjs/sheets-conditional-formatting-ui'univer.registerPlugin(UniverSheetsConditionalFormattingUIPlugin, {})

Entry Points

  • Locale: @univerjs/sheets-conditional-formatting-ui/locale/*

Rule UI

The root entry exports helpers for custom rule lists and panels:

ExportUsage
getRuleDescribe(rule, localeService)Returns the localized description of a full IConditionFormattingRule.
ConditionalFormattingRulePreviewRenders the configured appearance. Pass rule.rule, not the full rule; it does not evaluate worksheet values.
IConditionalFormattingRulePreviewPropsProps for the preview, with an optional rule: IConditionalFormattingRuleConfig.
CF_PANEL_KEYKey for overriding or opening the registered conditional-formatting panel.
IConditionFormattingPanelPropsPanel props, including rule, RuleEditComponent, RuleListComponent, and onEditorExit.

onEditorExit runs when editing ends after submission, cancellation, or worksheet activation/removal. It is not a save-success or sidebar-close notification. The panel itself is registered under CF_PANEL_KEY; it is not exported as a React component from the package root.

See rule descriptions and previews for an example and component overrides for registration rules.

IUniverSheetsConditionalFormattingUIConfig

TypeScript
import type { MenuConfig } from '@univerjs/ui'export interface IUniverSheetsConditionalFormattingUIConfig {  menu?: MenuConfig}

このガイドはいかがですか?

© 2026 DreamNum Co., Ltd.