Home > widget-integration > CollectionFilterExtendedConfig

CollectionFilterExtendedConfig interface

Signature:

export interface CollectionFilterExtendedConfig 

Properties

Property

Modifiers

Type

Description

customization?

{ filter?: { customizedAPIParams?: Record<string, string>; beforeRender?: () => void; sticky?: { mobile?: { style1?: StickyOverride; default?: StickyOverride; }; vertical?: { "style-default"?: StickyOverride; "style-expand"?: { toolbar?: StickyOverride; panel?: StickyOverride; }; default?: StickyOverride; }; horizontal?: { "style-expand"?: { toolbar?: StickyOverride; panel?: StickyOverride; body?: StickyOverride; }; default?: StickyOverride; }; }; }; }

(Optional)

filterSettings

{ filterTreeIcon?: string; filterTreeIconClose?: string; filterTreeMobileStyle: "style1" | "style2" | "style2-fullwidth" | "style3" | "style3-fullwidth"; filterTreeMobileFullWidth: boolean; filterTreeMobileIcon?: string; filterTreeVerticalStyle: "style-default" | "style-off-canvas" | "style-expand"; filterTreeHorizontalStyle: "style1" | "style2" | "style3" | "style-expand"; filterHorizontalColumn: "1" | "2" | "3" | "full"; filterHorizontalOptionsAlign: "left" | "center" | "right"; filterLayout: "vertical" | "horizontal"; collapseOnPCByDefault?: boolean; collapseOnMobileByDefault?: boolean; keepScrollState?: boolean; keepToggleState?: boolean; keepTabOpenState?: boolean; stickyFilterOnDesktop?: boolean; stickyFilterOnMobile?: boolean; showFilterOptionCount?: boolean; showRefineBy?: boolean; showSingleOption?: boolean; showOutOfStockOption?: boolean; productAndVariantAvailable?: boolean; changeMobileButtonLabel?: boolean; requestInstantly?: boolean; urlScheme?: 0 | 1 | 2; isShortenUrlParam?: boolean; shortenUrlParamList?: Array<string>; productAvailable?: boolean; variantAvailable?: boolean; availableAfterFiltering?: boolean; showVariantImageBasedOnSelectedFilter?: string; startViewMore?: { list: number; box: number; swatch: number; }; startViewMoreH?: { list: number; box: number; swatch: number; }; showLoading?: boolean; showMobileLoading?: boolean; removePriceDecimal?: boolean; shortenPipsRange?: boolean; formatPipsRange?: Array<{ node: number; symbol: string; fix: number; suffix: boolean; }>; style?: { filterMobileButtonBackgroundColor: string; filterMobileButtonFontFamily: string; filterMobileButtonFontSize: number | string; filterMobileButtonFontTransform: string; filterMobileButtonFontWeight: number | string; filterMobileButtonTextColor: string; filterOptionFontFamily: string; filterOptionFontSize: number | string; filterOptionTextColor: string; filterTitleFontFamily: string; filterTitleFontSize: number | string; filterTitleFontTransform: "none" | "capitalize" | "uppercase" | "lowercase"; filterTitleFontWeight: number | string; filterTitleTextColor: string; }; activeScrollToTop?: boolean; styleScrollToTop?: "style1" | "style2"; swatch_extension?: string; swatchImageVersion?: string; swatch_settings?: Record<string, { colorCodes?: string[]; backgroundColor?: string; backgroundImage?: string; hasSwatchSetting?: boolean; imageUrl?: string; name: string; swatchBorder?: string; type: "one_color" | "image"; }>; filterEverywhereCollectionId?: number; limit?: number; showVariantsAsProduct?: boolean; priceMode?: string; tagMode?: string; sortingAvailableFirst?: boolean; vendorParam: "pf_v_vendor"; typeParam: "pf_pt_product_type"; filterPrefixParam: "pf_" | string; sortManualValues?: boolean; precisionFormatLabelSlider: number; precisionFormatLabelPriceList: number; filterAvoidStickyHeader: string[]; enableRenderFilterOptionItemWhenExpand: boolean; ignoreCharacterURL?: (url: string) => string; }

filterUrl

string