The Key Value web component
A content area for viewing and editing key-value data.
Settings
Key Value includes the following configurable options when building apps in the IDE.
DataEdit iconEvent handlersGroup layoutHeightShow on desktopShow on mobileAllow wrappingMaintain space when hiddenMarginMin col widthOverflowAlways show in edit modeStyles |
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.
changeset
Edited values for each row.
disableSave
Whether to disable saving changes for edited values.
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.
groupLayout
The layout of grouped items.
Values
multiColumn | Display items in multiple columns based on the number of items and size. |
singleColumn | Always display items in a single column. |
wrap | Wrap items. |
heightType
Whether the height automatically resizes to fit content or is a fixed size.
Values
fixed | Fixed height. |
auto | Expand to fit content. |
id
The unique identifier.
isHiddenOnDesktop
Whether the component is visible in the desktop layout.
isHiddenOnMobile
Whether the component is visible in the mobile layout.
The position of the label relative to the input field or value.
Values
top | Above the input field or value. |
left | Left of the input field or value. |
maintainSpaceWhenHidden
Whether the component takes up space on the canvas if hidden
is true
.
minColumnWidth
The minimum width of a column when using a multi-column layout.
overflowType
The overflow behavior when the contents exceeds the height.
Values
scroll | Display a scrollbar. |
pagination | Use pagination. |
pluginType
The plugin type.
showInEditor
Whether to remain visible in the editor if hidden
is true
.
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.
scrollIntoView
Scrolls the canvas or parent container so that the selected component appears in the visible area.
keyValue.scrollIntoView(scrollIntoViewOptions)
Parameters
scrollIntoViewOptions
The scroll options.
Properties
behavior
The scroll behavior.
Values
auto | Scroll immediately to the specified position. |
smooth | Scroll gradually to the specified position. |
block
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.
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.
clickValue
A value is clicked or pressed.
save
Changes are saved.