The Key Value component for Retool Mobile

A content area for key-value data.

Demo

Settings

Key Value includes the following configurable options when building apps in the IDE.

Allow text wrappingDataDirectionEvent handlersHiddenShow on desktopShow on mobileMaintain space when hiddenMarginShow rowAlways show in edit modeShow separatorStylesAlign valueWidth

Properties

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

allowTextWrapping

boolean

Whether to wrap text.

data

any[]

The source data.

direction

enum

The layout of content.

Values

row	Horizontal row layout.
column	Vertical column layout.

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).

header

string

The text to display as a title.

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.

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.

rowVisibility

object

A list of visible rows.

showInEditor

boolean

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

showSeparator

boolean

Whether the show a separating line betweeen items.

style

object

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

value

enum

The text alignment of values.

Values

left	Align left.
right	Align right.

valueWidth

enum

The width of the value column.

Values

75%	75% width.
50%	50% width.
25%	25% width.

Methods

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

setHidden

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

keyValue.setHidden(hidden)

Parameters

hidden

boolean

Whether the component is visible.

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.