Text Picker
- Print
- DarkLight
Text Picker
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
The Text Picker contains a single MUI TextField for users to enter text.
https://mui.com/material-ui/api/text-field/
Configuration Options
The picker can be configured through the following options:
Option | Type | Default | Description |
|---|---|---|---|
| boolean | false | Specifies if the text field is required. If false, the apply button will be disabled until the user enters text. |
| string | null | Tooltip text providing additional information. |
| object | {} | Options to override the default MUI TextField properties. https://mui.com/material-ui/api/text-field/ |
| string | null | Optional default value if specified |
Example Configuration
{
"id": "text_picker",
"isRequired": false,
"infoTooltip": "Tooltip for more information",
"textFieldOptionOverride": {
"helperText": "This text field is for..."
},
"type": "text"
}Default Query Params
The text picker generates the following params to the API Query:
Parameter | Type | Description |
|---|---|---|
| string | the input text value |
Example request body:
"text_picker": {
"pickerType": "text",
"value": "User's free form text value"
}Page Link
Example mapping for page link.
Assigning the text with any string.
{
"mapping": {
'text': '"assigned_text"'
}
}