Skip to content
THE COMPONENT LIBRARY
Skip to content

Component reference

Cascader

Choose a shipping destination through nested levels.

Preview

Live preview

Changes apply to this preview only.

Shipping destination

Choose a region to estimate the delivery window.

Width adapts to the available space

More examples

Different configurations and compositions using the real Pimolu API. Each preview runs independently and follows the site appearance.

Basic

Click a branch to expand it, then choose a leaf. The trigger shows the full path.

Open preview

Controlled

value is the path from the root; onChange receives the path and its option.

Open preview

States

Disabled, helper text, clearable, a pre-selected default and an empty data set.

Open preview

Usage

Use Cascader for a path and TreeSelect when users need a broader tree view.

API reference

Generated from the public TypeScript declarations. Native HTML attributes are inherited where the component extends them; this reference includes Pimolu props and selected common native attributes.

PimoluCascaderOption

Type source
PimoluCascaderOption public API
NameTypeDefaultDescription
valueRequiredstring—Public Pimolu prop; see the source declaration for details.
labelRequiredstring—Visible label associated with the control.
childrenreadonly PimoluCascaderOption[] | undefined—Public Pimolu prop; see the source declaration for details.
disabledboolean | undefinedfalsePublic Pimolu prop; see the source declaration for details.
valueRequired

string

No default extracted.

Public Pimolu prop; see the source declaration for details.

labelRequired

string

No default extracted.

Visible label associated with the control.

children

readonly PimoluCascaderOption[] | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

disabled

boolean | undefined

Default: false

Public Pimolu prop; see the source declaration for details.

PimoluCascaderProps

Type source
PimoluCascaderProps public API
NameTypeDefaultDescription
idstring | undefined—Public Pimolu prop; see the source declaration for details.
optionsRequiredreadonly PimoluCascaderOption[]—Public Pimolu prop; see the source declaration for details.
valuereadonly string[] | undefined—Controlled selection, from the root to the chosen option.
defaultValuereadonly string[] | undefined[]Initial selection when uncontrolled.
onChange((path: string[], option?: PimoluCascaderOption) => void) | undefined—Called with the new path and its option. A cleared selection reports an empty path and `undefined`.
labelstring | undefined—Visible label associated with the control.
placeholderstring | undefined"Select an option"Public Pimolu prop; see the source declaration for details.
helperTextstring | undefined—Supporting text below the field.
emptyMessagestring | undefined"No options available."Public Pimolu prop; see the source declaration for details.
clearableboolean | undefinedtruePublic Pimolu prop; see the source declaration for details.
disabledboolean | undefinedfalsePublic Pimolu prop; see the source declaration for details.
fullWidthboolean | undefinedfalseUse the available width of the parent.
classNamestring | undefined—Public Pimolu prop; see the source declaration for details.
styleCSSProperties | undefined—Public Pimolu prop; see the source declaration for details.
aria-labelstring | undefined—Public Pimolu prop; see the source declaration for details.
aria-labelledbystring | undefined—Public Pimolu prop; see the source declaration for details.
aria-describedbystring | undefined—Public Pimolu prop; see the source declaration for details.
id

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

optionsRequired

readonly PimoluCascaderOption[]

No default extracted.

Public Pimolu prop; see the source declaration for details.

value

readonly string[] | undefined

No default extracted.

Controlled selection, from the root to the chosen option.

defaultValue

readonly string[] | undefined

Default: []

Initial selection when uncontrolled.

onChange

((path: string[], option?: PimoluCascaderOption) => void) | undefined

No default extracted.

Called with the new path and its option. A cleared selection reports an empty path and `undefined`.

label

string | undefined

No default extracted.

Visible label associated with the control.

placeholder

string | undefined

Default: "Select an option"

Public Pimolu prop; see the source declaration for details.

helperText

string | undefined

No default extracted.

Supporting text below the field.

emptyMessage

string | undefined

Default: "No options available."

Public Pimolu prop; see the source declaration for details.

clearable

boolean | undefined

Default: true

Public Pimolu prop; see the source declaration for details.

disabled

boolean | undefined

Default: false

Public Pimolu prop; see the source declaration for details.

fullWidth

boolean | undefined

Default: false

Use the available width of the parent.

className

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

style

CSSProperties | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

aria-label

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

aria-labelledby

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

aria-describedby

string | undefined

No default extracted.

Public Pimolu prop; see the source declaration for details.

Accessibility

  • Keep the hierarchy understandable and verify back navigation and disabled choices.
Read the accessibility guide →