Toggle

{% toggle
    id="show_legend"
    label="Show Legend"
/%}

Examples

Basic Usage

{% toggle
    id="show_legend"
    label="Show Legend"
/%}

Using `where`

{% toggle
    id="active_only"
    label="Active Only"
/%}

{% table
    data="demo.daily_orders"
    where="{{active_only}} = false or total_sales > 1000"
/%}

Using Inline SQL

{% toggle
    id="active_only"
    label="Active Only"
/%}

```sql filtered_orders
select * from demo.daily_orders
where {{active_only}} = false or total_sales > 1000
```

{% table data="filtered_orders" /%}

Attributes

string

required

The id of the toggle to be used in a filters prop

string

Text displayed next to the toggle inside the box. Defaults to the id if not provided.

string

Information tooltip text that appears after the label

boolean

default:"false"

Invert the boolean value output. When true, checked = false and unchecked = true. Useful when toggle label semantics are opposite to the filter logic (e.g., a “Show inactive” toggle that filters for is_active = false when checked).

boolean

default:"false"

Initial state of the toggle

Using the Filter Variable

Reference this filter using {{filter_id}}. The value returned depends on where you use it.

Context	Default Property	Result
Inline SQL query	`.value`	`true`
`where` attribute	`.value`	`true`
Text / Markdown	`.value`	`true`

Available Properties

You can also access specific properties using {{filter_id.property}}:

.value

Returns the boolean value of the toggle.

{% toggle id="active_filter" /%}

```sql active_users
select * from users
where is_active = {{active_filter}}
```

Example value: true

Get Started

Core Concepts

Features

MCP

CLI

Self Host

Direct Connectors

Evidence Warehouse

Components

Guides

Examples

Basic Usage

Using `where`

Using Inline SQL

Attributes

Using the Filter Variable

Available Properties

.value

Examples

Basic Usage

Using where

Using Inline SQL

Attributes

Using the Filter Variable

Available Properties

.value

Using `where`