Component | URL Input

Render a url input box.

Node.js

ui.urlInput("url-input-key", { 
    label: "Enter a url",
    onEnter: (value) => console.log(value)
})

Python

ui.url_input(
    "url-input-key",
    label="Enter a url",
    on_enter=lambda value: print(value)
)

node

This component is a light wrapper on top of ui.textInput with url validation built in.

python

This component is a light wrapper on top of ui.text_input with url validation built in.

Learn more about working with inputs.

API reference

Function signature

Node.js

ui.urlInput(
    id: string,
    properties?: Partial<{
        label: string,
        description: string,
        required: boolean,
        initialValue: string | null,
        validate: (value: string | null) => string | void,
        onEnter: (value: string | null) => void,
        style: Style
    }>
)

Python

ui.url_input(
    id: str,
    *,
    label: str | None = None,
    description: str | None = None,
    required: bool = True,
    initial_value: str | None = None,
    validate: Callable[[str | None], str | None] | None = None,
    on_enter: Callable[[str | None], None] | None = None,
    style: Style | None = None
)

Parameters

Node.js

id

required string

A unique identifier for the component. This is necessary so that Compose can properly pass user actions back to the component.

Python

id

required str

A unique identifier for the component. This is necessary so that Compose can properly pass user actions back to the component.

---

Node.js

properties.label

optional string

The label to display above the url input. If not provided, the label will be inferred from the id.

Python

label

optional str

The label to display above the url input. If not provided, the label will be inferred from the id.

---

Node.js

properties.description

optional string

A description to display between the label and url input box.

Python

description

optional str

A description to display between the label and url input box.

---

Node.js

properties.required

optional boolean

Validate that the url input is not empty before submitting the form it's part of or calling it's onEnter hook. Defaults to true.

Python

required

optional bool

Validate that the url input is not empty before submitting the form it's part of or calling it's on_enter hook. Defaults to True.

---

Node.js

properties.initialValue

optional string | null

The initial value of the url input. Defaults to null. You can also update the value of the url input at any time using the page.setInputs() method.

Python

initial_value

optional str | None

The initial value of the url input. Defaults to None. You can also update the value of the url input at any time using the page.set_inputs() method.

---

Node.js

properties.validate

optional (value: string | null) => string | void

Validate the url input value before submitting it. If the function returns a string, it will be displayed as an error message.

Python

validate

optional Callable[[str | None], str | None]

Validate the url input value before submitting it. If the function returns a string, it will be displayed as an error message.

---

Node.js

properties.onEnter

optional (value: string | null) => void

A callback function that is called when the user presses enter in the url input.

Python

on_enter

optional Callable[[str | None], None]

A callback function that is called when the user presses enter in the url input.

---

Node.js

properties.style

optional Style

Directly style the underlying element using CSS. See the styling guide for more details on available style properties.

Python

style

optional Style | None

Directly style the underlying element using CSS. See the styling guide for more details on available style properties.

---