Nuxt Swiftsearch
Components

<AisToggleRefinement>

Binary refinement widget (on/off filter).

Usage

<AisInstantSearch :configuration="configuration">
  <AisToggleRefinement attribute="free_shipping" label="Free shipping" />
</AisInstantSearch>

Props

PropTypeDefaultDescription
attributestringrequiredAttribute used by the toggle refinement connector.
idstring""Optional widget ID for repeated instances (also scoped by indexId).
onstring | number | boolean | unknown[]trueValue applied when toggle is enabled.
offstring | number | boolean | unknown[]connector defaultValue applied when toggle is disabled.
labelstringconnector value nameOptional custom label text.
Copyright © 2026