IAnalyticsCatalogFilterProps
Props for AnalyticsCatalogFilter().
export interface IAnalyticsCatalogFilterProps<T>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
ReactNode | (Optional) Optional custom action buttons replacing default Apply/Cancel. | ||
string | Test id applied to the root element for automation. | ||
(item: T) => string | (Optional) Derives unique key for option items. Defaults to string coercion. | ||
(item: T) => string | (Optional) Derives display title for option items. Defaults to string coercion. | ||
boolean | Whether the selection is inverted. | ||
string | Label shown on the trigger button and header. | ||
ReactNode | (Optional) Message rendered when there are no items to display. | ||
(selection: T[], isInverted: boolean) => void | Called when selection changes and user confirms. | ||
T[] | All selectable options. | ||
T[] | Currently selected options (empty means none when not inverted). | ||
ReactNode | (Optional) Optional status bar content rendered under the list. |
Property details
IAnalyticsCatalogFilterProps.actionsproperty
Optional custom action buttons replacing default Apply/Cancel.
actions?: ReactNode;
IAnalyticsCatalogFilterProps.dataTestIdproperty
Test id applied to the root element for automation.
dataTestId: string;
IAnalyticsCatalogFilterProps.getItemKeyproperty
Derives unique key for option items. Defaults to string coercion.
getItemKey?: (item: T) => string;
IAnalyticsCatalogFilterProps.getItemTitleproperty
Derives display title for option items. Defaults to string coercion.
getItemTitle?: (item: T) => string;
IAnalyticsCatalogFilterProps.isSelectionInvertedproperty
Whether the selection is inverted.
isSelectionInverted: boolean;
IAnalyticsCatalogFilterProps.labelproperty
Label shown on the trigger button and header.
label: string;
IAnalyticsCatalogFilterProps.noDataMessageproperty
Message rendered when there are no items to display.
noDataMessage?: ReactNode;
IAnalyticsCatalogFilterProps.onSelectionChangeproperty
Called when selection changes and user confirms.
onSelectionChange: (selection: T[], isInverted: boolean) => void;
IAnalyticsCatalogFilterProps.optionsproperty
All selectable options.
options: T[];
IAnalyticsCatalogFilterProps.selectionproperty
Currently selected options (empty means none when not inverted).
selection: T[];
IAnalyticsCatalogFilterProps.statusBarproperty
Optional status bar content rendered under the list.
statusBar?: ReactNode;