@apexhub/apex-ui-react 0.0.0-stage → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +37 -2
- package/dist/en_US.d.ts +191 -0
- package/dist/index.cjs +40692 -0
- package/dist/index.d.ts +6869 -0
- package/dist/index.mjs +40676 -0
- package/dist/llm/alert.tokens.txt +44 -0
- package/dist/llm/alert.txt +167 -0
- package/dist/llm/apex-provider.txt +368 -0
- package/dist/llm/auto-complete.tokens.txt +77 -0
- package/dist/llm/auto-complete.txt +373 -0
- package/dist/llm/avatar.tokens.txt +38 -0
- package/dist/llm/avatar.txt +199 -0
- package/dist/llm/breadcrumb.tokens.txt +193 -0
- package/dist/llm/breadcrumb.txt +251 -0
- package/dist/llm/button.tokens.txt +470 -0
- package/dist/llm/button.txt +262 -0
- package/dist/llm/card.tokens.txt +27 -0
- package/dist/llm/card.txt +95 -0
- package/dist/llm/cascader.tokens.txt +253 -0
- package/dist/llm/cascader.txt +898 -0
- package/dist/llm/checkbox.tokens.txt +28 -0
- package/dist/llm/checkbox.txt +332 -0
- package/dist/llm/collapse.tokens.txt +84 -0
- package/dist/llm/collapse.txt +330 -0
- package/dist/llm/date-picker.tokens.txt +171 -0
- package/dist/llm/date-picker.txt +424 -0
- package/dist/llm/divider.tokens.txt +22 -0
- package/dist/llm/divider.txt +161 -0
- package/dist/llm/drawer.tokens.txt +71 -0
- package/dist/llm/drawer.txt +369 -0
- package/dist/llm/dropdown.tokens.txt +59 -0
- package/dist/llm/dropdown.txt +420 -0
- package/dist/llm/form.tokens.txt +26 -0
- package/dist/llm/form.txt +341 -0
- package/dist/llm/grid.txt +419 -0
- package/dist/llm/image.tokens.txt +28 -0
- package/dist/llm/image.txt +428 -0
- package/dist/llm/input-number.tokens.txt +159 -0
- package/dist/llm/input-number.txt +486 -0
- package/dist/llm/input.tokens.txt +136 -0
- package/dist/llm/input.txt +422 -0
- package/dist/llm/layout.tokens.txt +29 -0
- package/dist/llm/layout.txt +298 -0
- package/dist/llm/menu.tokens.txt +87 -0
- package/dist/llm/menu.txt +680 -0
- package/dist/llm/message.tokens.txt +25 -0
- package/dist/llm/message.txt +301 -0
- package/dist/llm/modal.tokens.txt +96 -0
- package/dist/llm/modal.txt +584 -0
- package/dist/llm/notification.tokens.txt +79 -0
- package/dist/llm/notification.txt +383 -0
- package/dist/llm/pagination.tokens.txt +33 -0
- package/dist/llm/pagination.txt +208 -0
- package/dist/llm/popover.tokens.txt +28 -0
- package/dist/llm/popover.txt +233 -0
- package/dist/llm/progress.tokens.txt +83 -0
- package/dist/llm/progress.txt +279 -0
- package/dist/llm/radio.tokens.txt +21 -0
- package/dist/llm/radio.txt +348 -0
- package/dist/llm/rate.tokens.txt +20 -0
- package/dist/llm/rate.txt +241 -0
- package/dist/llm/select.tokens.txt +160 -0
- package/dist/llm/select.txt +830 -0
- package/dist/llm/skeleton.tokens.txt +15 -0
- package/dist/llm/skeleton.txt +275 -0
- package/dist/llm/spin.tokens.txt +21 -0
- package/dist/llm/spin.txt +294 -0
- package/dist/llm/steps.tokens.txt +30 -0
- package/dist/llm/steps.txt +300 -0
- package/dist/llm/switch.tokens.txt +38 -0
- package/dist/llm/switch.txt +216 -0
- package/dist/llm/table.tokens.txt +94 -0
- package/dist/llm/table.txt +1046 -0
- package/dist/llm/tabs.tokens.txt +78 -0
- package/dist/llm/tabs.txt +306 -0
- package/dist/llm/tag.tokens.txt +76 -0
- package/dist/llm/tag.txt +305 -0
- package/dist/llm/tooltip.tokens.txt +22 -0
- package/dist/llm/tooltip.txt +304 -0
- package/dist/llm/tree-select.tokens.txt +174 -0
- package/dist/llm/tree-select.txt +762 -0
- package/dist/llm/tree.tokens.txt +36 -0
- package/dist/llm/tree.txt +505 -0
- package/dist/llm/typography.tokens.txt +60 -0
- package/dist/llm/typography.txt +413 -0
- package/dist/llm/upload.tokens.txt +201 -0
- package/dist/llm/upload.txt +706 -0
- package/dist/llms-full.txt +16689 -0
- package/dist/llms-theme.txt +32 -0
- package/dist/llms.txt +59 -0
- package/dist/locale/en_US.cjs +160 -0
- package/dist/locale/en_US.d.ts +4 -0
- package/dist/locale/en_US.mjs +161 -0
- package/dist/locale/zh_CN.cjs +160 -0
- package/dist/locale/zh_CN.d.ts +4 -0
- package/dist/locale/zh_CN.mjs +161 -0
- package/dist/style.css +19619 -0
- package/dist/zh_CN.d.ts +191 -0
- package/llms-full.txt +16689 -0
- package/llms-theme.txt +32 -0
- package/llms.txt +59 -0
- package/package.json +118 -3
- package/src/alert/llm.txt +167 -0
- package/src/alert/tokens.txt +44 -0
- package/src/apex-provider/llm.txt +368 -0
- package/src/auto-complete/llm.txt +373 -0
- package/src/auto-complete/tokens.txt +77 -0
- package/src/avatar/llm.txt +199 -0
- package/src/avatar/tokens.txt +38 -0
- package/src/breadcrumb/llm.txt +251 -0
- package/src/breadcrumb/tokens.txt +193 -0
- package/src/button/llm.txt +262 -0
- package/src/button/tokens.txt +470 -0
- package/src/card/llm.txt +95 -0
- package/src/card/tokens.txt +27 -0
- package/src/cascader/llm.txt +898 -0
- package/src/cascader/tokens.txt +253 -0
- package/src/checkbox/llm.txt +332 -0
- package/src/checkbox/tokens.txt +28 -0
- package/src/collapse/llm.txt +330 -0
- package/src/collapse/tokens.txt +84 -0
- package/src/date-picker/llm.txt +424 -0
- package/src/date-picker/tokens.txt +171 -0
- package/src/divider/llm.txt +161 -0
- package/src/divider/tokens.txt +22 -0
- package/src/drawer/llm.txt +369 -0
- package/src/drawer/tokens.txt +71 -0
- package/src/dropdown/llm.txt +420 -0
- package/src/dropdown/tokens.txt +59 -0
- package/src/form/llm.txt +341 -0
- package/src/form/tokens.txt +26 -0
- package/src/grid/llm.txt +419 -0
- package/src/image/llm.txt +428 -0
- package/src/image/tokens.txt +28 -0
- package/src/input/llm.txt +422 -0
- package/src/input/tokens.txt +136 -0
- package/src/input-number/llm.txt +486 -0
- package/src/input-number/tokens.txt +159 -0
- package/src/layout/llm.txt +298 -0
- package/src/layout/tokens.txt +29 -0
- package/src/menu/llm.txt +680 -0
- package/src/menu/tokens.txt +87 -0
- package/src/message/llm.txt +301 -0
- package/src/message/tokens.txt +25 -0
- package/src/modal/llm.txt +584 -0
- package/src/modal/tokens.txt +96 -0
- package/src/notification/llm.txt +383 -0
- package/src/notification/tokens.txt +79 -0
- package/src/pagination/llm.txt +208 -0
- package/src/pagination/tokens.txt +33 -0
- package/src/popover/llm.txt +233 -0
- package/src/popover/tokens.txt +28 -0
- package/src/progress/llm.txt +279 -0
- package/src/progress/tokens.txt +83 -0
- package/src/radio/llm.txt +348 -0
- package/src/radio/tokens.txt +21 -0
- package/src/rate/llm.txt +241 -0
- package/src/rate/tokens.txt +20 -0
- package/src/select/llm.txt +830 -0
- package/src/select/tokens.txt +160 -0
- package/src/skeleton/llm.txt +275 -0
- package/src/skeleton/tokens.txt +15 -0
- package/src/spin/llm.txt +294 -0
- package/src/spin/tokens.txt +21 -0
- package/src/steps/llm.txt +300 -0
- package/src/steps/tokens.txt +30 -0
- package/src/switch/llm.txt +216 -0
- package/src/switch/tokens.txt +38 -0
- package/src/table/llm.txt +1046 -0
- package/src/table/tokens.txt +94 -0
- package/src/tabs/llm.txt +306 -0
- package/src/tabs/tokens.txt +78 -0
- package/src/tag/llm.txt +305 -0
- package/src/tag/tokens.txt +76 -0
- package/src/tooltip/llm.txt +304 -0
- package/src/tooltip/tokens.txt +22 -0
- package/src/tree/llm.txt +505 -0
- package/src/tree/tokens.txt +36 -0
- package/src/tree-select/llm.txt +762 -0
- package/src/tree-select/tokens.txt +174 -0
- package/src/typography/llm.txt +413 -0
- package/src/typography/tokens.txt +60 -0
- package/src/upload/llm.txt +706 -0
- package/src/upload/tokens.txt +201 -0
|
@@ -0,0 +1,898 @@
|
|
|
1
|
+
# Cascader
|
|
2
|
+
|
|
3
|
+
> Cascader:选项具有清晰的层级关系(省市区、分类目录等),需要从根到叶逐级选择时。
|
|
4
|
+
|
|
5
|
+
包:`@apexhub/apex-ui-react`;版本:`1.2.0`(当前源码快照,发布状态以安装包版本为准)。
|
|
6
|
+
|
|
7
|
+
公开导出:`Cascader`。
|
|
8
|
+
|
|
9
|
+
以下 API 属于 Apex UI;不要据 antd 的同名组件推断额外属性或默认值。默认值列的空缺表示未声明,不代表 `false`。
|
|
10
|
+
|
|
11
|
+
## 快速开始
|
|
12
|
+
|
|
13
|
+
```tsx
|
|
14
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
15
|
+
|
|
16
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
17
|
+
|
|
18
|
+
import '@apexhub/apex-ui-react/style.css'
|
|
19
|
+
|
|
20
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
21
|
+
{
|
|
22
|
+
value: 'zhejiang',
|
|
23
|
+
label: '浙江',
|
|
24
|
+
children: [
|
|
25
|
+
{
|
|
26
|
+
value: 'hangzhou',
|
|
27
|
+
label: '杭州',
|
|
28
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
29
|
+
},
|
|
30
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
31
|
+
],
|
|
32
|
+
},
|
|
33
|
+
{
|
|
34
|
+
value: 'jiangsu',
|
|
35
|
+
label: '江苏',
|
|
36
|
+
children: [
|
|
37
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
38
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
39
|
+
],
|
|
40
|
+
},
|
|
41
|
+
]
|
|
42
|
+
|
|
43
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
44
|
+
|
|
45
|
+
export default () => (
|
|
46
|
+
<div style={cascaderWrapStyle}>
|
|
47
|
+
<Cascader options={CASCADER_OPTIONS} placeholder="请选择" allowClear />
|
|
48
|
+
</div>
|
|
49
|
+
)
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## 何时使用
|
|
53
|
+
|
|
54
|
+
- 选项具有清晰的层级关系(省市区、分类目录等),需要从根到叶逐级选择时。
|
|
55
|
+
- 数据量较大、需按需懒加载子级,或需在下拉内搜索匹配路径时。
|
|
56
|
+
- 若选项扁平、无层级,请使用 Select;若为树形结构且需勾选,请考虑 TreeSelect。
|
|
57
|
+
|
|
58
|
+
## API
|
|
59
|
+
|
|
60
|
+
仅使用类型定义支持的属性;原生属性、ref 目标和事件签名因组件而异。关联类型用于解释字段结构;只有「导出类型」中的名称可从包根导入。
|
|
61
|
+
|
|
62
|
+
### Cascader
|
|
63
|
+
|
|
64
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
65
|
+
| --- | --- | --- | --- | --- |
|
|
66
|
+
| variant | 输入框表面变体,与 Input 一致。 | `"default" \| "elevated"` | 否 | `'default'` |
|
|
67
|
+
| size | 输入框尺寸,与 Input / Select 一致:small 24px、medium 28px、large 32px。 | `"small" \| "medium" \| "large"` | 否 | `'medium'` |
|
|
68
|
+
| options | 级联选项数据 | `CascaderOption[]` | 否 | — |
|
|
69
|
+
| fieldNames | 自定义 label / value / children 字段名 | `CascaderFieldNames` | 否 | — |
|
|
70
|
+
| value | 当前选中路径(受控);`multiple` 时为路径数组 | `CascaderValuePath \| CascaderValuePath[]` | 否 | — |
|
|
71
|
+
| defaultValue | 初始选中路径(非受控) | `CascaderValuePath \| CascaderValuePath[]` | 否 | `[]` |
|
|
72
|
+
| changeOnSelect | 是否在选中每一级时即更新值(不仅叶子) | `boolean` | 否 | `false` |
|
|
73
|
+
| disabled | 是否禁用 | `boolean` | 否 | `false` |
|
|
74
|
+
| readOnly | 只读:不可打开下拉、不可改值,无 hover 交互态,仅展示。与 `disabled` 正交。 | `boolean` | 否 | `false` |
|
|
75
|
+
| placeholder | 输入框占位文案 | `string` | 否 | — |
|
|
76
|
+
| allowClear | 是否显示清除按钮;对象可自定义 `clearIcon` | `boolean \| CascaderAllowClear` | 否 | `true` |
|
|
77
|
+
| defaultOpen | 下拉初始是否展开(非受控) | `boolean` | 否 | — |
|
|
78
|
+
| open | 下拉是否展开(受控) | `boolean` | 否 | — |
|
|
79
|
+
| closeOnScroll | 外部滚动祖先滚动时关闭;内部列表滚动不关闭。触发器完全不可见时始终请求关闭。 | `boolean` | 否 | `false` |
|
|
80
|
+
| placement | 下拉弹出位置 | `"bottomLeft" \| "bottomRight" \| "topLeft" \| "topRight"` | 否 | `'bottomLeft'` |
|
|
81
|
+
| expandTrigger | 次级菜单展开触发方式 | `"click" \| "hover"` | 否 | `'click'` |
|
|
82
|
+
| expandIcon | 自定义次级菜单展开图标 | `React.ReactNode` | 否 | — |
|
|
83
|
+
| displayRender | 自定义选中后触发器展示(单选) | `(labels: string[], selectedOptions: CascaderOption[]) => React.ReactNode` | 否 | `(labels) => labels.join(' / ')` |
|
|
84
|
+
| multiple | 是否多选 | `boolean` | 否 | — |
|
|
85
|
+
| tagRender | 自定义多选标签;未传时默认渲染 Apex `Tag` | `(props: CascaderTagRenderProps) => React.ReactNode` | 否 | — |
|
|
86
|
+
| showCheckedStrategy | 多选时已选项在输入框中的展示策略 | `"SHOW_PARENT" \| "SHOW_CHILD"` | 否 | `Cascader.SHOW_PARENT` |
|
|
87
|
+
| maxTagTextLength | 多选标签最大文案长度 | `number` | 否 | — |
|
|
88
|
+
| maxTagCount | 多选时输入框内最多展示的 tag 数量(可见 tag 数,不含 +N)。 | `MaxTagCount` | 否 | — |
|
|
89
|
+
| maxTagPlaceholder | 超出 `maxTagCount` 时的占位内容 | `React.ReactNode \| ((omittedValues: CascaderValuePath[]) => React.ReactNode)` | 否 | — |
|
|
90
|
+
| maxTagPopover | 溢出 tag(+M)的 Popover 行为;默认开启并预览全部已选项(hover + top) | `boolean \| MaxTagPopoverConfig<CascaderValuePath>` | 否 | — |
|
|
91
|
+
| removeIcon | 多选标签删除图标(传给默认 `Tag` 的 `closeIcon`) | `React.ReactNode` | 否 | — |
|
|
92
|
+
| prefix | 触发器前缀图标/内容 | `React.ReactNode` | 否 | — |
|
|
93
|
+
| suffixIcon | 触发器后缀图标 | `React.ReactNode` | 否 | — |
|
|
94
|
+
| status | 校验状态 | `"error" \| "warning"` | 否 | — |
|
|
95
|
+
| notFoundContent | 无匹配数据时的展示 | `React.ReactNode` | 否 | `'Not Found'` |
|
|
96
|
+
| loadingIcon | 动态加载子级时的 loading 图标 | `React.ReactNode` | 否 | — |
|
|
97
|
+
| loadData | 动态加载子级;与 `showSearch` 不能同时开启 | `(selectedOptions: CascaderOption[]) => void` | 否 | — |
|
|
98
|
+
| showSearch | 是否在下拉中显示搜索(主要单选模式) | `boolean \| CascaderShowSearchConfig` | 否 | `false` |
|
|
99
|
+
| searchValue | 受控搜索文本(也可写在 `showSearch` 对象内) | `string` | 否 | — |
|
|
100
|
+
| onSearch | 搜索文本变化 | `(search: string) => void` | 否 | — |
|
|
101
|
+
| getPopupContainer | 已弃用:浮层统一挂载 `[data-slot="overlay-root"]`,该 prop 不再生效。 | `(triggerNode: HTMLElement) => HTMLElement` | 否 | — |
|
|
102
|
+
| popupRender | 自定义下拉列菜单整体渲染 | `(menus: React.ReactNode) => React.ReactNode` | 否 | — |
|
|
103
|
+
| optionRender | 自定义单列选项渲染 | `(option: CascaderOption) => React.ReactNode` | 否 | — |
|
|
104
|
+
| onChange | 选中变化(路径与选项对象数组;`multiple` 时 `selectedOptions` 为每条路径的 option 数组) | `( value: CascaderValuePath \| CascaderValuePath[], selectedOptions: CascaderOption[] \| CascaderOption[][], ) => void` | 否 | — |
|
|
105
|
+
| onOpenChange | 下拉展开状态变化 | `(open: boolean) => void` | 否 | — |
|
|
106
|
+
| styles | 为各语义子结构自定义内联样式(仅允许 CSS Token 等变量赋值,禁止业务硬编码色值) | `Partial<Record<CascaderSemanticDOM, React.CSSProperties>> \| ((info: { props: Readonly<CascaderProps> }) => Partial<Record<CascaderSemanticDOM, React.CSSProperties>>)` | 否 | — |
|
|
107
|
+
| ref | 根容器 ref;焦点 ref 在实现层指向 selector 或 search input(React 19) | `React.Ref<HTMLDivElement>` | 否 | — |
|
|
108
|
+
|
|
109
|
+
### CascaderValue
|
|
110
|
+
|
|
111
|
+
级联路径中每一级的值类型
|
|
112
|
+
|
|
113
|
+
```typescript
|
|
114
|
+
type CascaderValue = string | number
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### CascaderValuePath
|
|
118
|
+
|
|
119
|
+
选中路径:`[parentValue, childValue, ...]`
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
type CascaderValuePath = CascaderValue[]
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### CascaderCheckedStrategy
|
|
126
|
+
|
|
127
|
+
`showCheckedStrategy` 常量(挂到 `Cascader.SHOW_PARENT` / `Cascader.SHOW_CHILD`)
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
type CascaderCheckedStrategy = 'SHOW_PARENT' | 'SHOW_CHILD'
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### CascaderPlacement
|
|
134
|
+
|
|
135
|
+
弹出位置
|
|
136
|
+
|
|
137
|
+
```typescript
|
|
138
|
+
type CascaderPlacement = 'bottomLeft' | 'bottomRight' | 'topLeft' | 'topRight'
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### CascaderExpandTrigger
|
|
142
|
+
|
|
143
|
+
列项展开触发方式
|
|
144
|
+
|
|
145
|
+
```typescript
|
|
146
|
+
type CascaderExpandTrigger = 'click' | 'hover'
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### CascaderFieldNames
|
|
150
|
+
|
|
151
|
+
自定义 `options` 字段映射
|
|
152
|
+
|
|
153
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
154
|
+
| --- | --- | --- | --- | --- |
|
|
155
|
+
| label | — | `string` | 否 | — |
|
|
156
|
+
| value | — | `string` | 否 | — |
|
|
157
|
+
| children | — | `string` | 否 | — |
|
|
158
|
+
|
|
159
|
+
### CascaderOption
|
|
160
|
+
|
|
161
|
+
级联选项
|
|
162
|
+
|
|
163
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
164
|
+
| --- | --- | --- | --- | --- |
|
|
165
|
+
| value | 选项值 | `CascaderValue` | 是 | — |
|
|
166
|
+
| label | 展示文案 | `React.ReactNode` | 否 | — |
|
|
167
|
+
| disabled | 是否禁用 | `boolean` | 否 | — |
|
|
168
|
+
| children | 子选项 | `CascaderOption[]` | 否 | — |
|
|
169
|
+
| isLeaf | 是否为叶子;配合 `loadData` 时 `false` 表示可展开且可能尚未加载子级 | `boolean` | 否 | — |
|
|
170
|
+
|
|
171
|
+
### CascaderAllowClear
|
|
172
|
+
|
|
173
|
+
`allowClear` 为对象时的配置
|
|
174
|
+
|
|
175
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
176
|
+
| --- | --- | --- | --- | --- |
|
|
177
|
+
| clearIcon | — | `React.ReactNode` | 否 | — |
|
|
178
|
+
|
|
179
|
+
### CascaderShowSearchConfig
|
|
180
|
+
|
|
181
|
+
`showSearch` 为对象时的配置
|
|
182
|
+
|
|
183
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
184
|
+
| --- | --- | --- | --- | --- |
|
|
185
|
+
| autoClearSearchValue | 选中后是否清空搜索框(仅 `multiple` 时 有效;Cascader 搜索主要在单选) | `boolean` | 否 | `true` |
|
|
186
|
+
| filter | 过滤函数:`true` 保留该路径 | `(inputValue: string, path: CascaderOption[]) => boolean` | 否 | — |
|
|
187
|
+
| limit | 过滤结果数量上限;`false` 不限制 | `number \| false` | 否 | `50` |
|
|
188
|
+
| matchInputWidth | 下拉列表宽度是否与输入框一致 | `boolean` | 否 | `true` |
|
|
189
|
+
| render | 自定义过滤结果展示 | `(inputValue: string, path: CascaderOption[]) => React.ReactNode` | 否 | — |
|
|
190
|
+
| sort | 过滤结果排序 | `(a: CascaderOption[], b: CascaderOption[], inputValue: string) => number` | 否 | — |
|
|
191
|
+
| searchValue | 受控搜索文本 | `string` | 否 | — |
|
|
192
|
+
| onSearch | 搜索文本变化 | `(search: string) => void` | 否 | — |
|
|
193
|
+
| searchIcon | 自定义搜索图标 | `React.ReactNode` | 否 | — |
|
|
194
|
+
|
|
195
|
+
### CascaderTagRenderProps
|
|
196
|
+
|
|
197
|
+
`tagRender` 入参(`multiple`);默认实现使用 Apex `Tag`
|
|
198
|
+
|
|
199
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
200
|
+
| --- | --- | --- | --- | --- |
|
|
201
|
+
| label | — | `React.ReactNode` | 是 | — |
|
|
202
|
+
| value | — | `CascaderValue` | 是 | — |
|
|
203
|
+
| disabled | — | `boolean` | 否 | — |
|
|
204
|
+
| closable | — | `boolean` | 否 | — |
|
|
205
|
+
| onClose | — | `(event?: React.MouseEvent<HTMLElement>) => void` | 否 | — |
|
|
206
|
+
|
|
207
|
+
### CascaderStatus
|
|
208
|
+
|
|
209
|
+
校验态(触发器复用 Input token)
|
|
210
|
+
|
|
211
|
+
```typescript
|
|
212
|
+
type CascaderStatus = 'error' | 'warning'
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### CascaderSemanticDOM
|
|
216
|
+
|
|
217
|
+
子结构语义,用于 `styles` 分段定制
|
|
218
|
+
|
|
219
|
+
```typescript
|
|
220
|
+
type CascaderSemanticDOM = 'popup'
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
### CascaderStaticProps
|
|
224
|
+
|
|
225
|
+
组件静态常量(实现时挂到 `Cascader` 函数对象)
|
|
226
|
+
|
|
227
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
228
|
+
| --- | --- | --- | --- | --- |
|
|
229
|
+
| SHOW_PARENT | — | `"SHOW_PARENT" \| "SHOW_CHILD"` | 是 | — |
|
|
230
|
+
| SHOW_CHILD | — | `"SHOW_PARENT" \| "SHOW_CHILD"` | 是 | — |
|
|
231
|
+
|
|
232
|
+
### MaxTagCount
|
|
233
|
+
|
|
234
|
+
展示层最多渲染的 tag 数量;超出部分合并为溢出 tag
|
|
235
|
+
|
|
236
|
+
```typescript
|
|
237
|
+
type MaxTagCount = number | 'responsive'
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### MaxTagPopoverConfig
|
|
241
|
+
|
|
242
|
+
泛型参数:`<TValue = string | number>`。
|
|
243
|
+
|
|
244
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
245
|
+
| --- | --- | --- | --- | --- |
|
|
246
|
+
| trigger | — | `"click" \| "hover"` | 否 | `'hover'` |
|
|
247
|
+
| placement | — | `"bottomLeft" \| "bottomRight" \| "topLeft" \| "topRight" \| "top" \| "left" \| "right" \| "bottom" \| "leftTop" \| "leftBottom" \| "rightTop" \| "rightBottom"` | 否 | `'top'` |
|
|
248
|
+
| overlaySelector | 是否覆盖在选择器上展开;设为 false 时使用普通 Popover 定位。@default true | `boolean` | 否 | — |
|
|
249
|
+
| disabled | 禁用 Popover,仅展示 +N | `boolean` | 否 | — |
|
|
250
|
+
| contentRender | 自定义完整已选项预览内容 | `(values: LabeledValue<TValue>[]) => React.ReactNode` | 否 | — |
|
|
251
|
+
|
|
252
|
+
### LabeledValue
|
|
253
|
+
|
|
254
|
+
泛型参数:`<TValue = string | number>`。
|
|
255
|
+
|
|
256
|
+
| 属性 | 说明 | 类型 | 必填 | 默认值 |
|
|
257
|
+
| --- | --- | --- | --- | --- |
|
|
258
|
+
| value | — | `TValue` | 是 | — |
|
|
259
|
+
| label | — | `React.ReactNode` | 是 | — |
|
|
260
|
+
|
|
261
|
+
其他组件的类型不在此展开:`InputVariant` 见 `../input/llm.txt`、`InputSize` 见 `../input/llm.txt`、`PopoverPlacement` 见 `../popover/llm.txt`。
|
|
262
|
+
|
|
263
|
+
### 导出类型
|
|
264
|
+
|
|
265
|
+
另可从 `@apexhub/apex-ui-react` 导入:`CascaderAllowClear`、`CascaderCheckedStrategy`、`CascaderExpandTrigger`、`CascaderFieldNames`、`CascaderOption`、`CascaderPlacement`、`CascaderProps`、`CascaderShowSearchConfig`、`CascaderStaticProps`、`CascaderStatus`、`CascaderTagRenderProps`、`CascaderValue`、`CascaderValuePath`(与上文子类型配合使用)。
|
|
266
|
+
|
|
267
|
+
## 代码演示
|
|
268
|
+
|
|
269
|
+
### 默认值
|
|
270
|
+
|
|
271
|
+
通过 `defaultValue` 设置非受控初始选中路径。
|
|
272
|
+
|
|
273
|
+
```tsx
|
|
274
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
275
|
+
|
|
276
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
277
|
+
|
|
278
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
279
|
+
{
|
|
280
|
+
value: 'zhejiang',
|
|
281
|
+
label: '浙江',
|
|
282
|
+
children: [
|
|
283
|
+
{
|
|
284
|
+
value: 'hangzhou',
|
|
285
|
+
label: '杭州',
|
|
286
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
287
|
+
},
|
|
288
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
289
|
+
],
|
|
290
|
+
},
|
|
291
|
+
{
|
|
292
|
+
value: 'jiangsu',
|
|
293
|
+
label: '江苏',
|
|
294
|
+
children: [
|
|
295
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
296
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
297
|
+
],
|
|
298
|
+
},
|
|
299
|
+
]
|
|
300
|
+
|
|
301
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
302
|
+
|
|
303
|
+
export default () => (
|
|
304
|
+
<div style={cascaderWrapStyle}>
|
|
305
|
+
<Cascader
|
|
306
|
+
style={{ width: '250px' }}
|
|
307
|
+
options={CASCADER_OPTIONS}
|
|
308
|
+
defaultValue={['zhejiang', 'hangzhou', 'xihu']}
|
|
309
|
+
placeholder="请选择"
|
|
310
|
+
/>
|
|
311
|
+
</div>
|
|
312
|
+
)
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### 每级可选
|
|
316
|
+
|
|
317
|
+
`changeOnSelect` 为 `true` 时,选中任意一级即触发 变更事件。
|
|
318
|
+
|
|
319
|
+
```tsx
|
|
320
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
321
|
+
|
|
322
|
+
import { useState } from 'react'
|
|
323
|
+
|
|
324
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
325
|
+
|
|
326
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
327
|
+
{
|
|
328
|
+
value: 'zhejiang',
|
|
329
|
+
label: '浙江',
|
|
330
|
+
children: [
|
|
331
|
+
{
|
|
332
|
+
value: 'hangzhou',
|
|
333
|
+
label: '杭州',
|
|
334
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
335
|
+
},
|
|
336
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
337
|
+
],
|
|
338
|
+
},
|
|
339
|
+
{
|
|
340
|
+
value: 'jiangsu',
|
|
341
|
+
label: '江苏',
|
|
342
|
+
children: [
|
|
343
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
344
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
345
|
+
],
|
|
346
|
+
},
|
|
347
|
+
]
|
|
348
|
+
|
|
349
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
350
|
+
|
|
351
|
+
export default () => {
|
|
352
|
+
const [value, setValue] = useState<(string | number)[]>([])
|
|
353
|
+
|
|
354
|
+
return (
|
|
355
|
+
<div style={cascaderWrapStyle}>
|
|
356
|
+
<Cascader
|
|
357
|
+
style={{ width: '250px' }}
|
|
358
|
+
options={CASCADER_OPTIONS}
|
|
359
|
+
changeOnSelect
|
|
360
|
+
value={value}
|
|
361
|
+
onChange={(v) => setValue(v as (string | number)[])}
|
|
362
|
+
placeholder="每级可选"
|
|
363
|
+
/>
|
|
364
|
+
</div>
|
|
365
|
+
)
|
|
366
|
+
}
|
|
367
|
+
```
|
|
368
|
+
|
|
369
|
+
### 悬停展开
|
|
370
|
+
|
|
371
|
+
`expandTrigger="hover"` 时,鼠标悬停展开子菜单。
|
|
372
|
+
|
|
373
|
+
```tsx
|
|
374
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
375
|
+
|
|
376
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
377
|
+
|
|
378
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
379
|
+
{
|
|
380
|
+
value: 'zhejiang',
|
|
381
|
+
label: '浙江',
|
|
382
|
+
children: [
|
|
383
|
+
{
|
|
384
|
+
value: 'hangzhou',
|
|
385
|
+
label: '杭州',
|
|
386
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
387
|
+
},
|
|
388
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
389
|
+
],
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
value: 'jiangsu',
|
|
393
|
+
label: '江苏',
|
|
394
|
+
children: [
|
|
395
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
396
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
397
|
+
],
|
|
398
|
+
},
|
|
399
|
+
]
|
|
400
|
+
|
|
401
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
402
|
+
|
|
403
|
+
export default () => (
|
|
404
|
+
<div style={cascaderWrapStyle}>
|
|
405
|
+
<Cascader options={CASCADER_OPTIONS} expandTrigger="hover" placeholder="悬停展开" />
|
|
406
|
+
</div>
|
|
407
|
+
)
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
### 多选
|
|
411
|
+
|
|
412
|
+
开启 `multiple` 后,每列显示勾选框,已选项以标签形式展示在输入框内。空值时显示 `placeholder`,清空或删除最后一个标签后恢复;未传时使用当前语言的默认占位文案。
|
|
413
|
+
|
|
414
|
+
```tsx
|
|
415
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
416
|
+
|
|
417
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
418
|
+
|
|
419
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
420
|
+
{
|
|
421
|
+
value: 'zhejiang',
|
|
422
|
+
label: '浙江',
|
|
423
|
+
children: [
|
|
424
|
+
{
|
|
425
|
+
value: 'hangzhou',
|
|
426
|
+
label: '杭州',
|
|
427
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
428
|
+
},
|
|
429
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
430
|
+
],
|
|
431
|
+
},
|
|
432
|
+
{
|
|
433
|
+
value: 'jiangsu',
|
|
434
|
+
label: '江苏',
|
|
435
|
+
children: [
|
|
436
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
437
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
438
|
+
],
|
|
439
|
+
},
|
|
440
|
+
]
|
|
441
|
+
|
|
442
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
443
|
+
|
|
444
|
+
export default () => (
|
|
445
|
+
<div style={cascaderWrapStyle}>
|
|
446
|
+
<Cascader
|
|
447
|
+
style={{ width: '250px' }}
|
|
448
|
+
multiple
|
|
449
|
+
options={CASCADER_OPTIONS}
|
|
450
|
+
defaultValue={[
|
|
451
|
+
['zhejiang', 'hangzhou', 'xihu'],
|
|
452
|
+
['jiangsu', 'nanjing'],
|
|
453
|
+
]}
|
|
454
|
+
placeholder="多选"
|
|
455
|
+
/>
|
|
456
|
+
</div>
|
|
457
|
+
)
|
|
458
|
+
```
|
|
459
|
+
|
|
460
|
+
### 勾选策略
|
|
461
|
+
|
|
462
|
+
多选时通过 `showCheckedStrategy` 控制标签展示父级或子级路径。
|
|
463
|
+
|
|
464
|
+
```tsx
|
|
465
|
+
import { Cascader, Radio } from '@apexhub/apex-ui-react'
|
|
466
|
+
|
|
467
|
+
import { useState } from 'react'
|
|
468
|
+
|
|
469
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
470
|
+
|
|
471
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
472
|
+
{
|
|
473
|
+
value: 'zhejiang',
|
|
474
|
+
label: '浙江',
|
|
475
|
+
children: [
|
|
476
|
+
{
|
|
477
|
+
value: 'hangzhou',
|
|
478
|
+
label: '杭州',
|
|
479
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
480
|
+
},
|
|
481
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
482
|
+
],
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
value: 'jiangsu',
|
|
486
|
+
label: '江苏',
|
|
487
|
+
children: [
|
|
488
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
489
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
490
|
+
],
|
|
491
|
+
},
|
|
492
|
+
]
|
|
493
|
+
|
|
494
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
495
|
+
|
|
496
|
+
export default () => {
|
|
497
|
+
const [strategy, setStrategy] = useState<'SHOW_PARENT' | 'SHOW_CHILD'>('SHOW_PARENT')
|
|
498
|
+
|
|
499
|
+
return (
|
|
500
|
+
<div style={{ ...cascaderWrapStyle, display: 'flex', flexDirection: 'column', gap: 12 }}>
|
|
501
|
+
<Radio.Group
|
|
502
|
+
value={strategy}
|
|
503
|
+
onChange={(event) => setStrategy(event.target.value as 'SHOW_PARENT' | 'SHOW_CHILD')}
|
|
504
|
+
>
|
|
505
|
+
<Radio value="SHOW_PARENT">SHOW_PARENT</Radio>
|
|
506
|
+
<Radio value="SHOW_CHILD">SHOW_CHILD</Radio>
|
|
507
|
+
</Radio.Group>
|
|
508
|
+
<Cascader
|
|
509
|
+
style={{ width: '250px' }}
|
|
510
|
+
multiple
|
|
511
|
+
options={CASCADER_OPTIONS}
|
|
512
|
+
showCheckedStrategy={strategy}
|
|
513
|
+
defaultValue={[['zhejiang', 'hangzhou', 'xihu']]}
|
|
514
|
+
placeholder="策略演示"
|
|
515
|
+
/>
|
|
516
|
+
</div>
|
|
517
|
+
)
|
|
518
|
+
}
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
### 搜索
|
|
522
|
+
|
|
523
|
+
开启 `showSearch` 后,下拉切换为扁平路径列表,支持过滤与高亮匹配。
|
|
524
|
+
|
|
525
|
+
```tsx
|
|
526
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
527
|
+
|
|
528
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
529
|
+
|
|
530
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
531
|
+
{
|
|
532
|
+
value: 'zhejiang',
|
|
533
|
+
label: '浙江',
|
|
534
|
+
children: [
|
|
535
|
+
{
|
|
536
|
+
value: 'hangzhou',
|
|
537
|
+
label: '杭州',
|
|
538
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
539
|
+
},
|
|
540
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
541
|
+
],
|
|
542
|
+
},
|
|
543
|
+
{
|
|
544
|
+
value: 'jiangsu',
|
|
545
|
+
label: '江苏',
|
|
546
|
+
children: [
|
|
547
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
548
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
549
|
+
],
|
|
550
|
+
},
|
|
551
|
+
]
|
|
552
|
+
|
|
553
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
554
|
+
|
|
555
|
+
export default () => (
|
|
556
|
+
<div style={cascaderWrapStyle}>
|
|
557
|
+
<Cascader options={CASCADER_OPTIONS} showSearch placeholder="可搜索" />
|
|
558
|
+
</div>
|
|
559
|
+
)
|
|
560
|
+
```
|
|
561
|
+
|
|
562
|
+
### 懒加载
|
|
563
|
+
|
|
564
|
+
通过 `loadData` 动态加载子级;不可与 `showSearch` 同时开启。
|
|
565
|
+
|
|
566
|
+
```tsx
|
|
567
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
568
|
+
|
|
569
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
570
|
+
|
|
571
|
+
import { useState } from 'react'
|
|
572
|
+
|
|
573
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
574
|
+
{
|
|
575
|
+
value: 'zhejiang',
|
|
576
|
+
label: '浙江',
|
|
577
|
+
children: [
|
|
578
|
+
{
|
|
579
|
+
value: 'hangzhou',
|
|
580
|
+
label: '杭州',
|
|
581
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
582
|
+
},
|
|
583
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
584
|
+
],
|
|
585
|
+
},
|
|
586
|
+
{
|
|
587
|
+
value: 'jiangsu',
|
|
588
|
+
label: '江苏',
|
|
589
|
+
children: [
|
|
590
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
591
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
592
|
+
],
|
|
593
|
+
},
|
|
594
|
+
]
|
|
595
|
+
|
|
596
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
597
|
+
|
|
598
|
+
export default () => {
|
|
599
|
+
const [options, setOptions] = useState<CascaderOption[]>([
|
|
600
|
+
{ value: 'async', label: '异步节点', isLeaf: false },
|
|
601
|
+
])
|
|
602
|
+
|
|
603
|
+
return (
|
|
604
|
+
<div style={cascaderWrapStyle}>
|
|
605
|
+
<Cascader
|
|
606
|
+
options={options}
|
|
607
|
+
loadData={(selected) => {
|
|
608
|
+
const target = selected[selected.length - 1]
|
|
609
|
+
if (target?.value === 'async') {
|
|
610
|
+
setOptions([
|
|
611
|
+
{
|
|
612
|
+
value: 'async',
|
|
613
|
+
label: '异步节点',
|
|
614
|
+
children: [{ value: 'loaded', label: '已加载子节点', isLeaf: true }],
|
|
615
|
+
},
|
|
616
|
+
])
|
|
617
|
+
}
|
|
618
|
+
}}
|
|
619
|
+
placeholder="懒加载"
|
|
620
|
+
/>
|
|
621
|
+
</div>
|
|
622
|
+
)
|
|
623
|
+
}
|
|
624
|
+
```
|
|
625
|
+
|
|
626
|
+
### 字段映射
|
|
627
|
+
|
|
628
|
+
当数据结构字段名不是 `label` / `value` / 子内容 时,用 `fieldNames` 映射。
|
|
629
|
+
|
|
630
|
+
```tsx
|
|
631
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
632
|
+
|
|
633
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
634
|
+
|
|
635
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
636
|
+
{
|
|
637
|
+
value: 'zhejiang',
|
|
638
|
+
label: '浙江',
|
|
639
|
+
children: [
|
|
640
|
+
{
|
|
641
|
+
value: 'hangzhou',
|
|
642
|
+
label: '杭州',
|
|
643
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
644
|
+
},
|
|
645
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
646
|
+
],
|
|
647
|
+
},
|
|
648
|
+
{
|
|
649
|
+
value: 'jiangsu',
|
|
650
|
+
label: '江苏',
|
|
651
|
+
children: [
|
|
652
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
653
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
654
|
+
],
|
|
655
|
+
},
|
|
656
|
+
]
|
|
657
|
+
|
|
658
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
659
|
+
|
|
660
|
+
const options: CascaderOption[] = [
|
|
661
|
+
{
|
|
662
|
+
id: '1',
|
|
663
|
+
value: '1',
|
|
664
|
+
name: '节点 1',
|
|
665
|
+
items: [{ id: '1-1', value: '1-1', name: '子节点 1-1', isLeaf: true }],
|
|
666
|
+
},
|
|
667
|
+
]
|
|
668
|
+
|
|
669
|
+
export default () => (
|
|
670
|
+
<div style={cascaderWrapStyle}>
|
|
671
|
+
<Cascader
|
|
672
|
+
fieldNames={{ label: 'name', value: 'id', children: 'items' }}
|
|
673
|
+
options={options}
|
|
674
|
+
placeholder="字段映射"
|
|
675
|
+
/>
|
|
676
|
+
</div>
|
|
677
|
+
)
|
|
678
|
+
```
|
|
679
|
+
|
|
680
|
+
### 禁用选项
|
|
681
|
+
|
|
682
|
+
在 `options` 中为单项设置 `disabled: true` 禁止选中。
|
|
683
|
+
|
|
684
|
+
```tsx
|
|
685
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
686
|
+
|
|
687
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
688
|
+
|
|
689
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
690
|
+
{
|
|
691
|
+
value: 'zhejiang',
|
|
692
|
+
label: '浙江',
|
|
693
|
+
children: [
|
|
694
|
+
{
|
|
695
|
+
value: 'hangzhou',
|
|
696
|
+
label: '杭州',
|
|
697
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
698
|
+
},
|
|
699
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
700
|
+
],
|
|
701
|
+
},
|
|
702
|
+
{
|
|
703
|
+
value: 'jiangsu',
|
|
704
|
+
label: '江苏',
|
|
705
|
+
children: [
|
|
706
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
707
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
708
|
+
],
|
|
709
|
+
},
|
|
710
|
+
]
|
|
711
|
+
|
|
712
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
713
|
+
|
|
714
|
+
const options: CascaderOption[] = [
|
|
715
|
+
{
|
|
716
|
+
value: 'a',
|
|
717
|
+
label: '可用',
|
|
718
|
+
children: [{ value: 'a1', label: '子节点', isLeaf: true }],
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
value: 'b',
|
|
722
|
+
label: '禁用父级',
|
|
723
|
+
disabled: true,
|
|
724
|
+
children: [{ value: 'b1', label: '子节点', isLeaf: true }],
|
|
725
|
+
},
|
|
726
|
+
]
|
|
727
|
+
|
|
728
|
+
export default () => (
|
|
729
|
+
<div style={cascaderWrapStyle}>
|
|
730
|
+
<Cascader options={options} placeholder="禁用选项" />
|
|
731
|
+
</div>
|
|
732
|
+
)
|
|
733
|
+
```
|
|
734
|
+
|
|
735
|
+
### 自定义渲染
|
|
736
|
+
|
|
737
|
+
通过 `displayRender` 或 `optionRender` 自定义已选路径与下拉项展示。
|
|
738
|
+
|
|
739
|
+
```tsx
|
|
740
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
741
|
+
|
|
742
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
743
|
+
|
|
744
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
745
|
+
{
|
|
746
|
+
value: 'zhejiang',
|
|
747
|
+
label: '浙江',
|
|
748
|
+
children: [
|
|
749
|
+
{
|
|
750
|
+
value: 'hangzhou',
|
|
751
|
+
label: '杭州',
|
|
752
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
753
|
+
},
|
|
754
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
755
|
+
],
|
|
756
|
+
},
|
|
757
|
+
{
|
|
758
|
+
value: 'jiangsu',
|
|
759
|
+
label: '江苏',
|
|
760
|
+
children: [
|
|
761
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
762
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
763
|
+
],
|
|
764
|
+
},
|
|
765
|
+
]
|
|
766
|
+
|
|
767
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
768
|
+
|
|
769
|
+
export default () => (
|
|
770
|
+
<div style={cascaderWrapStyle}>
|
|
771
|
+
<Cascader
|
|
772
|
+
style={{ width: '250px' }}
|
|
773
|
+
options={CASCADER_OPTIONS}
|
|
774
|
+
defaultValue={['zhejiang', 'hangzhou', 'xihu']}
|
|
775
|
+
displayRender={(labels) => <strong>{labels.join(' → ')}</strong>}
|
|
776
|
+
optionRender={(opt) => <em>{opt.label}</em>}
|
|
777
|
+
/>
|
|
778
|
+
</div>
|
|
779
|
+
)
|
|
780
|
+
```
|
|
781
|
+
|
|
782
|
+
### 禁用状态
|
|
783
|
+
|
|
784
|
+
`disabled` 为 true 时整个选择器不可交互。
|
|
785
|
+
|
|
786
|
+
```tsx
|
|
787
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
788
|
+
|
|
789
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
790
|
+
|
|
791
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
792
|
+
{
|
|
793
|
+
value: 'zhejiang',
|
|
794
|
+
label: '浙江',
|
|
795
|
+
children: [
|
|
796
|
+
{
|
|
797
|
+
value: 'hangzhou',
|
|
798
|
+
label: '杭州',
|
|
799
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
800
|
+
},
|
|
801
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
802
|
+
],
|
|
803
|
+
},
|
|
804
|
+
{
|
|
805
|
+
value: 'jiangsu',
|
|
806
|
+
label: '江苏',
|
|
807
|
+
children: [
|
|
808
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
809
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
810
|
+
],
|
|
811
|
+
},
|
|
812
|
+
]
|
|
813
|
+
|
|
814
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
815
|
+
|
|
816
|
+
export default () => (
|
|
817
|
+
<div style={{ ...cascaderWrapStyle, display: 'flex', flexDirection: 'column', gap: 16 }}>
|
|
818
|
+
<Cascader options={CASCADER_OPTIONS} placeholder="正常" />
|
|
819
|
+
<Cascader options={CASCADER_OPTIONS} disabled placeholder="禁用" />
|
|
820
|
+
</div>
|
|
821
|
+
)
|
|
822
|
+
```
|
|
823
|
+
|
|
824
|
+
### 只读
|
|
825
|
+
|
|
826
|
+
`readOnly` 为 true 时仅展示已选值,不可打开下拉、不可清除或修改;与 `disabled` 正交,适合表单预览等场景。
|
|
827
|
+
|
|
828
|
+
```tsx
|
|
829
|
+
import { Cascader } from '@apexhub/apex-ui-react'
|
|
830
|
+
|
|
831
|
+
import type { CascaderOption } from '@apexhub/apex-ui-react'
|
|
832
|
+
|
|
833
|
+
const CASCADER_OPTIONS: CascaderOption[] = [
|
|
834
|
+
{
|
|
835
|
+
value: 'zhejiang',
|
|
836
|
+
label: '浙江',
|
|
837
|
+
children: [
|
|
838
|
+
{
|
|
839
|
+
value: 'hangzhou',
|
|
840
|
+
label: '杭州',
|
|
841
|
+
children: [{ value: 'xihu', label: '西湖', isLeaf: true }],
|
|
842
|
+
},
|
|
843
|
+
{ value: 'ningbo', label: '宁波', isLeaf: true },
|
|
844
|
+
],
|
|
845
|
+
},
|
|
846
|
+
{
|
|
847
|
+
value: 'jiangsu',
|
|
848
|
+
label: '江苏',
|
|
849
|
+
children: [
|
|
850
|
+
{ value: 'nanjing', label: '南京', isLeaf: true },
|
|
851
|
+
{ value: 'suzhou', label: '苏州', isLeaf: true },
|
|
852
|
+
],
|
|
853
|
+
},
|
|
854
|
+
]
|
|
855
|
+
|
|
856
|
+
const cascaderWrapStyle = { width: 280 } as const
|
|
857
|
+
|
|
858
|
+
export default () => (
|
|
859
|
+
<div style={{ ...cascaderWrapStyle, display: 'flex', flexDirection: 'column', gap: 16 }}>
|
|
860
|
+
<Cascader
|
|
861
|
+
options={CASCADER_OPTIONS}
|
|
862
|
+
defaultValue={['zhejiang', 'hangzhou', 'xihu']}
|
|
863
|
+
placeholder="可编辑"
|
|
864
|
+
allowClear
|
|
865
|
+
/>
|
|
866
|
+
<Cascader
|
|
867
|
+
options={CASCADER_OPTIONS}
|
|
868
|
+
defaultValue={['zhejiang', 'hangzhou', 'xihu']}
|
|
869
|
+
readOnly
|
|
870
|
+
placeholder="只读"
|
|
871
|
+
/>
|
|
872
|
+
</div>
|
|
873
|
+
)
|
|
874
|
+
```
|
|
875
|
+
|
|
876
|
+
## DOM 结构
|
|
877
|
+
|
|
878
|
+
源码声明的静态 `data-slot`:`menus`、`column`、`search-list`、`list-item`、`cascader`、`selector`、`input-clear`、`popup`。具体节点随模式和状态出现,不表示固定嵌套顺序。
|
|
879
|
+
|
|
880
|
+
## 样式定制
|
|
881
|
+
|
|
882
|
+
优先使用本组件公开的尺寸、类型和状态属性。换肤与变量覆盖方式见 [主题指南](../../llms-theme.txt)。
|
|
883
|
+
|
|
884
|
+
需要定制具体样式时再读取 [Token 明细](./tokens.txt),其中包含用途、定义值及适用作用域。常规组件使用无需加载该文件。
|
|
885
|
+
|
|
886
|
+
## FAQ
|
|
887
|
+
|
|
888
|
+
### `loadData` 和 `showSearch` 能一起用吗?
|
|
889
|
+
|
|
890
|
+
不能。懒加载与搜索互斥;需搜索时请预先加载完整路径数据,或改用静态 `options`。
|
|
891
|
+
|
|
892
|
+
### 多选时标签为什么有时只显示父级?
|
|
893
|
+
|
|
894
|
+
由 `showCheckedStrategy` 控制:默认 `SHOW_PARENT` 在勾选子节点时合并展示父级标签;设为 `SHOW_CHILD` 则展示完整子路径。
|
|
895
|
+
|
|
896
|
+
### 本组件有 `size` 吗?
|
|
897
|
+
|
|
898
|
+
支持:`small` 为 24px、`medium`(默认)为 28px、`large` 为 32px。表单中 Input / Select 使用 `size="large"` 时,Cascader 同样设置 `size="large"` 即可对齐;多选标签换行时高度自适应。
|