The Key Value mobile component
A content area for key-value data.
Settings
Key Value includes the following configurable options when building apps in the IDE.
Allow text wrappingDataDirectionEvent handlersShow 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
Whether to wrap text.
Properties
event
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 |
false | A user sets the value to |
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
The JavaScript method to perform when type
is datasource
, widget
, state
, or localStorage
.
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
Whether the object is globally scoped for use in all app pages.
header
The text to display as a title.
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
pluginType
The plugin type.
rowVisibility
A list of visible rows.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
showSeparator
Whether the show a separating line betweeen items.
valueWidth
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
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.