The Filter web component

An interface to define filters for Table components.

Filter connects to a Table component to dynamically filter its displayed data.

Demo

Settings

Filter includes the following configurable options when building apps in the IDE.

Event handlersHiddenShow on desktopShow on mobileLink to tableMaintain space when hiddenMarginAlways show in edit modeStylesHelper textValue

Properties

All properties for Filter with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.

events

object[]

A list of configured event handlers that trigger actions or queries.

Properties

event

enum

The event type.

Values

change	A user changes the value.
click	A user clicks or taps the component.
submit	A user submits the value.
focus	A user selects the input field.
blur	A user deselects the input field.
scan	A user scans a barcode.
open	A user opens the component.
close	A user closes the component.
true	A user sets the value to true.
false	A user sets the value to false.
select	A user selects a value.
clear	A user clears the value.
upload	A user uploads a file.
parse	An uploaded file is parsed.
inputValueChange	A user changes the value of the input field.

---

method

enum

The JavaScript method to perform when type is datasource, widget, state, or localStorage.

---

type

enum

The type of action to perform.

Values

datasource	Control query.
widget	Control component.
script	Run script.
state	Set variable.
localStorage	Set localStorage.
util	Perform utility action (e.g., Open URL or Confetti).

---

---

global

boolean

Whether the object is globally scoped for use in all app pages.

---

hidden

boolean

Whether the component is visible.

---

id

string

The unique identifier.

---

isHiddenOnDesktop

boolean

Whether the component is visible in the desktop layout.

---

isHiddenOnMobile

boolean

Whether the component is visible in the mobile layout.

---

linkedTableId

string

The ID of the linked table.

---

linkToTable

boolean

Whether to link with a table.

---

maintainSpaceWhenHidden

boolean

Whether the component takes up space on the canvas if hidden is true.

---

margin

enum

The amount of margin to render outside.

Values

4px 8px	Normal margin.
0	No margin.

---

pluginType

string

The plugin type.

---

showInEditor

boolean

Whether to remain visible in the editor if hidden is true.

---

style

object

Custom style options in use. Not all style options may be available for all components.

---

tooltipText

string

The tooltip text to display.

---

value

object

Filters set.

Properties

filters

object[]

A list of filters applied to the table.

Properties

columnId

string

The column on which to filter.

---

disabled

boolean

Whether the filter is disabled.

---

operator

string

The operator.

---

value

string

The filter value.

---

---

---

Methods

JavaScript API methods for interacting with Filter. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

clearValue

Clear the current values.

filter.clearValue()

---

resetValue

Reset the current value to the default value.

filter.resetValue()

---

scrollIntoView

Scrolls the canvas or parent container so that the selected component appears in the visible area.

filter.scrollIntoView(scrollIntoViewOptions)

Parameters

scrollIntoViewOptions

object

The scroll options.

Properties

behavior

enum

The scroll behavior.

Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

---

block

enum

The scroll position relative to the component.

Values

nearest	Scrolls only the minimum amount required for the component to appear in the visible area. Scrolling does not occur if the component is already in view.
start	Scrolls to position the component at the top of the visible area.
center	Scrolls to position the component in the middle of the visible area.
end	Scrolls to position the component at the bottom of the visible area.

---

---

---

setHidden

Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.

filter.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

---

---

setValue

Set the current value.

filter.setValue(value)

Parameters

value

object

Filters set.

Properties

filters

object[]

A list of filters applied to the table.

Properties

columnId

string

The column on which to filter.

---

disabled

boolean

Whether the filter is disabled.

---

operator

string

The operator.

---

value

string

The filter value.

---

---

---

---

Events

Events are triggered by user interactions, such as clicking a button or entering a value. Use event handlers to trigger queries or other actions in response to events.