Cascader

TYPESCRIPT / BROWSER

Live TypeScript example

Try the component here, then use the source below in your application.

Component sizev0.6.2 · minified + gzip

JavaScript: 3.9 KiB
Component CSS: 1.0 KiB
Shared theme CSS: 3.8 KiBonce per application

How sizes are measured

The JavaScript figure includes this component’s required helpers. CSS includes its styling dependencies. Each entry is bundled separately for ES2022, minified, then compressed with gzip level 9. Your bundler may share helpers across components. Images, fonts, examples and application code are excluded.

Before compression: JavaScript 10.0 KiB; component CSS 2.8 KiB. These figures describe browser assets, not the complete package download.

View all component measurements →

Preview

Interact with the Cascader example. The code below shows its actual inputs and callbacks.

import '@blukavantui/web/theme.css'

import {createCascader} from '@blukavantui/web/cascader';
import '@blukavantui/web/cascader.css';
export function mount(host: HTMLElement) {
  return createCascader(host, {
  "SelectedKey": "",
  "LeavesOnly": true,
  "IsDisabled": false,
  "Placeholder": "Select an office…",
  "Nodes": [
    {
      "Key": "americas",
      "ParentKey": "",
      "Label": "Americas"
    },
    {
      "Key": "europe",
      "ParentKey": "",
      "Label": "Europe"
    },
    {
      "Key": "asia",
      "ParentKey": "",
      "Label": "Asia Pacific"
    },
    {
      "Key": "usa",
      "ParentKey": "americas",
      "Label": "United States"
    },
    {
      "Key": "canada",
      "ParentKey": "americas",
      "Label": "Canada"
    },
    {
      "Key": "uk",
      "ParentKey": "europe",
      "Label": "United Kingdom"
    },
    {
      "Key": "germany",
      "ParentKey": "europe",
      "Label": "Germany"
    },
    {
      "Key": "japan",
      "ParentKey": "asia",
      "Label": "Japan"
    },
    {
      "Key": "ny",
      "ParentKey": "usa",
      "Label": "New York"
    },
    {
      "Key": "sf",
      "ParentKey": "usa",
      "Label": "San Francisco"
    },
    {
      "Key": "toronto",
      "ParentKey": "canada",
      "Label": "Toronto"
    },
    {
      "Key": "london",
      "ParentKey": "uk",
      "Label": "London"
    },
    {
      "Key": "berlin",
      "ParentKey": "germany",
      "Label": "Berlin"
    },
    {
      "Key": "tokyo",
      "ParentKey": "japan",
      "Label": "Tokyo"
    },
    {
      "Key": "closed",
      "ParentKey": "japan",
      "Label": "Osaka (unavailable)",
      "IsDisabled": true
    }
  ]
}, { SelectionChanged: (key, pathKeys, pathLabels) => { host.dataset.selection = JSON.stringify({ key, pathKeys, pathLabels }); } });
}

const instance = mount(document.getElementById('example')!)

// When this page or framework component is removed:
// instance.destroy()

Install the library and add the host element

npm install https://blukavantui.blutekmedia.com/downloads/blukavantui-web-0.6.2.tgz

<div id="example"></div>

Download .ts source ↓TypeScript interfaces →Web API reference →Installation guide →

Download TypeScript library · 825.6 KiB ↓Download starter project · 907.6 KiB ↓

Connect your application data

This example uses the downloadable @blukavantui/web package. Your application handles persistence and authentication through its typed callbacks. The starter ZIP includes this same example.

Build on your platform

Choose the reference that matches your application.

WEB · TYPESCRIPT

createCascader

Pass options as the second argument and callbacks in the third argument. Keep the returned instance to update options or dispose it when its view is removed.

v0.6.2

import { createCascader } from '@blukavantui/web/cascader';
import '@blukavantui/web/cascader.css';

Load @blukavantui/web/theme.css once in your app shell.

createCascader(host: HTMLElement, options: T.CascaderOptions, events?: T.CascaderEvents)

Reference for @blukavantui/web 0.6.2. Required and optional follow the shipped TypeScript declarations; optional does not imply a particular default. Pass typed arrays and objects directly where shown.

Options

Name	Type / requirement	Usage
`Nodes`	`TreeNode[]`Required	Complete flat hierarchy. Keys must be unique; ParentKey references another item or is empty.
`SelectedKey`	`string`Optional	Controlled selected key. Assign OnSelectionChanged.Key back.
`LeavesOnly`	`boolean`Optional	Requires selection of a leaf; otherwise branches can also be selected.
`IsDisabled`	`boolean`Optional	Disables the picker.
`IsClearable`	`boolean`Optional	Allows clearing the selection.
`Placeholder`	`string`Optional	Empty-selection prompt.
`AccessibleLabel`	`string`Optional	Accessible name of the picker.
`ExtendedClass`	`string`Optional	Additional CSS classes on the component root.

Callbacks

Name	Type / requirement	Usage
`SelectionChanged`	`(key: string, pathKeys: string[], pathLabels: string[]) => unknown`Optional	Reports the new selection to your application.
`Error`	`(message: string) => unknown`Optional

Instance methods & properties

Name	Signature / type	Usage
`element`	`HTMLElement`	Root owned by this instance. Dispose before removing its host.
`update`	`(patch: Partial<T.CascaderOptions>) => void`	Apply a partial options update to this instance.
`destroy`	`() => void`	Dispose the instance and its listeners when the view is removed.

Related data types

Expand a type for its fields and allowed values.

TreeNode

interface TreeNode {
    Key: string;
    Label: string;
    ParentKey?: string;
    IsDisabled?: boolean;
}

Events0No events yet.View events

Interact with an example to see its events.

Live TypeScript example

createCascader

Options

Callbacks

Instance methods & properties

Related data types

Purpose and use

Keyboard design guidance

In your application

Search BluKavantUI