The Key Value component for Retool Apps

A content area for viewing and editing key-value data.

Demo

Properties

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

changeset

Edited values for each row.

Type	array
Format	Custom data
Array values	object
Configurability	Read-only
Default	null

---

data

The data.

Type	string | number | boolean | object | array
Format	Custom data
Configurability	Inspector
Default	null

---

disableSave

Whether to disable saving changes for edited values.

Type	boolean
Configurability	Read-only
Default	null

---

editIcon

The icon to display that indicates an editable value.

Type	string
Format	Icon Key
Configurability	Inspector > Content > Add-ons > Edit icon
Default	"/icon:bold/interface-edit-write-1"

Examples

/icon:bold/interface-edit-write-1

---

events

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

Type	array
Array values	object
Configurability	Inspector > Interaction > Event handlers
Default	null

Array Object Properties

event

The event that triggers the action. Refer to the events section for details of available events for this object.

Type	string
Configurability	Inspector > Interaction > Event handlers > Event
Default	null

---

method

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

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Run script actions
Default	null

---

type

The type of action to perform.

Type	string
Configurability	Inspector > Interaction > Event handlers > Edit event handler > Action
Allowed Values	Value Description 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).
Default	null

---

---

groupLayout

The layout of grouped items.

Type	string
Configurability	Inspector > Appearance > Group layout
Allowed Values	Value UI Option Description multiColumn Tree Display items in multiple columns based on the number of items and size. singleColumn Single column Always display items in a single column. wrap Wrap Wrap items. auto Auto Automatically display items in multiple columns based on the number of items and size.
Default	auto

---

heightType

Whether the height automatically adjusts to fit content or is a fixed size.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Height
Allowed Values	Value Description auto Expand to fit content. fixed Fixed height. fill
Default	fixed

---

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Hidden
Default	false

Examples

true

---

id

The unique identifier (name).

Type	string
Format	Plain Text
Configurability	Inspector
Default	keyValue1

Examples

query1

button1

---

isHiddenOnDesktop

Whether to show or hide this object in the desktop layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on desktop
Default	false

Examples

true

---

isHiddenOnMobile

Whether to show or hide this object in the mobile layout.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Show on mobile
Default	true

Examples

true

---

itemLabelPosition

The position of the label relative to the input field or value.

Type	string
Format	Plain Text
Configurability	Inspector > Content > Add-ons > Label > Position
Allowed Values	Value UI Option Description top Top Above the input field or value. left Left Left of the input field or value.
Default	left

Examples

top

---

labelWrap

Whether the label can wrap to multiple lines.

Type	boolean
Configurability	Inspector > Content > Add-ons > Label > Allow wrapping
Default	null

---

maintainSpaceWhenHidden

Whether to take up space on the canvas if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Maintain space when hidden
Default	false

Examples

true

---

margin

The amount of margin to render outside.

Type	string
Format	Plain Text
Configurability	Inspector > Spacing > Margin
Allowed Values	Value UI Option Description 4px 8px Normal Normal margin. 0 None No margin.
Default	4px 8px

Examples

4px 8px

---

minColumnWidth

The minimum width of a column when using a multi-column layout.

Type	number
Format	number
Configurability	Inspector > Appearance > Min col width
Default	null

Examples

100

---

showInEditor

Whether the component remains visible in the editor if hidden is true.

Type	boolean
Format	True/False
Configurability	Inspector > Appearance > Advanced > Always show in edit mode
Default	false

Examples

true

---

style

Custom style options.

Type	object
Configurability	Inspector > Appearance > style
Default	null

---

Methods

JavaScript API methods for this object. You can write JavaScript almost anywhere in Retool and use methods to manipulate data and property values.

keyValue.scrollIntoView()

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

Definition

keyValue.scrollIntoView(options)

Parameters

options

The scroll options.

Type

object

Object Properties

behavior

The scroll behavior.

Type	string
Allowed Values	Value Description auto Scroll immediately to the specified position. smooth Scroll gradually to the specified position.

---

block

The scroll position relative to the component.

Type	string
Allowed Values	Value Description 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.

---

---

Examples

Scroll the minimum amount to immediately bring keyValue into view.

keyValue.scrollIntoView({behavior: 'auto', block: 'nearest'});

---

keyValue.setHidden()

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

Definition

keyValue.setHidden(hidden)

Parameters

hidden

Whether this object is hidden from view.

Type	boolean
Format	True/False
Default	false

Examples

true

---

Examples

Hide keyValue.

keyValue.setHidden(true);

Unhide keyValue.

keyValue.setHidden(false);

---

Events

Events triggered by user interactions. You can configure event handlers in the IDE to trigger queries or other actions in response to events.

Event	Description
Click Value	A value is clicked or pressed.
Save	Changes are saved.