Components ClearRefinements

Edit this page

ClearRefinements

A button that clears the query, the active refinements, or both when pressed.

🕹 try out live

Usage

<ais-clear-refinements
  :excluded-attributes="['categories']"
/>

Props

Name Type Default Description Required
excludedAttributes string[] ['query'] Attributes not to clear no
class-names Object {} Override class names no

Slots

Name Scope Description
default { canRefine: boolean, refine: () => void, createURL: () => void } Slot to override the DOM output
resetLabel - Slot to override the reset label

CSS classes

Here’s a list of CSS classes exposed by this widget. To better understand the underlying DOM structure, have a look at the generated DOM in your browser.

Note that you can pass the prop class-names, with an object of class names and their replacement to override this.

Class name Description
ais-ClearRefinements The root div of the widget
ais-ClearRefinements-button The clickable button
ais-ClearRefinements-button--disabled The disabled clickable button