Component | Password Input

Render a password input box.

TypeScript / JavaScript

ui.passwordInput("password-input-key", { 
    label: "Enter your password",
    onEnter: (value) => console.log(value)
})

Python

ui.password_input(
    "password-input-key",
    label="Enter your password",
    on_enter=lambda value: print(value)
)

node

This component is a light wrapper on top of ui.textInput with the input obscured.

python

This component is a light wrapper on top of ui.text_input with the input obscured.

Learn more about working with inputs.

API reference

Function signature

TypeScript / JavaScript

ui.passwordInput(
    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.password_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

TypeScript / JavaScript

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.

---

TypeScript / JavaScript

properties.label

optional string

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

Python

label

optional str

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

---

TypeScript / JavaScript

properties.description

optional string

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

Python

description

optional str

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

---

TypeScript / JavaScript

properties.required

optional boolean

Validate that the password 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 password input is not empty before submitting the form it's part of or calling it's on_enter hook. Defaults to True.

---

TypeScript / JavaScript

properties.initialValue

optional string | null

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

Python

initial_value

optional str | None

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

---

TypeScript / JavaScript

properties.validate

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

Validate the password 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 password input value before submitting it. If the function returns a string, it will be displayed as an error message.

---

TypeScript / JavaScript

properties.onEnter

optional (value: string | null) => void

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

Python

on_enter

optional Callable[[str | None], None]

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

---

TypeScript / JavaScript

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.

---