@fibrae/semi-ui-svelte 0.9.0 → 0.10.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/README.md +8 -4
- package/README.zh-CN.md +8 -4
- package/dist/components/anchor/interface.d.ts +14 -0
- package/dist/components/audio-player/interface.d.ts +5 -0
- package/dist/components/auto-complete/interface.d.ts +29 -0
- package/dist/components/avatar/interface.d.ts +24 -0
- package/dist/components/backtop/interface.d.ts +2 -0
- package/dist/components/badge/interface.d.ts +7 -0
- package/dist/components/banner/interface.d.ts +7 -0
- package/dist/components/breadcrumb/interface.d.ts +10 -0
- package/dist/components/button/interface.d.ts +18 -0
- package/dist/components/calendar/interface.d.ts +16 -0
- package/dist/components/card/interface.d.ts +18 -0
- package/dist/components/carousel/interface.d.ts +16 -0
- package/dist/components/cascader/cascader.svelte +1 -0
- package/dist/components/cascader/interface.d.ts +57 -0
- package/dist/components/checkbox/interface.d.ts +19 -0
- package/dist/components/code-highlight/interface.d.ts +3 -0
- package/dist/components/collapse/interface.d.ts +16 -0
- package/dist/components/collapsible/interface.d.ts +10 -0
- package/dist/components/color-picker/interface.d.ts +10 -0
- package/dist/components/config-provider/interface.d.ts +7 -0
- package/dist/components/cropper/interface.d.ts +11 -0
- package/dist/components/date-picker/interface.d.ts +47 -0
- package/dist/components/descriptions/interface.d.ts +6 -0
- package/dist/components/divider/interface.d.ts +4 -0
- package/dist/components/dropdown/interface.d.ts +8 -0
- package/dist/components/empty/interface.d.ts +7 -0
- package/dist/components/feedback/interface.d.ts +16 -0
- package/dist/components/float-button/interface.d.ts +14 -0
- package/dist/components/form/interface.d.ts +47 -0
- package/dist/components/form/label.svelte +2 -2
- package/dist/components/grid/interface.d.ts +13 -0
- package/dist/components/highlight/interface.d.ts +7 -0
- package/dist/components/hot-keys/interface.d.ts +3 -0
- package/dist/components/image/interface.d.ts +59 -0
- package/dist/components/input/interface.d.ts +67 -0
- package/dist/components/input-number/interface.d.ts +24 -0
- package/dist/components/json-viewer/interface.d.ts +7 -0
- package/dist/components/layout/interface.d.ts +3 -0
- package/dist/components/list/interface.d.ts +18 -0
- package/dist/components/locale/interface.d.ts +4 -0
- package/dist/components/lottie/interface.d.ts +2 -0
- package/dist/components/markdown-render/interface.d.ts +5 -0
- package/dist/components/modal/interface.d.ts +29 -0
- package/dist/components/navigation/interface.d.ts +47 -0
- package/dist/components/overflow-list/interface.d.ts +11 -0
- package/dist/components/pagination/interface.d.ts +12 -0
- package/dist/components/pincode/interface.d.ts +8 -0
- package/dist/components/popconfirm/interface.d.ts +12 -0
- package/dist/components/popover/interface.d.ts +30 -0
- package/dist/components/progress/interface.d.ts +13 -0
- package/dist/components/radio/interface.d.ts +22 -0
- package/dist/components/rating/interface.d.ts +12 -0
- package/dist/components/resizable/interface.d.ts +30 -0
- package/dist/components/scroll-list/interface.d.ts +6 -0
- package/dist/components/select/interface.d.ts +63 -0
- package/dist/components/side-sheet/interface.d.ts +19 -0
- package/dist/components/skeleton/interface.d.ts +7 -0
- package/dist/components/slider/interface.d.ts +23 -0
- package/dist/components/space/interface.d.ts +4 -0
- package/dist/components/spin/interface.d.ts +7 -0
- package/dist/components/steps/interface.d.ts +9 -0
- package/dist/components/switch/interface.d.ts +7 -0
- package/dist/components/table/interface.d.ts +48 -0
- package/dist/components/tabs/interface.d.ts +29 -0
- package/dist/components/tag/interface.d.ts +22 -0
- package/dist/components/tag-input/interface.d.ts +29 -0
- package/dist/components/time-picker/interface.d.ts +31 -0
- package/dist/components/timeline/interface.d.ts +5 -0
- package/dist/components/tooltip/interface.d.ts +20 -0
- package/dist/components/tooltip/tooltip.svelte +3 -0
- package/dist/components/transfer/interface.d.ts +18 -0
- package/dist/components/tree/interface.d.ts +45 -0
- package/dist/components/tree-select/interface.d.ts +55 -0
- package/dist/components/typography/interface.d.ts +33 -0
- package/dist/components/upload/interface.d.ts +64 -0
- package/dist/components/user-guide/interface.d.ts +15 -0
- package/dist/components/video-player/interface.d.ts +22 -0
- package/dist/styles.css +1 -1
- package/docs/advanced/dark-mode.md +288 -0
- package/docs/basic/button.md +605 -0
- package/docs/basic/divider.md +103 -0
- package/docs/basic/float-button.md +246 -0
- package/docs/basic/grid.md +427 -0
- package/docs/basic/layout.md +459 -0
- package/docs/basic/resizable.md +584 -0
- package/docs/basic/space.md +163 -0
- package/docs/basic/tokens.md +425 -0
- package/docs/basic/typography.md +615 -0
- package/docs/changes-from-semi.md +105 -0
- package/docs/ecosystem/tailwind.md +210 -0
- package/docs/experience/accessibility.md +82 -0
- package/docs/experience/content-guidelines.md +819 -0
- package/docs/experience/internationalization.md +7 -0
- package/docs/feedback/banner.md +198 -0
- package/docs/feedback/feedback.md +294 -0
- package/docs/feedback/notification.md +401 -0
- package/docs/feedback/popconfirm.md +243 -0
- package/docs/feedback/progress.md +389 -0
- package/docs/feedback/skeleton.md +388 -0
- package/docs/feedback/spin.md +172 -0
- package/docs/feedback/toast.md +393 -0
- package/docs/input/auto-complete.md +399 -0
- package/docs/input/cascader.md +1558 -0
- package/docs/input/checkbox.md +408 -0
- package/docs/input/color-picker.md +175 -0
- package/docs/input/date-picker.md +942 -0
- package/docs/input/form.md +2550 -0
- package/docs/input/input-number.md +451 -0
- package/docs/input/input.md +640 -0
- package/docs/input/pincode.md +191 -0
- package/docs/input/radio.md +337 -0
- package/docs/input/rating.md +214 -0
- package/docs/input/select.md +1230 -0
- package/docs/input/slider.md +347 -0
- package/docs/input/switch.md +206 -0
- package/docs/input/tag-input.md +465 -0
- package/docs/input/time-picker.md +358 -0
- package/docs/input/transfer.md +1061 -0
- package/docs/input/tree-select.md +1300 -0
- package/docs/input/upload.md +1811 -0
- package/docs/llms.txt +147 -0
- package/docs/navigation/anchor.md +377 -0
- package/docs/navigation/backtop.md +100 -0
- package/docs/navigation/breadcrumb.md +284 -0
- package/docs/navigation/navigation.md +851 -0
- package/docs/navigation/pagination.md +217 -0
- package/docs/navigation/steps.md +315 -0
- package/docs/navigation/tabs.md +754 -0
- package/docs/navigation/tree.md +1956 -0
- package/docs/other/config-provider.md +599 -0
- package/docs/other/locale.md +353 -0
- package/docs/plus/audio-player.md +155 -0
- package/docs/plus/code-highlight.md +150 -0
- package/docs/plus/drag-move.md +214 -0
- package/docs/plus/hot-keys.md +174 -0
- package/docs/plus/json-viewer.md +392 -0
- package/docs/plus/lottie.md +176 -0
- package/docs/plus/markdown-render.md +240 -0
- package/docs/plus/video-player.md +325 -0
- package/docs/show/avatar.md +475 -0
- package/docs/show/badge.md +276 -0
- package/docs/show/calendar.md +352 -0
- package/docs/show/card.md +485 -0
- package/docs/show/carousel.md +592 -0
- package/docs/show/collapse.md +289 -0
- package/docs/show/collapsible.md +216 -0
- package/docs/show/cropper.md +285 -0
- package/docs/show/descriptions.md +325 -0
- package/docs/show/dropdown.md +466 -0
- package/docs/show/empty.md +225 -0
- package/docs/show/highlight.md +144 -0
- package/docs/show/image.md +433 -0
- package/docs/show/list.md +927 -0
- package/docs/show/modal.md +517 -0
- package/docs/show/overflow-list.md +272 -0
- package/docs/show/popover.md +534 -0
- package/docs/show/scroll-list.md +156 -0
- package/docs/show/side-sheet.md +274 -0
- package/docs/show/table.md +5437 -0
- package/docs/show/tag.md +428 -0
- package/docs/show/timeline.md +277 -0
- package/docs/show/tooltip.md +442 -0
- package/docs/show/user-guide.md +419 -0
- package/docs/start/getting-started.md +234 -0
- package/docs/start/introduction.md +57 -0
- package/docs/start/overview.md +21 -0
- package/package.json +5 -4
|
@@ -0,0 +1,272 @@
|
|
|
1
|
+
# OverflowList
|
|
2
|
+
|
|
3
|
+
> OverflowList is a behavior component used to take list of items and display as many items as can fit inside itself. Overflowed items that do not fit are collected and rendered by callback function. The visible items will be recomputed when a resize is detected.
|
|
4
|
+
|
|
5
|
+
Package: `@fibrae/semi-ui-svelte`. Web page: https://semi-design-next.pages.dev/en-US/svelte/show/overflow-list/
|
|
6
|
+
|
|
7
|
+
## Demos
|
|
8
|
+
|
|
9
|
+
### How to import
|
|
10
|
+
|
|
11
|
+
```svelte
|
|
12
|
+
<script lang="ts">
|
|
13
|
+
import { OverflowList } from '@fibrae/semi-ui-svelte';
|
|
14
|
+
</script>
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
### Collapse Mode - Simple
|
|
18
|
+
|
|
19
|
+
You could use `renderMode="collapse"` (default) to render items.
|
|
20
|
+
|
|
21
|
+
`items` holds data, not nodes. Each visible item is rendered by the `item` snippet, with the parameter `{ item, index }`. The overflowing items are rendered by the `overflow` snippet, with the parameter `{ items, position }`; collapse mode renders it once, only when there are overflowing items, and `items` are the ones that do not fit.
|
|
22
|
+
|
|
23
|
+
```svelte
|
|
24
|
+
<script lang="ts">
|
|
25
|
+
import type { Component } from 'svelte';
|
|
26
|
+
import { IconAlarm, IconBookmark, IconCamera, IconDuration, IconEdit, IconFolder } from '@fibrae/semi-icons-svelte';
|
|
27
|
+
import { OverflowList, Slider, Tag } from '@fibrae/semi-ui-svelte';
|
|
28
|
+
|
|
29
|
+
interface Item {
|
|
30
|
+
icon: Component;
|
|
31
|
+
key: string;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
const items: Item[] = [
|
|
35
|
+
{ icon: IconAlarm, key: 'alarm' },
|
|
36
|
+
{ icon: IconBookmark, key: 'bookmark' },
|
|
37
|
+
{ icon: IconCamera, key: 'camera' },
|
|
38
|
+
{ icon: IconDuration, key: 'duration' },
|
|
39
|
+
{ icon: IconEdit, key: 'edit' },
|
|
40
|
+
{ icon: IconFolder, key: 'folder' },
|
|
41
|
+
];
|
|
42
|
+
let width = $state<number | number[]>(100);
|
|
43
|
+
</script>
|
|
44
|
+
|
|
45
|
+
<div>
|
|
46
|
+
<Slider aria-label="Container width" bind:value={width} step={1} />
|
|
47
|
+
<br />
|
|
48
|
+
<br />
|
|
49
|
+
<div style="width: {width}%">
|
|
50
|
+
<OverflowList {items}>
|
|
51
|
+
{#snippet item({ item })}
|
|
52
|
+
<Tag color="blue" style="margin-inline-end: 8px; flex: 0 0 auto">
|
|
53
|
+
<item.icon style="margin-inline-end: 4px" />
|
|
54
|
+
{item.key}
|
|
55
|
+
</Tag>
|
|
56
|
+
{/snippet}
|
|
57
|
+
{#snippet overflow({ items: hidden })}
|
|
58
|
+
{#if hidden.length}
|
|
59
|
+
<Tag style="flex: 0 0 auto; font-variant-numeric: tabular-nums">+{hidden.length}</Tag>
|
|
60
|
+
{/if}
|
|
61
|
+
{/snippet}
|
|
62
|
+
</OverflowList>
|
|
63
|
+
</div>
|
|
64
|
+
</div>
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### Collapse Mode - Direction
|
|
68
|
+
|
|
69
|
+
`collapse` mode supports two `collapseFrom` directions: `start` and `end` (default).
|
|
70
|
+
|
|
71
|
+
```svelte
|
|
72
|
+
<script lang="ts">
|
|
73
|
+
import type { Component } from 'svelte';
|
|
74
|
+
import { IconAlarm, IconBookmark, IconCamera, IconDuration, IconEdit, IconFolder } from '@fibrae/semi-icons-svelte';
|
|
75
|
+
import { OverflowList, Slider, Tag } from '@fibrae/semi-ui-svelte';
|
|
76
|
+
|
|
77
|
+
interface Item {
|
|
78
|
+
icon: Component;
|
|
79
|
+
key: string;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
const items: Item[] = [
|
|
83
|
+
{ icon: IconAlarm, key: 'alarm' },
|
|
84
|
+
{ icon: IconBookmark, key: 'bookmark' },
|
|
85
|
+
{ icon: IconCamera, key: 'camera' },
|
|
86
|
+
{ icon: IconDuration, key: 'duration' },
|
|
87
|
+
{ icon: IconEdit, key: 'edit' },
|
|
88
|
+
{ icon: IconFolder, key: 'folder' },
|
|
89
|
+
];
|
|
90
|
+
let width = $state<number | number[]>(100);
|
|
91
|
+
</script>
|
|
92
|
+
|
|
93
|
+
<div>
|
|
94
|
+
<Slider aria-label="Container width" bind:value={width} step={1} />
|
|
95
|
+
<br />
|
|
96
|
+
<br />
|
|
97
|
+
<div style="width: {width}%">
|
|
98
|
+
<OverflowList collapseFrom="start" {items}>
|
|
99
|
+
{#snippet item({ item })}
|
|
100
|
+
<Tag color="blue" style="margin-inline-end: 8px; flex: 0 0 auto">
|
|
101
|
+
<item.icon style="margin-inline-end: 4px" />
|
|
102
|
+
{item.key}
|
|
103
|
+
</Tag>
|
|
104
|
+
{/snippet}
|
|
105
|
+
{#snippet overflow({ items: hidden })}
|
|
106
|
+
{#if hidden.length}
|
|
107
|
+
<Tag style="margin-inline-end: 8px; flex: 0 0 auto; font-variant-numeric: tabular-nums">+{hidden.length}</Tag>
|
|
108
|
+
{/if}
|
|
109
|
+
{/snippet}
|
|
110
|
+
</OverflowList>
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### Collapse Mode - Visible
|
|
116
|
+
|
|
117
|
+
`collapse` mode supports to set up minimum visible items that will not be collected.
|
|
118
|
+
|
|
119
|
+
```svelte
|
|
120
|
+
<script lang="ts">
|
|
121
|
+
import type { Component } from 'svelte';
|
|
122
|
+
import { IconAlarm, IconBookmark, IconCamera, IconDuration, IconEdit, IconFolder } from '@fibrae/semi-icons-svelte';
|
|
123
|
+
import { OverflowList, Slider, Tag } from '@fibrae/semi-ui-svelte';
|
|
124
|
+
|
|
125
|
+
interface Item {
|
|
126
|
+
icon: Component;
|
|
127
|
+
key: string;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
const items: Item[] = [
|
|
131
|
+
{ icon: IconAlarm, key: 'alarm' },
|
|
132
|
+
{ icon: IconBookmark, key: 'bookmark' },
|
|
133
|
+
{ icon: IconCamera, key: 'camera' },
|
|
134
|
+
{ icon: IconDuration, key: 'duration' },
|
|
135
|
+
{ icon: IconEdit, key: 'edit' },
|
|
136
|
+
{ icon: IconFolder, key: 'folder' },
|
|
137
|
+
];
|
|
138
|
+
let width = $state<number | number[]>(100);
|
|
139
|
+
</script>
|
|
140
|
+
|
|
141
|
+
<div>
|
|
142
|
+
<Slider aria-label="Container width" bind:value={width} step={1} />
|
|
143
|
+
<br />
|
|
144
|
+
<br />
|
|
145
|
+
<div style="width: {width}%">
|
|
146
|
+
<OverflowList {items} minVisibleItems={3}>
|
|
147
|
+
{#snippet item({ item })}
|
|
148
|
+
<Tag color="blue" style="margin-inline-end: 8px; flex: 0 0 auto">
|
|
149
|
+
<item.icon style="margin-inline-end: 4px" />
|
|
150
|
+
{item.key}
|
|
151
|
+
</Tag>
|
|
152
|
+
{/snippet}
|
|
153
|
+
{#snippet overflow({ items: hidden })}
|
|
154
|
+
{#if hidden.length}
|
|
155
|
+
<Tag style="flex: 0 0 auto; font-variant-numeric: tabular-nums">+{hidden.length}</Tag>
|
|
156
|
+
{/if}
|
|
157
|
+
{/snippet}
|
|
158
|
+
</OverflowList>
|
|
159
|
+
</div>
|
|
160
|
+
</div>
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
### Scroll Mode
|
|
164
|
+
|
|
165
|
+
You could use `renderMode="scroll"` for a scrollable list.\
|
|
166
|
+
If you need certain element in the list to scrollIntoView, use ``document.querySelector(`.item-cls[data-scrollkey="${key}"]`` to select to corresponding DOM.
|
|
167
|
+
|
|
168
|
+
In scroll mode `overflow` is rendered once per side, with `position` set to `start` or `end` and `items` the items scrolled out on that side. Each item is wrapped in a `display: contents` span, and `data-scrollkey` is written on, and observed from, the first element the `item` snippet renders, so `item` must output an element or the item is skipped.
|
|
169
|
+
|
|
170
|
+
```svelte
|
|
171
|
+
<script lang="ts">
|
|
172
|
+
import type { Component } from 'svelte';
|
|
173
|
+
import { IconAlarm, IconBookmark, IconCamera, IconDuration, IconEdit, IconFolder } from '@fibrae/semi-icons-svelte';
|
|
174
|
+
import { OverflowList, Slider, Tag } from '@fibrae/semi-ui-svelte';
|
|
175
|
+
|
|
176
|
+
interface Item {
|
|
177
|
+
icon: Component;
|
|
178
|
+
key: string;
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
const items: Item[] = [
|
|
182
|
+
{ icon: IconAlarm, key: 'alarm' },
|
|
183
|
+
{ icon: IconBookmark, key: 'bookmark' },
|
|
184
|
+
{ icon: IconCamera, key: 'camera' },
|
|
185
|
+
{ icon: IconDuration, key: 'duration' },
|
|
186
|
+
{ icon: IconEdit, key: 'edit' },
|
|
187
|
+
{ icon: IconFolder, key: 'folder' },
|
|
188
|
+
];
|
|
189
|
+
let width = $state<number | number[]>(100);
|
|
190
|
+
</script>
|
|
191
|
+
|
|
192
|
+
<div>
|
|
193
|
+
<Slider aria-label="Container width" bind:value={width} step={1} />
|
|
194
|
+
<br />
|
|
195
|
+
<br />
|
|
196
|
+
<div style="width: {width}%">
|
|
197
|
+
<OverflowList {items} renderMode="scroll">
|
|
198
|
+
{#snippet item({ item })}
|
|
199
|
+
<Tag color="blue" style="margin-inline-end: 8px; flex: 0 0 auto">
|
|
200
|
+
<item.icon style="margin-inline-end: 4px" />
|
|
201
|
+
{item.key}
|
|
202
|
+
</Tag>
|
|
203
|
+
{/snippet}
|
|
204
|
+
{#snippet overflow({ items: hidden })}
|
|
205
|
+
<Tag style="margin-inline-end: 8px; margin-inline-start: 8px; flex: 0 0 auto; font-variant-numeric: tabular-nums">+{hidden.length}</Tag>
|
|
206
|
+
{/snippet}
|
|
207
|
+
</OverflowList>
|
|
208
|
+
</div>
|
|
209
|
+
</div>
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
## API Reference
|
|
213
|
+
|
|
214
|
+
**Props**
|
|
215
|
+
|
|
216
|
+
| Property | Description | Type | Default |
|
|
217
|
+
| - | - | - | - |
|
|
218
|
+
| classNames | Class names of the inner parts, keyed by `wrapper` (the scroll wrapper in scroll mode); merged with the built-in classes. | `Partial<Record<OverflowListPart, ClassValue>>` | - |
|
|
219
|
+
| collapseFrom | Collapse direction in collapse mode: start or end. | `'end' \| 'start'` | `"end"` |
|
|
220
|
+
| item | Snippet for the content of one visible item, with the parameter `{ item, index }`: the item and its position in items. Scroll mode needs the snippet to render an element, otherwise the item is skipped. | `Snippet<[OverflowListItemSnippetProps<T>]>` | - |
|
|
221
|
+
| itemKey | Property name of each item's key, or a function returning it. Defaults to the key property, then the item's position in items. | `OverflowListKey \| ((item: T) => OverflowListKey)` | - |
|
|
222
|
+
| items | The items to render. They are data, not nodes; scroll mode requires a key on each item. | `T[]` | - |
|
|
223
|
+
| minVisibleItems | Minimum number of visible items in collapse mode. | `number` | `0` |
|
|
224
|
+
| onIntersect | Called in scroll mode when the intersection state of the items changes. | `(res: Record<string, IntersectionObserverEntry>) => void` | - |
|
|
225
|
+
| onOverflow | Called in collapse mode when the overflowing items change; the argument is an empty array when everything fits. | `(overflowItems: T[]) => void` | - |
|
|
226
|
+
| onVisibleStateChange | Called in scroll mode when the visible or hidden state of the items changes. | `(visibleState: Map<string, boolean>) => void` | - |
|
|
227
|
+
| overflow | Snippet for the overflowing items, with the parameter `{ items, position }`. Collapse mode renders it once, only when there are overflowing items, with the items that do not fit; scroll mode renders it once per side, with position set to start or end and the items scrolled out on that side. | `Snippet<[OverflowListOverflowSnippetProps<T>]>` | - |
|
|
228
|
+
| overflowRenderDirection | Where scroll mode renders the overflow nodes: both, start or end. Used by Tabs, not meant for end users. | `'both' \| 'end' \| 'start'` | `"both"` |
|
|
229
|
+
| renderMode | Render mode: collapse or scroll. | `'collapse' \| 'scroll'` | `"collapse"` |
|
|
230
|
+
| styles | Inline style strings of the inner parts, keyed like `classNames`. | `Partial<Record<OverflowListPart, string>>` | - |
|
|
231
|
+
| threshold | Visible ratio at which scroll mode reports an item as overflowing. | `number` | `0.75` |
|
|
232
|
+
| wrapperProps | Other attributes of the scroll wrapper in scroll mode, such as a role that owns the visible items. | `HTMLAttributes<HTMLDivElement>` | - |
|
|
233
|
+
|
|
234
|
+
`class`, `style` (a string) and native attributes such as `aria-*` land on the root element; pass the class and style of the scroll wrapper with `classNames.wrapper` and `styles.wrapper`, and its other attributes with `wrapperProps`.
|
|
235
|
+
|
|
236
|
+
## Accessibility
|
|
237
|
+
|
|
238
|
+
### ARIA
|
|
239
|
+
|
|
240
|
+
- When `aria-label` or `aria-labelledby` is passed, the root element gets `role="group"` so the group of items has a readable name; without them the root has no role
|
|
241
|
+
|
|
242
|
+
## Changes from Semi Design
|
|
243
|
+
|
|
244
|
+
From the project release notes (written in Chinese). Your knowledge of Semi Design does not cover these.
|
|
245
|
+
|
|
246
|
+
- 破坏性:OverflowList 删除 `wrapperClassName`、`wrapperStyle`,改用 `classNames.wrapper`、`styles.wrapper`,落在滚动容器上。
|
|
247
|
+
- 破坏性:Select 删除 `dropdownClassName`、`dropdownStyle`,改用 `classNames.dropdown`、`styles.dropdown`,落在弹出层元素上。
|
|
248
|
+
- Select 开启 `ellipsisTrigger` 的多选可搜索时,打开后搜索框留在标签所在行、紧跟最后一个标签(原来折叠区占满整行,光标换到下一行),放不下时由标签折叠让出位置。
|
|
249
|
+
- 行为变化:Select、AutoComplete、Cascader、TreeSelect、DatePicker、TimePicker 的触发器与输入框不再处理带 Ctrl、Meta 的按键,以及 Alt 加 ArrowDown、ArrowUp 以外的按键(原来 Ctrl+ArrowDown 会打开、Ctrl+Enter 会选中),这些组合键交给浏览器与系统;Alt+ArrowDown、Alt+ArrowUp 仍作为开合键,Alt+Tab(Safari 的 Option+Tab)与 Tab 一样处理,可搜索模式下 Ctrl+A、Ctrl+C 等编辑快捷键照常工作。
|
|
250
|
+
- 行为变化:Select 打开时按 Tab 关闭下拉,焦点移到触发器之后的可聚焦元素,Shift+Tab 反向;下拉里有可聚焦元素时也不再先进入下拉。焦点已在下拉内时,Tab 同样关闭并移到触发器之后,Shift+Tab 关闭并回到触发器。
|
|
251
|
+
- TreeSelect 关闭时清空搜索值、开启 `insetInput` 的 DatePicker 关闭时恢复触发框可用,改在离场动画结束后执行。
|
|
252
|
+
- 破坏性:`Select.Option`、`Select.OptGroup` 改用静态 `elementType` 识别,删除 `isSelectOption`、`isSelectOptionGroup`;不再读取未声明的 `open`,改用 `defaultOpen`;删除 `getPopupContainer`、`zIndex`、`dropdownMargin`、`rePosKey`、`selectMethod`。
|
|
253
|
+
- 破坏性(类型):`SelectProps`、`Select` 的泛型改为 `<V, Multiple, WithObject>`(React、Vue、Solid):`V` 是选项 value 的类型,约束为 `SelectRawValue`(`string | number | boolean`),优先从 `optionList` 推断(内联选项推断为字面量联合),选项写在子元素或插槽里时由 `value` 推断;`Multiple` 跟随 `multiple`,`WithObject` 跟随 `onChangeWithObject`(Vue 为 `changeWithObject`)。`onChange` 收到 `V | undefined`、`V[]`,对象模式下为 `OptionProps<V>`;`onSelect`、`onDeselect` 收到原始值 `V` 与 `OptionProps<V>`;`value`、`defaultValue` 按 `V` 的基础类型检查。原来用 `SelectProps<Item>` 表示对象模式的改为 `SelectProps<string, undefined, true>`,多选显式写 `Select<V, true>`;删除 `BasicSelectValue`,新增导出 `SelectRawValue`、`SelectChangeValue`。`allowCreate` 配内联字面量选项时,新建的值不在 `V` 里,需显式写 `Select<string>`。`onBlur` 参数为 `React.FocusEvent<HTMLElement> | MouseEvent`。
|
|
254
|
+
- 选项 value 支持布尔值(四个框架),`onChange`、`onSelect` 收到原始的 `true`、`false`。
|
|
255
|
+
- 破坏性(类型):Select 删除 `mouseEnterDelay`、`mouseLeaveDelay`、`TriggerRenderProps.onChange`(改用 `onSearch`),`searchPosition` 收窄为 `'trigger' | 'dropdown'`,`virtualize.itemSize` 必填;`OverflowListProps` 不再包含 `children`,改为泛型 `<T>`,scroll 模式 `overflowRenderer` 为 `(overflowItems: [T[], T[]]) => [ReactNode, ReactNode]`。
|
|
256
|
+
- 破坏性(DOM 结构):带 label 的 OptGroup 的选项包在 `div.semi-select-group-wrapper` 内,依赖选项与标题同级的自定义样式(如分隔线选择器)需调整。
|
|
257
|
+
- 可搜索的 Select、TreeSelect、Cascader 改为 ARIA 1.2 combobox,按 `textbox` 查询触发器内搜索框的测试改为 `combobox`。删除语言包键 `Select.selected`、`Select.createItem`,新增 `Select.clear`;`renderOptionItem` 参数新增 `id`,需写在 `role="option"` 外层元素上。
|
|
258
|
+
- 行为:`onFocus`、`onBlur` 成对触发,焦点在触发器内部移动不触发;点击外部关闭下拉时焦点留在被点击处;键盘按 APG select-only combobox 处理;已选项按 `value` 而非 `label` 识别;回调收到的选项对象不再带内部字段;`dropdownMatchSelectWidth` 跟随触发器的当前宽度,打开期间触发器变宽下拉也随之变宽。OverflowList 新增 `wrapperProps`。
|
|
259
|
+
- 破坏性:选项对象上不再挂 `_show`、`_selected`、`_scrollIndex`、`_parentGroup`、`_keyInJsx`、`_inputCreateOnly`、`_notExist`,这些状态由 foundation 内部的选项记录保存。`renderOptionItem`、`renderSelectedItem`、`filter`、`onChange`(`onChangeWithObject`)、`onSelect`、`onDeselect`、`onCreate`、`onExceed` 与 `triggerRender` 的 `value` 收到的都是用户传入的选项对象本身(同一引用,不再是拷贝),Vue、Svelte 的对应插槽与 snippet 相同。破坏性(类型):React 的 `SelectedItemProps` 删除 `_show`、`_selected`、`_scrollIndex`,Solid 的 `SelectedItemProps` 等同于 `OptionProps`。
|
|
260
|
+
- OverflowList 按项与容器的小数宽度判断溢出:原来按取整后的宽度,Safari 等按小数宽度排版文字时,恰好放得下的项也被折叠,Select `ellipsisTrigger` 少显示标签、`+N` 偏大。
|
|
261
|
+
- 行为变化:Select、AutoComplete、DatePicker、TimePicker 的触发器只在面板打开时设置 `aria-controls`,关闭时不再指向未渲染的 listbox 或面板(四个框架一致)。
|
|
262
|
+
- Svelte:OverflowList 的 `item`、`overflow` 是 snippet,参数为 `{ item, index }` 与 `{ items, position }`;`onOverflow`、`onIntersect`、`onVisibleStateChange` 是回调 prop;`styles` 的值是字符串。
|
|
263
|
+
- Svelte:scroll 模式把每项包在 `display: contents` 的 span 里,在 snippet 渲染出的第一个元素上写 `data-scrollkey` 并观察它,项的 snippet 必须输出元素,否则该项被跳过;collapse 模式只在有溢出项且传了 `overflow` snippet 时渲染 overflow 盒子。
|
|
264
|
+
- Svelte:Select 的选项只来自 `optionList`,不提供 `Select.Option`、`Select.OptGroup`;`value` 可绑定,配 `onChange`;回调与 React 同名(`onChangeWithObject`、`onDropdownVisibleChange`、`onListScroll`、`onSearch`、`onSelect`、`onDeselect`、`onExceed`、`onCreate`、`onClear`、`onFocus`、`onBlur`);`autoFocus` 写作 `autofocus`;保留 `defaultOpen`、`defaultActiveFirstOption`(没有受控的 `open`)。
|
|
265
|
+
- Svelte:`optionList` 条目用 `group: { key, label }` 分组,同组条目须相邻;分组渲染为 `role="group"`(`aria-labelledby` 指向组标题),搜索时没有可见选项的分组整组隐藏,搜索词命中组标题时显示整组;`groupLabel` snippet(参数 `{ group }`)定制组标题。`optionLabel` snippet(参数 `{ option }`)只替换选项行内的文字,选中图标、`role="option"` 与键盘行为不变,内容里不高亮搜索关键字。开启 `virtualize` 时不渲染组标题与 `role="group"`,选项平铺(同其他框架)。
|
|
266
|
+
- Svelte:`prefix`、`suffix`、`insetLabel`、`arrowIcon`、`clearIcon`、`emptyContent`、四个面板插槽,以及 `optionItem`、`createItem`、`selectedItem`、`tag`、`trigger` 都是 snippet;`emptyContent={null}` 隐藏空状态,空 snippet 无法识别,隐藏箭头只能用 `showArrow={false}`;`optionItem` 参数的事件名是 `onclick`、`onmouseenter`,可直接展开到元素上;`trigger` 参数没有 `componentProps`。
|
|
267
|
+
- Svelte:`styles` 的值与选项的 `style` 是字符串;按键先由 Select 处理再调用根元素上的 `onkeydown`,`onclick`、`onfocusin`、`onfocusout` 同样先处理再调用,鼠标移入移出用根元素原生的 `onmouseenter`、`onmouseleave`;不支持泛型 `V`、`Multiple`、`WithObject`,`onChange` 参数类型是 `SelectValue`;对外方法 `open`、`close`、`focus`、`clearInput`、`selectAll`、`deselectAll`、`search`、`rePosition` 经 `bind:this` 调用。
|
|
268
|
+
- `ellipsisTrigger` 加 `maxTagCount` 时,新增选项后的 `+N` 计入宽度造成的隐藏项。React:多选 Tag 的根元素不再带 `disabled` 属性。
|
|
269
|
+
- 多选时焦点从触发器移入 `+N` 浮层不再触发一对 `onBlur`、`onFocus`,焦点离开触发器与浮层后才触发 `onBlur`。`allowCreate` 宽度受限时「创建」提示保持宽度,换行的是输入的文本。
|
|
270
|
+
- 组件内部的控件不再读对应组件的全局默认值(F7):TreeSelect、Cascader 触发器里的 TagInput 不会被加上清除按钮、前后缀、拖拽或失焦建标签;Pagination 的每页条数 Select 与 ColorPicker 的格式 Select 不会变成可搜索、可创建、多选或以对象回调,也不会被加上清除按钮与前后缀。
|
|
271
|
+
- Vue、Solid:回调与插槽参数里的选项对象不再带框架层的 `_slot`(Vue 的分组标题不再带 `_labelSlot`)。已选项的插槽内容按 `value` 从当前选项中取,已选项不在当前选项里(远程搜索换了 `optionList`)时显示它的 `label`。
|
|
272
|
+
- React 破坏性(类型):`select` 深路径导出的 `optionRenderProps` 改名 `OptionRenderProps`、`virtualListProps` 改名 `VirtualizeProps`;包根的 `SelectOptionRenderProps` 不变。
|