Skip to main content

Filters

Settings​

SettingIDTypeDefaultDescription
Show sort orderfilters_show_sortcheckboxtrue
Enable stickyfilters_stickycheckboxfalse
Collapse filter columncollapsed_columnrange5Groups holding more values than this start collapsed.
Show filter countsfilters_countercheckboxfalseOnly the plain checkbox lists show counts; options rendered as buttons or swatches never do.
Show filter values in two columnsfilters_twocolscheckboxfalse
On selecting a filter, automatically apply 'Out of stock'filters_autohide_unavailablecheckboxfalseRequires the Availability filter to be enabled.
Custom stylelabel_custom_stylecheckboxfalse
Size (mobile)label_size_mobselecttext-xs
Size (desktop)label_sizeselecttext-xs
Label colorlabel_colorselectbase-text
Custom colorlabel_color_customcolor_background
Label text uppercaselabel_uppercheckboxtrue
Filters to show as buttonsfilters_buttonstextSize
Custom stylefiltersbtn_custom_stylecheckboxfalse
Backgroundfiltersbtn_bgcolor#ffffff
Text colorfiltersbtn_textselectbase-text
Custom colorfiltersbtn_text_customcolor_background
Border colorfiltersbtn_bordercolor#d1d5db
Border color (hover)filtersbtn_border_hovercolor#111827
Background (active)filtersbtn_bg_activecolor#111827
Text color (active)filtersbtn_text_activeselectbase-text
Custom colorfiltersbtn_text_active_customcolor_background
Radiusfiltersbtn_radiusselectrounded-md
Enable swatches iconfilters_swatchescheckboxtrue
Swatches layoutfilters_swatches_layoutselect2No label shows the color chips only, with no button frame around them.
Show swatch borderfilters_swatches_bordercheckboxtrueAdds a 1px border in each swatch's own color with a white ring between the border and the color ball. Turn off for a flat color chip.
Swatch shapefilters_swatches_shapeselectrounded-circle
Classfilters_classtextlg:me-4
Backgroundfilters_bgcolor_background
Borderfilters_borderrange0
Border colorfilters_border_colorcolor
Radiusfilters_radiusselectrounded-md
Shadowfilters_shadowselectshadow-none
Classfiltersgroup_classtextp-3
Backgroundfiltersgroup_bgcolor_background
Borderfiltersgroup_borderrange0
Border colorfiltersgroup_border_colorcolor
Radiusfiltersgroup_radiusselectrounded-md
Shadowfiltersgroup_shadowselectshadow-none

Option values​

  • Size (mobile) (label_size_mob): 3 Extra Small (text-3xs), 2 Extra Small (text-2xs), Extra Small (text-xs), Small (text-sm), Medium (text-base), Large (text-lg), Extra Large (text-xl), 2X Large (text-2xl), 3X Large (text-3xl), 4X Large (text-4xl), 5X Large (text-5xl), 6X Large (text-6xl), 7X Large (text-7xl), 8X Large (text-8xl), 9X Large (text-9xl)
  • Size (desktop) (label_size): 3 Extra Small (text-3xs), 2 Extra Small (text-2xs), Extra Small (text-xs), Small (text-sm), Medium (text-base), Large (text-lg), Extra Large (text-xl), 2X Large (text-2xl), 3X Large (text-3xl), 4X Large (text-4xl), 5X Large (text-5xl), 6X Large (text-6xl), 7X Large (text-7xl), 8X Large (text-8xl), 9X Large (text-9xl)
  • Label color (label_color): Primary (primary), Secondary (secondary), Success (success), Warning (warning), Danger (danger), Base text (base-text), Heading text (heading-text), Black (black), White (white), Gray 100 (gray-100), Gray 200 (gray-200), Gray 300 (gray-300), Gray 400 (gray-400), Gray 500 (gray-500), Gray 600 (gray-600), Gray 700 (gray-700), Gray 800 (gray-800), Gray 900 (gray-900), Random (random), Custom (custom)
  • Text color (filtersbtn_text): Primary (primary), Secondary (secondary), Success (success), Warning (warning), Danger (danger), Base text (base-text), Heading text (heading-text), Black (black), White (white), Gray 100 (gray-100), Gray 200 (gray-200), Gray 300 (gray-300), Gray 400 (gray-400), Gray 500 (gray-500), Gray 600 (gray-600), Gray 700 (gray-700), Gray 800 (gray-800), Gray 900 (gray-900), Random (random), Custom (custom)
  • Text color (active) (filtersbtn_text_active): Primary (primary), Secondary (secondary), Success (success), Warning (warning), Danger (danger), Base text (base-text), Heading text (heading-text), Black (black), White (white), Gray 100 (gray-100), Gray 200 (gray-200), Gray 300 (gray-300), Gray 400 (gray-400), Gray 500 (gray-500), Gray 600 (gray-600), Gray 700 (gray-700), Gray 800 (gray-800), Gray 900 (gray-900), Random (random), Custom (custom)
  • Radius (filtersbtn_radius): Square (rounded-none), Rounded small (rounded-md), Rounded medium (rounded-xl), Rounded large (rounded-2xl), Rounded extra large (rounded-3xl), Squircle (rounded-squircle), Circle (rounded-circle), Pill (rounded-full), Rounded top (rounded-top), Rounded bottom (rounded-bottom), Single corner (rounded-corner), Diagonal corners (rounded-diagonal), Arch (rounded-arch), Dome (rounded-dome), Cylinder (rounded-cylinder), Barrel (rounded-barrel), Leaf pointed (rounded-leaf-point), Leaf (rounded-leaf), Lens (rounded-lens), Petal (rounded-petal), Egg (rounded-egg), Egg inverted (rounded-egg-inverted), Shield (rounded-shield), Drop (rounded-drop), Diamond (rounded-diamond), Blob (rounded-blob), Amoeba (rounded-amoeba), Flower (rounded-flower), Mountain (rounded-mountain), Pebble (rounded-pebble), Bean (rounded-bean), Cloud (rounded-cloud)
  • Swatches layout (filters_swatches_layout): One column (1), Two column (2), Buttons (3), No label (0)
  • Swatch shape (filters_swatches_shape): Square (rounded-none), Rounded small (rounded-md), Rounded medium (rounded-xl), Rounded large (rounded-2xl), Rounded extra large (rounded-3xl), Squircle (rounded-squircle), Circle (rounded-circle), Pill (rounded-full), Rounded top (rounded-top), Rounded bottom (rounded-bottom), Single corner (rounded-corner), Diagonal corners (rounded-diagonal), Arch (rounded-arch), Dome (rounded-dome), Cylinder (rounded-cylinder), Barrel (rounded-barrel), Leaf pointed (rounded-leaf-point), Leaf (rounded-leaf), Lens (rounded-lens), Petal (rounded-petal), Egg (rounded-egg), Egg inverted (rounded-egg-inverted), Shield (rounded-shield), Drop (rounded-drop), Diamond (rounded-diamond), Blob (rounded-blob), Amoeba (rounded-amoeba), Flower (rounded-flower), Mountain (rounded-mountain), Pebble (rounded-pebble), Bean (rounded-bean), Cloud (rounded-cloud)
  • Radius (filters_radius): Square (rounded-none), Rounded small (rounded-md), Rounded medium (rounded-xl), Rounded large (rounded-2xl), Rounded extra large (rounded-3xl), Squircle (rounded-squircle), Circle (rounded-circle), Pill (rounded-full), Rounded top (rounded-top), Rounded bottom (rounded-bottom), Single corner (rounded-corner), Diagonal corners (rounded-diagonal), Arch (rounded-arch), Dome (rounded-dome), Cylinder (rounded-cylinder), Barrel (rounded-barrel), Leaf pointed (rounded-leaf-point), Leaf (rounded-leaf), Lens (rounded-lens), Petal (rounded-petal), Egg (rounded-egg), Egg inverted (rounded-egg-inverted), Shield (rounded-shield), Drop (rounded-drop), Diamond (rounded-diamond), Blob (rounded-blob), Amoeba (rounded-amoeba), Flower (rounded-flower), Mountain (rounded-mountain), Pebble (rounded-pebble), Bean (rounded-bean), Cloud (rounded-cloud)
  • Shadow (filters_shadow): None (shadow-none), Small (shadow-sm), Default (shadow), Medium (shadow-md), Large (shadow-lg)
  • Radius (filtersgroup_radius): Square (rounded-none), Rounded small (rounded-md), Rounded medium (rounded-xl), Rounded large (rounded-2xl), Rounded extra large (rounded-3xl), Squircle (rounded-squircle), Circle (rounded-circle), Pill (rounded-full), Rounded top (rounded-top), Rounded bottom (rounded-bottom), Single corner (rounded-corner), Diagonal corners (rounded-diagonal), Arch (rounded-arch), Dome (rounded-dome), Cylinder (rounded-cylinder), Barrel (rounded-barrel), Leaf pointed (rounded-leaf-point), Leaf (rounded-leaf), Lens (rounded-lens), Petal (rounded-petal), Egg (rounded-egg), Egg inverted (rounded-egg-inverted), Shield (rounded-shield), Drop (rounded-drop), Diamond (rounded-diamond), Blob (rounded-blob), Amoeba (rounded-amoeba), Flower (rounded-flower), Mountain (rounded-mountain), Pebble (rounded-pebble), Bean (rounded-bean), Cloud (rounded-cloud)
  • Shadow (filtersgroup_shadow): None (shadow-none), Small (shadow-sm), Default (shadow), Medium (shadow-md), Large (shadow-lg)