Skip to main content

​
Example

{% toggle
  id=""
%}
  ...
{% /toggle %}

​
Attributes

​
id
String
required
The id of the toggle to be used in a filters prop
​
label
String
Text displayed next to the toggle inside the box. Defaults to the id if not provided.
​
info
String
Information tooltip text that appears after the label
​
invert
Boolean
default:"false"
Invert the boolean value output. When true, checked = false and unchecked = true. Useful when toggle label semantics are opposite to the target attribute (e.g., “Show column” toggle controlling a “hide” attribute).
​
initial_value
Boolean
default:"false"
Initial state of the toggle

​
Available Filter Properties

When you reference a toggle filter in inline queries using the {{filter_id.property}} syntax, the following property is available:

​
.value

Returns the boolean value of the toggle (true/false)