The URL component for Retool Apps

An input field to enter a URL.

Version: Self-hosted 3.114 Stable

URL is a preset version of Text Input. It has been preconfigured with common options for URL input.

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.

autoCapitalize

The type of automatic capitalization that the browser can automatically perform when using virtual or on-screen keyboards.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced
Allowed Values	Value Description none No capitalization. sentences Capitalize sentences. words Capitalize words. characters Capitalize characters.
Default	none

Examples

"words"

---

autoComplete

Whether the browser can perform autocomplete on the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector
Default	false

Examples

true

---

autoFill

The data type of the input field for browsers to autofill if autoComplete is true.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description off Disable browser autofill. additional-name Additional name. address-line1 Address line 1. address-line2 Address line 2. birthdate-day Birthdate day. birthdate-full Full birthdate. birthdate-month Birthdate month. birthdate-year Birthdate year. cc-csc Credit card security code. cc-exp Credit card expiration date. cc-exp-day Credit card expiration day. cc-exp-month Credit card expiration month. cc-exp-year Credit card expiration year. cc-number Credit card number. country Country. current-password Current password. email Email address. family-name Family name. gender Gender. given-name Given name. honorific-prefix Honorific prefix. honorific-suffix Honorific suffix. name Full name. new-password New password. one-time-code One-time code. postal-code Postal code. street-address Street address. tel Telephone number. username Username.
Default	off

Examples

"email"

---

disabled

Whether input, interaction, selection, or triggering is disabled.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction Method setDisabled()
Default	false

Examples

true

---

enforceMaxLength

Whether to enforce the maximum length.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced
Default	false

Examples

true

---

iconAfter

The suffix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

/icon:bold/shopping-gift

---

iconBefore

The prefix icon to display.

Type	string
Format	Icon Key
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

/icon:bold/shopping-gift

---

inputTooltip

The tooltip helper text to display below the input on focus.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	`Shift+Enter` to save, `Esc` to cancel

Examples

`Shift+Enter` to save, `Esc` to cancel

---

label

The text label to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
Default	null

Examples

"Label"

---

labelPosition

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

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons > Label
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

---

loading

Whether to display a loading indicator.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction
Default	false

Examples

true

---

maxLength

The maximum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	null

Examples

100

---

minLength

The minimum number of characters to allow.

Type	number
Format	Integer
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	null

Examples

20

---

pattern

A regular expression (regex), without forward slashes around the pattern, to validate input if patternType is regex.

Type	string
Format	Regular Expression
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	null

Examples

^[a-zA-Z0-9]+$

---

patternType

The pattern with which to validate the input.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector
Allowed Values	Value Description email Email address. regex Regular expression statement. url URL.
Default	null

---

placeholder

The text to display within the input field when there is no value.

Type	string
Format	string
Mutability	Control Usage Retool UI Inspector > Content
Default	Enter a value

Examples

Enter a value

---

readOnly

Whether user input is read-only.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced
Default	false

Examples

true

---

required

Whether a value is required to be selected.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Validation rules
Default	false

Examples

true

---

showCharacterCount

Whether to display a character count with the input field.

Type	boolean
Mutability	Control Usage Retool UI Inspector

---

showClear

Whether to display a button to clear the value of the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Appearance
Default	false

Examples

true

---

spellCheck

Whether the browser can perform spellcheck on the input field.

Type	boolean
Format	True/False
Mutability	Control Usage Retool UI Inspector > Interaction > Advanced
Default	false

Examples

true

---

style

Custom style options.

Type	object
Mutability	Control Usage Retool UI Inspector > Appearance

---

textAfter

The suffix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

USD

px

@example.com

---

textBefore

The prefix text to display.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

$

Email address

SKU

---

tooltipText

The tooltip text to display next to the label on hover.

Type	string
Format	Markdown
Mutability	Control Usage Retool UI Inspector > Content > Add-ons
Default	null

Examples

Submit

---

value

The current or default value.

Type	string
Format	Plain Text
Mutability	Control Usage Retool UI Inspector > Content Method setValue()
Default	null

Examples

Hello world!

---

Methods

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

url.blur()

Remove focus from the input field.

Definition

url.blur()

Examples

Remove focus from url.

url.blur();

---

url.clearValidation()

Clear the validation message from the input field.

Definition

url.clearValidation()

Examples

Clear the validation message from url.

url.clearValidation();

---

url.clearValue()

Clear the current values.

Definition

url.clearValue()

Examples

Clear the current value of url.

url.clearValue();

---

url.focus()

Set focus on the input field.

Definition

url.focus()

Examples

Set focus on url.

url.focus();

---

url.resetValue()

Reset the current value to the default value.

Definition

url.resetValue()

Examples

Reset the current value of url.

url.resetValue();

---

url.scrollIntoView()

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

Definition

url.scrollIntoView(options)

Parameters

options Required

object

The scroll options.

Object Properties

behavior Required

string

The scroll behavior.

Supported Values

auto	Scroll immediately to the specified position.
smooth	Scroll gradually to the specified position.

block Required

string

The scroll position relative to the component.

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

Examples

Scroll the minimum amount to immediately bring url into view.

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

---

url.setDisabled()

Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.

Definition

url.setDisabled(disabled)

Parameters

disabled

boolean

Whether input, interaction, selection, or triggering is disabled.

Examples

Disable url.

url.setDisabled(true);

Enable url.

url.setDisabled(false);

---

url.setHidden()

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

Definition

url.setHidden(hidden)

Parameters

hidden

boolean

Whether this object is hidden from view.

Examples

Hide url.

url.setHidden(true);

Unhide url.

url.setHidden(false);

---

url.setValue()

Set the current value.

Definition

url.setValue(value)

Parameters

value

unknown

Examples

Set the current value of url to userValue.

url.setValue(userValue);

---

Events

Events triggered by user interactions. Use event handlers to trigger queries or other actions in response to events.

change

The value is changed.

---

submit

The value is submitted.

---

focus

The input field is selected.

---

blur

The input field is deselected.

---