Home > widget-integration > FilterProps

FilterProps type

Initial properties for filter widget initialization.

These properties are passed when creating a new filter widget instance, containing configuration, DOM context, and initial data.

Signature:

export type FilterProps = {
	id: string;
	blockType: string;
	cache: Record<string, object>;
	defaultParams: Record<string, any>;
	document: HTMLElement | Document;
	dynamicBundles: Array<unknown>;
	filter: FilterOptionsProps;
	widgetId: string;
	defaultSort: string;
	viewPort: FilterFacets;
	templateSettings: WidgetInfo;
};

References: FilterOptionsProps, FilterFacets, WidgetInfo

Remarks

This type extends into FilterStates which adds runtime state management properties. Technical Support teams typically don't modify these directly but may need to reference them when extending filter initialization logic.