For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/components/cascader.md.
v0.0.57
  • English
  • Cascader

    Data Entry@rockshin/tao-ui

    Choose complete paths through hierarchical options with search, multiple selection and a standalone panel.

    Each example can be copied and run independently. Use the device control on framed previews to switch between desktop and phone widths.

    Sizes are small, medium and large; the compatible middle alias uses the same dimensions as medium.

    Below 576px, Cascader automatically uses a bottom drawer. Use mobile to override the surface and mobileTitle to name the drawer. Mobile single selection commits immediately; multiple selection commits on Done and cancels on dismissal. On desktop, the clear action replaces the arrow on hover; touch keeps clear visible.

    Examples

    Choose a complete path

    The selected value contains each level in the chosen path.

    Asia / China / Shanghai
    TSX

    Controlled path and display

    displayRender can shorten the displayed path while preserving every value in state.

    Tokyo

    asia / japan / tokyo

    TSX

    Select multiple paths

    Multiple mode adds linked checkboxes. SHOW_CHILD keeps leaf paths in the visible selection.

    TSX

    Choose intermediate levels

    changeOnSelect allows a parent path to be selected. This example expands columns on pointer hover.

    Choose a continent, country or city
    TSX

    Map custom fields

    Field names let existing domain data remain unchanged.

    Choose a region
    TSX

    Load columns on demand

    The local delay stands in for a data request. Mark unresolved parents with isLeaf:false and update options after loading.

    Load cities
    TSX

    Use the standalone panel

    Cascader.Panel keeps the columns visible without a trigger input.

    TSX

    Mobile bottom drawer

    Choose a three-level path in a bottom drawer on phones. The columns scroll horizontally when the path exceeds the available width.

    Single selection applies as soon as the user picks a path. With multiple, changes in the drawer apply when the user taps Done. Since 0.0.49, Cascader skips newly chosen paths that are removed or disabled before confirmation, while keeping previously committed paths that the user has left selected.

    390 × 640
    TSX

    API

    CascaderPanel

    PropertyDescriptionTypeDefault Value

    Cascader

    PropertyDescriptionTypeDefault Value
    mobileUse a bottom drawer. Automatically enabled below 576px.boolean | undefined-
    mobileTitleDrawer title; defaults to the field label, then localized selection text.ReactNode-