@stack-spot/portal-components 2.27.1 → 2.27.2
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/CHANGELOG.md +635 -628
- package/dist/components/AnimatedHeight.d.ts +1 -1
- package/dist/components/AnimatedHeight.js +26 -26
- package/dist/components/AsyncContent.d.ts +1 -1
- package/dist/components/AsyncContent.js +1 -1
- package/dist/components/BannerWarning.d.ts +1 -1
- package/dist/components/BannerWarning.js +1 -1
- package/dist/components/Breadcrumb/index.d.ts +2 -2
- package/dist/components/Breadcrumb/index.js +1 -1
- package/dist/components/Breadcrumb/styled.js +31 -31
- package/dist/components/ButtonLoading.d.ts +1 -1
- package/dist/components/ButtonLoading.js +1 -1
- package/dist/components/ChatBot.d.ts +1 -1
- package/dist/components/ChatBot.js +1 -1
- package/dist/components/ContentValidateFilter.d.ts +1 -1
- package/dist/components/ContentValidateFilter.js +1 -1
- package/dist/components/FadingOverflow.d.ts +1 -1
- package/dist/components/FadingOverflow.js +69 -69
- package/dist/components/FileTreeView/More.d.ts +1 -1
- package/dist/components/FileTreeView/More.js +1 -1
- package/dist/components/FileTreeView/index.d.ts +1 -1
- package/dist/components/FileTreeView/index.js +1 -1
- package/dist/components/InfiniteScroll.d.ts +1 -1
- package/dist/components/InfiniteScroll.js +1 -1
- package/dist/components/InfoMaintenanceBanner.d.ts +1 -1
- package/dist/components/InfoMaintenanceBanner.js +2 -2
- package/dist/components/LazyMarkdown/BlockquoteMd.d.ts +1 -1
- package/dist/components/LazyMarkdown/BlockquoteMd.js +1 -1
- package/dist/components/LazyMarkdown/CodeViewer.d.ts +1 -1
- package/dist/components/LazyMarkdown/CodeViewer.js +76 -76
- package/dist/components/LazyMarkdown/Markdown.d.ts +1 -1
- package/dist/components/LazyMarkdown/Markdown.js +1 -1
- package/dist/components/LazyMarkdown/MarkdownButton.d.ts +1 -1
- package/dist/components/LazyMarkdown/MarkdownButton.js +1 -1
- package/dist/components/LazyMarkdown/Video.d.ts +1 -1
- package/dist/components/LazyMarkdown/Video.js +1 -1
- package/dist/components/LazyMarkdown/index.d.ts +1 -1
- package/dist/components/LazyMarkdown/index.js +1 -1
- package/dist/components/Placeholder.d.ts +7 -3
- package/dist/components/Placeholder.d.ts.map +1 -1
- package/dist/components/Placeholder.js +3 -3
- package/dist/components/Placeholder.js.map +1 -1
- package/dist/components/ScrollView.js +16 -16
- package/dist/components/Select/BadgeItem.d.ts +1 -1
- package/dist/components/Select/BadgeItem.js +1 -1
- package/dist/components/Select/ClearInput.d.ts +1 -1
- package/dist/components/Select/ClearInput.js +1 -1
- package/dist/components/Select/CloseItem.d.ts +1 -1
- package/dist/components/Select/CloseItem.js +1 -1
- package/dist/components/Select/CreatableSelect.js +1 -1
- package/dist/components/Select/CustomMenu.d.ts +1 -1
- package/dist/components/Select/CustomMenu.js +1 -1
- package/dist/components/Select/LabelItem.d.ts +1 -1
- package/dist/components/Select/LabelItem.js +1 -1
- package/dist/components/Select/MultiValue.d.ts +1 -1
- package/dist/components/Select/MultiValue.js +1 -1
- package/dist/components/Select/SelectInfiniteScroll.d.ts +1 -1
- package/dist/components/Select/SelectInfiniteScroll.js +1 -1
- package/dist/components/Select/SelectSearch.d.ts +1 -1
- package/dist/components/Select/SelectSearch.js +1 -1
- package/dist/components/SelectionList.d.ts +1 -1
- package/dist/components/SelectionList.js +61 -61
- package/dist/components/StatusCircle.d.ts +1 -1
- package/dist/components/StatusCircle.js +6 -6
- package/dist/components/Stepper/Navigation.js +4 -4
- package/dist/components/Stepper/Step.js +3 -3
- package/dist/components/Stepper/Stepper.js +6 -6
- package/dist/components/Stepper/headers.js +22 -22
- package/dist/components/Table/HeaderItem.js +1 -1
- package/dist/components/Table/SettingsVerticalMenu.d.ts +1 -1
- package/dist/components/Table/SettingsVerticalMenu.js +1 -1
- package/dist/components/Table/StyledLinkTable.d.ts +1 -1
- package/dist/components/Table/StyledLinkTable.js +5 -5
- package/dist/components/Table/TableData.d.ts +1 -1
- package/dist/components/Table/TableData.js +25 -25
- package/dist/components/TimelineSection.d.ts +1 -1
- package/dist/components/TimelineSection.js +14 -14
- package/dist/components/error/ErrorFeedback.d.ts +1 -1
- package/dist/components/error/ErrorFeedback.js +35 -35
- package/dist/components/error/NotFound.d.ts +1 -1
- package/dist/components/error/NotFound.js +1 -1
- package/dist/components/error/UnderMaintenance.d.ts +1 -1
- package/dist/components/error/UnderMaintenance.js +1 -1
- package/dist/components/form/Form/Form.d.ts +1 -1
- package/dist/components/form/Form/Form.js +1 -1
- package/dist/components/form/Form/FormGroup.d.ts +2 -2
- package/dist/components/form/Form/FormGroup.js +1 -1
- package/dist/components/form/SearchInput.d.ts +1 -1
- package/dist/components/form/SearchInput.js +1 -1
- package/dist/components/form/Select/CustomSelect.d.ts +1 -1
- package/dist/components/form/Select/CustomSelect.js +1 -1
- package/dist/components/form/Select/DetailedSelect.d.ts +1 -1
- package/dist/components/form/Select/DetailedSelect.js +1 -1
- package/dist/components/form/Select/Select.d.ts +1 -1
- package/dist/components/form/Select/Select.js +1 -1
- package/dist/components/form/Select/styled.js +161 -161
- package/dist/components/form/Select/utils.js +1 -1
- package/dist/components/notification/NotificationComponent.d.ts +1 -1
- package/dist/components/notification/NotificationComponent.js +54 -54
- package/dist/components/notification/NotificationItem.d.ts +1 -1
- package/dist/components/notification/NotificationItem.d.ts.map +1 -1
- package/dist/components/notification/NotificationItem.js +8 -2
- package/dist/components/notification/NotificationItem.js.map +1 -1
- package/dist/components/notification/NotificationList.d.ts +1 -1
- package/dist/components/notification/NotificationList.d.ts.map +1 -1
- package/dist/components/notification/NotificationList.js +44 -44
- package/dist/components/notification/NotificationList.js.map +1 -1
- package/dist/components/notification/NotificationPlaceholder.d.ts +1 -1
- package/dist/components/notification/NotificationPlaceholder.d.ts.map +1 -1
- package/dist/components/notification/NotificationPlaceholder.js +2 -2
- package/dist/components/notification/NotificationPlaceholder.js.map +1 -1
- package/dist/containers/NotificationsPage.d.ts +1 -1
- package/dist/containers/NotificationsPage.js +10 -10
- package/dist/context/anchor.d.ts +1 -1
- package/dist/context/anchor.js +1 -1
- package/dist/context/loading.d.ts +1 -1
- package/dist/context/loading.js +1 -1
- package/dist/context/notification/context.d.ts +1 -1
- package/dist/context/notification/context.js +1 -1
- package/dist/hooks/date.js +1 -1
- package/dist/hooks/service-now.js +28 -28
- package/dist/svg/AI.d.ts +1 -1
- package/dist/svg/AI.js +1 -1
- package/dist/svg/CS.d.ts +1 -1
- package/dist/svg/CS.js +1 -1
- package/dist/svg/EDP.d.ts +1 -1
- package/dist/svg/EDP.js +1 -1
- package/dist/svg/Forbidden.d.ts +1 -1
- package/dist/svg/Forbidden.js +1 -1
- package/dist/svg/GenericPlaceholder.d.ts +4 -2
- package/dist/svg/GenericPlaceholder.d.ts.map +1 -1
- package/dist/svg/GenericPlaceholder.js +2 -2
- package/dist/svg/GenericPlaceholder.js.map +1 -1
- package/dist/svg/HUB.d.ts +1 -1
- package/dist/svg/HUB.js +1 -1
- package/dist/svg/Logo.d.ts +1 -1
- package/dist/svg/Logo.js +1 -1
- package/dist/svg/MiniLogo.d.ts +1 -1
- package/dist/svg/MiniLogo.js +1 -1
- package/dist/svg/NotFound.d.ts +1 -1
- package/dist/svg/NotFound.js +1 -1
- package/dist/svg/ServerError.d.ts +1 -1
- package/dist/svg/ServerError.js +1 -1
- package/dist/svg/Unauthenticated.d.ts +1 -1
- package/dist/svg/Unauthenticated.js +1 -1
- package/package.json +80 -80
- package/readme.md +66 -66
- package/src/components/AnimatedHeight.tsx +174 -174
- package/src/components/AsyncContent.tsx +78 -78
- package/src/components/BannerWarning.tsx +91 -91
- package/src/components/Breadcrumb/index.tsx +76 -76
- package/src/components/Breadcrumb/styled.ts +37 -37
- package/src/components/ButtonLoading.tsx +29 -29
- package/src/components/ChatBot.tsx +82 -82
- package/src/components/ContentValidateFilter.tsx +15 -15
- package/src/components/FadingOverflow.tsx +265 -265
- package/src/components/FileTreeView/More.tsx +114 -114
- package/src/components/FileTreeView/index.tsx +186 -186
- package/src/components/InfiniteScroll.tsx +24 -24
- package/src/components/InfoMaintenanceBanner.tsx +29 -29
- package/src/components/LazyMarkdown/BlockquoteMd.tsx +107 -107
- package/src/components/LazyMarkdown/CodeViewer.tsx +161 -161
- package/src/components/LazyMarkdown/Markdown.tsx +122 -122
- package/src/components/LazyMarkdown/MarkdownButton.tsx +24 -24
- package/src/components/LazyMarkdown/Video.tsx +13 -13
- package/src/components/LazyMarkdown/index.tsx +21 -21
- package/src/components/Placeholder.tsx +123 -118
- package/src/components/ScrollView.tsx +57 -57
- package/src/components/Select/BadgeItem.tsx +58 -58
- package/src/components/Select/ClearInput.tsx +24 -24
- package/src/components/Select/CloseItem.tsx +38 -38
- package/src/components/Select/CreatableSelect.tsx +155 -155
- package/src/components/Select/CustomMenu.tsx +16 -16
- package/src/components/Select/LabelItem.tsx +8 -8
- package/src/components/Select/MultiValue.tsx +49 -49
- package/src/components/Select/SelectInfiniteScroll.tsx +82 -82
- package/src/components/Select/SelectSearch.tsx +195 -195
- package/src/components/Select/index.tsx +7 -7
- package/src/components/Select/types.ts +8 -8
- package/src/components/SelectionList.tsx +427 -427
- package/src/components/StatusCircle.tsx +67 -67
- package/src/components/Stepper/Navigation.tsx +97 -97
- package/src/components/Stepper/Step.tsx +30 -30
- package/src/components/Stepper/Stepper.tsx +113 -113
- package/src/components/Stepper/headers.tsx +64 -64
- package/src/components/Stepper/index.ts +3 -3
- package/src/components/Table/HeaderItem.tsx +52 -52
- package/src/components/Table/SettingsVerticalMenu.tsx +50 -50
- package/src/components/Table/StyledLinkTable.tsx +22 -22
- package/src/components/Table/TableData.tsx +251 -251
- package/src/components/Table/index.tsx +2 -2
- package/src/components/TimelineSection.tsx +66 -66
- package/src/components/error/ErrorFeedback.tsx +217 -217
- package/src/components/error/NotFound.tsx +24 -24
- package/src/components/error/UnderMaintenance.tsx +30 -30
- package/src/components/error/index.ts +4 -4
- package/src/components/form/Form/Form.tsx +101 -101
- package/src/components/form/Form/FormGroup.tsx +221 -221
- package/src/components/form/Form/index.ts +2 -2
- package/src/components/form/SearchInput.tsx +69 -69
- package/src/components/form/Select/CustomSelect.tsx +232 -232
- package/src/components/form/Select/DetailedSelect.tsx +85 -85
- package/src/components/form/Select/Select.tsx +67 -67
- package/src/components/form/Select/index.ts +4 -4
- package/src/components/form/Select/styled.ts +165 -165
- package/src/components/form/Select/types.ts +112 -112
- package/src/components/form/Select/utils.tsx +28 -28
- package/src/components/notification/NotificationComponent.tsx +340 -340
- package/src/components/notification/NotificationItem.tsx +345 -337
- package/src/components/notification/NotificationList.tsx +179 -178
- package/src/components/notification/NotificationPlaceholder.tsx +44 -43
- package/src/components/notification/types.ts +72 -72
- package/src/containers/NotificationsPage.tsx +119 -119
- package/src/context/anchor.tsx +37 -37
- package/src/context/loading.tsx +36 -36
- package/src/context/notification/LazyNotificationList.ts +103 -103
- package/src/context/notification/NotificationController.ts +104 -104
- package/src/context/notification/context.tsx +23 -23
- package/src/context/notification/hooks.ts +98 -98
- package/src/context/notification/types.ts +66 -66
- package/src/hooks/date.ts +31 -31
- package/src/hooks/keyboard.tsx +128 -128
- package/src/hooks/manual-render.tsx +10 -10
- package/src/hooks/service-now.tsx +233 -233
- package/src/hooks/text.tsx +30 -30
- package/src/hooks/title.tsx +28 -28
- package/src/hooks/use-effect-once.tsx +43 -43
- package/src/index.ts +19 -19
- package/src/notifications.ts +11 -11
- package/src/svg/AI.tsx +41 -41
- package/src/svg/CS.tsx +48 -48
- package/src/svg/EDP.tsx +31 -31
- package/src/svg/Forbidden.tsx +22 -22
- package/src/svg/GenericPlaceholder.tsx +20 -20
- package/src/svg/HUB.tsx +48 -48
- package/src/svg/Logo.tsx +16 -16
- package/src/svg/MiniLogo.tsx +12 -12
- package/src/svg/NotFound.tsx +16 -16
- package/src/svg/ServerError.tsx +33 -33
- package/src/svg/Unauthenticated.tsx +16 -16
- package/src/svg/index.ts +11 -11
- package/src/utils/accessibility.ts +135 -135
- package/src/utils/cookie.ts +73 -73
- package/src/utils/promise.ts +5 -5
- package/src/utils/read-file.ts +16 -16
- package/tsconfig.json +10 -10
|
@@ -1,427 +1,427 @@
|
|
|
1
|
-
import { Flex, IconBox, Text } from '@citric/core'
|
|
2
|
-
import { ArrowLeft, Check, ChevronRight } from '@citric/icons'
|
|
3
|
-
import { IconButton } from '@citric/ui'
|
|
4
|
-
import { WithStyle, listToClass, theme } from '@stack-spot/portal-theme'
|
|
5
|
-
import { Dictionary, useTranslate } from '@stack-spot/portal-translate'
|
|
6
|
-
import { ReactElement, useCallback, useEffect, useMemo, useState } from 'react'
|
|
7
|
-
import { styled } from 'styled-components'
|
|
8
|
-
import { AnchorComponent, useAnchorTag } from '../context/anchor'
|
|
9
|
-
import { useKeyboardControls } from '../hooks/keyboard'
|
|
10
|
-
|
|
11
|
-
interface CustomLabel {
|
|
12
|
-
/**
|
|
13
|
-
* A unique identifier for this label. This is also used to read this label to screen readers.
|
|
14
|
-
*/
|
|
15
|
-
id: string,
|
|
16
|
-
/**
|
|
17
|
-
* A custom label that can be made up of any React component.
|
|
18
|
-
*/
|
|
19
|
-
element: React.ReactNode,
|
|
20
|
-
}
|
|
21
|
-
|
|
22
|
-
export interface Action {
|
|
23
|
-
/**
|
|
24
|
-
* The label of the action.
|
|
25
|
-
*/
|
|
26
|
-
label: string | CustomLabel,
|
|
27
|
-
/**
|
|
28
|
-
* Function to run on a click.
|
|
29
|
-
*/
|
|
30
|
-
onClick?: (event?: React.MouseEvent) => void,
|
|
31
|
-
/**
|
|
32
|
-
* URL to open on a click.
|
|
33
|
-
*/
|
|
34
|
-
href?: string,
|
|
35
|
-
/**
|
|
36
|
-
* Target of the URL to open.
|
|
37
|
-
*/
|
|
38
|
-
target?: React.AnchorHTMLAttributes<HTMLAnchorElement>['target'],
|
|
39
|
-
/**
|
|
40
|
-
* Language of the linked document.
|
|
41
|
-
*/
|
|
42
|
-
lang?: React.AnchorHTMLAttributes<HTMLAnchorElement>['lang'],
|
|
43
|
-
/**
|
|
44
|
-
* Language of the destination URL.
|
|
45
|
-
*/
|
|
46
|
-
hrefLang?: React.AnchorHTMLAttributes<HTMLAnchorElement>['hrefLang'],
|
|
47
|
-
/**
|
|
48
|
-
* The title of the action.
|
|
49
|
-
*/
|
|
50
|
-
title?: string,
|
|
51
|
-
}
|
|
52
|
-
|
|
53
|
-
interface ItemWithIcon {
|
|
54
|
-
/**
|
|
55
|
-
* An Icon to appear at the left of the item.
|
|
56
|
-
*/
|
|
57
|
-
icon?: React.ReactElement,
|
|
58
|
-
/**
|
|
59
|
-
* An Icon to appear at the right of the item.
|
|
60
|
-
*/
|
|
61
|
-
iconRight?: React.ReactElement,
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
export interface ListAction extends ItemWithIcon, Action {
|
|
65
|
-
/**
|
|
66
|
-
* Whether or not this option is currently active.
|
|
67
|
-
*/
|
|
68
|
-
active?: boolean,
|
|
69
|
-
/**
|
|
70
|
-
* Icon to render when this option is active.
|
|
71
|
-
*/
|
|
72
|
-
iconActive?: React.ReactElement,
|
|
73
|
-
/**
|
|
74
|
-
* A class to be added to this item.
|
|
75
|
-
*/
|
|
76
|
-
className?: string,
|
|
77
|
-
/**
|
|
78
|
-
* Defines the ARIA role of the element for accessibility purposes. Example: "button", "dialog", etc.
|
|
79
|
-
*/
|
|
80
|
-
role?: string,
|
|
81
|
-
}
|
|
82
|
-
|
|
83
|
-
interface ListGroup {
|
|
84
|
-
/**
|
|
85
|
-
* If this group is rendered as a section with its items right below it or a collapsible, which requires a click to open a submenu.
|
|
86
|
-
*/
|
|
87
|
-
type?: 'section' | 'collapsible',
|
|
88
|
-
/**
|
|
89
|
-
* The items of this group.
|
|
90
|
-
*/
|
|
91
|
-
children: ListItem[],
|
|
92
|
-
/**
|
|
93
|
-
* A class to be added to this item.
|
|
94
|
-
*/
|
|
95
|
-
className?: string,
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
interface ListSection extends ListGroup {
|
|
99
|
-
type: 'section',
|
|
100
|
-
/**
|
|
101
|
-
* The section's title.
|
|
102
|
-
*/
|
|
103
|
-
label?: string,
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
interface ListCollapsible extends ListGroup, ItemWithIcon {
|
|
107
|
-
type?: 'collapsible',
|
|
108
|
-
/**
|
|
109
|
-
* The title of the collapsible menu.
|
|
110
|
-
*/
|
|
111
|
-
label: string,
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
type ListItem = ListSection | ListCollapsible | ListAction
|
|
115
|
-
|
|
116
|
-
interface CurrentItemList {
|
|
117
|
-
items: ListItem[],
|
|
118
|
-
label?: string,
|
|
119
|
-
parent?: CurrentItemList,
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
const ANIMATION_DURATION_MS = 300
|
|
123
|
-
const MAX_HEIGHT_TRANSITION = `max-height ease-in ${ANIMATION_DURATION_MS / 1000}s`
|
|
124
|
-
|
|
125
|
-
export interface SelectionListProps extends WithStyle {
|
|
126
|
-
/**
|
|
127
|
-
* The id of this selection list. This is important for accessibility. Be sure to link it to the aria-controls tag of the element who
|
|
128
|
-
* controls the visibility of this selection list.
|
|
129
|
-
*/
|
|
130
|
-
id: string,
|
|
131
|
-
/**
|
|
132
|
-
* Whether or not the selection list is visible.
|
|
133
|
-
*/
|
|
134
|
-
visible?: boolean,
|
|
135
|
-
/**
|
|
136
|
-
* The options in the selection list.
|
|
137
|
-
*/
|
|
138
|
-
items: ListItem[],
|
|
139
|
-
/**
|
|
140
|
-
* Function to run when the selection list is hidden/closed.
|
|
141
|
-
*/
|
|
142
|
-
onHide?: () => void,
|
|
143
|
-
/**
|
|
144
|
-
* The maximum height for the selection list.
|
|
145
|
-
* @default "300px"
|
|
146
|
-
*/
|
|
147
|
-
maxHeight?: string,
|
|
148
|
-
/**
|
|
149
|
-
* A React element to render right before the items.
|
|
150
|
-
*/
|
|
151
|
-
before?: ReactElement,
|
|
152
|
-
/**
|
|
153
|
-
* A React element to render right after the items.
|
|
154
|
-
*/
|
|
155
|
-
after?: ReactElement,
|
|
156
|
-
/**
|
|
157
|
-
* Whether or not this list should be scrollable.
|
|
158
|
-
*/
|
|
159
|
-
scroll?: boolean,
|
|
160
|
-
/**
|
|
161
|
-
* Show list as card
|
|
162
|
-
*/
|
|
163
|
-
showListAsCard?: boolean,
|
|
164
|
-
}
|
|
165
|
-
|
|
166
|
-
interface RenderOptions {
|
|
167
|
-
setCurrent: (current: CurrentItemList) => void,
|
|
168
|
-
controllerId?: string,
|
|
169
|
-
onClose?: () => void,
|
|
170
|
-
Link: AnchorComponent,
|
|
171
|
-
}
|
|
172
|
-
|
|
173
|
-
const SelectionBox = styled.div<{ $maxHeight: string, $scroll?: boolean, $showListAsCard?: boolean }>`
|
|
174
|
-
max-height: 0;
|
|
175
|
-
overflow-y: ${({ $scroll }) => $scroll ? 'auto' : 'hidden'};
|
|
176
|
-
overflow-x: hidden;
|
|
177
|
-
transition: ${MAX_HEIGHT_TRANSITION}, visibility 0s ${ANIMATION_DURATION_MS / 1000}s;
|
|
178
|
-
z-index: 1;
|
|
179
|
-
box-shadow: 4px 4px 48px #000;
|
|
180
|
-
border-radius: 0.5rem;
|
|
181
|
-
visibility: hidden;
|
|
182
|
-
|
|
183
|
-
.selection-list-content {
|
|
184
|
-
display: flex;
|
|
185
|
-
flex-direction: column;
|
|
186
|
-
border-radius: 0.5rem;
|
|
187
|
-
background-color: ${theme.color.light['300']};
|
|
188
|
-
padding-inline: ${({ $showListAsCard }) => $showListAsCard ? '8px' : '0'};
|
|
189
|
-
}
|
|
190
|
-
|
|
191
|
-
.section-title, li > a {
|
|
192
|
-
height: 40px;
|
|
193
|
-
padding: 0 8px;
|
|
194
|
-
display: flex;
|
|
195
|
-
flex-direction: row;
|
|
196
|
-
align-items: center;
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
li > a {
|
|
200
|
-
gap: 4px;
|
|
201
|
-
transition: background-color 0.2s;
|
|
202
|
-
&:hover, &:focus {
|
|
203
|
-
background: ${theme.color.light['400']};
|
|
204
|
-
}
|
|
205
|
-
.label {
|
|
206
|
-
flex: 1;
|
|
207
|
-
white-space: nowrap;
|
|
208
|
-
overflow: hidden;
|
|
209
|
-
text-overflow: ellipsis;
|
|
210
|
-
}
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
li.action {
|
|
214
|
-
background-color: ${({ $showListAsCard }) => $showListAsCard ? theme.color.light['400'] : ''};
|
|
215
|
-
border: ${({ $showListAsCard }) => '1px solid' + $showListAsCard ? theme.color.light['500'] : 'transparent'};
|
|
216
|
-
border-radius: ${({ $showListAsCard }) => $showListAsCard ? '4px' : '0'};
|
|
217
|
-
margin-bottom: ${({ $showListAsCard }) => $showListAsCard ? '8px' : '0'};
|
|
218
|
-
}
|
|
219
|
-
|
|
220
|
-
li.section {
|
|
221
|
-
border-bottom: 2px solid;
|
|
222
|
-
border-bottom-color: ${({ $showListAsCard }) => $showListAsCard ? 'transparent' : theme.color.light['600']};
|
|
223
|
-
&:last-child {
|
|
224
|
-
border-bottom: none;
|
|
225
|
-
}
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
&.visible {
|
|
229
|
-
max-height: ${({ $maxHeight }) => $maxHeight};
|
|
230
|
-
visibility: visible;
|
|
231
|
-
transition: ${MAX_HEIGHT_TRANSITION};
|
|
232
|
-
}
|
|
233
|
-
`
|
|
234
|
-
|
|
235
|
-
function renderAction({
|
|
236
|
-
label, href, onClick, icon, iconRight, active, target, iconActive = <Check />,
|
|
237
|
-
className = '', lang, hrefLang, title, role = 'link',
|
|
238
|
-
}: ListAction, { onClose, Link }: RenderOptions) {
|
|
239
|
-
function handleClick(event: React.MouseEvent) {
|
|
240
|
-
onClick?.(event)
|
|
241
|
-
onClose?.()
|
|
242
|
-
}
|
|
243
|
-
|
|
244
|
-
const isTextLabel = typeof label === 'string'
|
|
245
|
-
|
|
246
|
-
return (
|
|
247
|
-
<li key={isTextLabel ? label : label.id} className="action" title={title}>
|
|
248
|
-
<Link href={href} onClick={handleClick} target={target} tabIndex={0} aria-current={active && 'page'}
|
|
249
|
-
className={className} lang={lang} hrefLang={hrefLang} role={role}>
|
|
250
|
-
{icon && <IconBox>{icon}</IconBox>}
|
|
251
|
-
{isTextLabel ? <Text appearance="body2" className="label">{label}</Text> : label.element}
|
|
252
|
-
{iconRight && <IconBox>{iconRight}</IconBox>}
|
|
253
|
-
{active && <IconBox>{iconActive}</IconBox>}
|
|
254
|
-
</Link>
|
|
255
|
-
</li>
|
|
256
|
-
)
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
function renderCollapsible({ label, icon, iconRight, className = '', children }:
|
|
260
|
-
ListCollapsible, { setCurrent, controllerId, Link }: RenderOptions) {
|
|
261
|
-
function handleClick(ev: React.MouseEvent) {
|
|
262
|
-
//accessibility: this will tell the screen reader the section was expanded before this link is removed from the DOM.
|
|
263
|
-
(ev.target as HTMLElement)?.setAttribute?.('aria-expanded', 'true')
|
|
264
|
-
setCurrent({ items: children, label })
|
|
265
|
-
}
|
|
266
|
-
return (
|
|
267
|
-
<li key={label} className="collapsible">
|
|
268
|
-
<Link onClick={handleClick} tabIndex={0} className={className} aria-expanded={false} aria-controls={controllerId}>
|
|
269
|
-
{icon && <IconBox>{icon}</IconBox>}
|
|
270
|
-
<Text appearance="body2" className="label">{label}</Text>
|
|
271
|
-
{iconRight && <IconBox>{iconRight}</IconBox>}
|
|
272
|
-
<IconBox><ChevronRight /></IconBox>
|
|
273
|
-
</Link>
|
|
274
|
-
</li>
|
|
275
|
-
)
|
|
276
|
-
}
|
|
277
|
-
|
|
278
|
-
function renderSection({ label, className = '', children }: ListSection, options: RenderOptions) {
|
|
279
|
-
return (
|
|
280
|
-
<li key={label ?? children.map(c => c.label).join('-')} className={`${className} section`}>
|
|
281
|
-
{label && <Text appearance="overheader2" colorScheme="light.700" className="section-title">{label}</Text>}
|
|
282
|
-
<ul>{children.map(i => renderItem(i, options))}</ul>
|
|
283
|
-
</li>
|
|
284
|
-
)
|
|
285
|
-
}
|
|
286
|
-
|
|
287
|
-
function renderItem(item: ListItem, options: RenderOptions) {
|
|
288
|
-
if ('children' in item) {
|
|
289
|
-
return item.type === 'section' ? renderSection(item, options) : renderCollapsible(item, options)
|
|
290
|
-
}
|
|
291
|
-
return renderAction(item, options)
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
/**
|
|
295
|
-
* Renders a component that allows the selection of one item. The list is show/hidden according to the prop `visible`.
|
|
296
|
-
*
|
|
297
|
-
* The items in this list can be grouped into multiple sections. Sections may be displayed on a column (section) or might replace the
|
|
298
|
-
* current list of options with another list of options (collapsible).
|
|
299
|
-
*
|
|
300
|
-
* This component implements keyboard controls and accessibility features.
|
|
301
|
-
* @param props the component's props {@link SelectionListProps}.
|
|
302
|
-
*/
|
|
303
|
-
export const SelectionList = ({
|
|
304
|
-
id, items, className, style, visible = true, maxHeight = '300px', onHide, before, after, scroll, showListAsCard,
|
|
305
|
-
}: SelectionListProps) => {
|
|
306
|
-
const Link = useAnchorTag()
|
|
307
|
-
const t = useTranslate(dictionary)
|
|
308
|
-
const [current, setCurrent] = useState<CurrentItemList>({ items })
|
|
309
|
-
const { keyboardControlledElement: wrapper, attachKeyboardListeners, detachKeyboardListeners } = useKeyboardControls(
|
|
310
|
-
{ onPressEscape: onHide, querySelectors: 'li.action a, li.collapsible a, button' },
|
|
311
|
-
)
|
|
312
|
-
|
|
313
|
-
const listItems = useMemo(
|
|
314
|
-
() => current.items.map(i => renderItem(
|
|
315
|
-
i,
|
|
316
|
-
{
|
|
317
|
-
setCurrent: (next: CurrentItemList) => setCurrent({ ...next, parent: current }),
|
|
318
|
-
onClose: onHide,
|
|
319
|
-
controllerId: id,
|
|
320
|
-
Link,
|
|
321
|
-
},
|
|
322
|
-
)),
|
|
323
|
-
[current],
|
|
324
|
-
)
|
|
325
|
-
|
|
326
|
-
useEffect(() => {
|
|
327
|
-
const selectionBox = wrapper.current
|
|
328
|
-
if (!selectionBox) return
|
|
329
|
-
|
|
330
|
-
const handleTransitionEnd = () => {
|
|
331
|
-
selectionBox.style.overflow = 'auto'
|
|
332
|
-
}
|
|
333
|
-
|
|
334
|
-
selectionBox.addEventListener('transitionend', handleTransitionEnd)
|
|
335
|
-
|
|
336
|
-
return () => {
|
|
337
|
-
selectionBox.removeEventListener('transitionend', handleTransitionEnd)
|
|
338
|
-
}
|
|
339
|
-
}, [])
|
|
340
|
-
|
|
341
|
-
const handleExpand = () => {
|
|
342
|
-
const selectionBox = wrapper.current
|
|
343
|
-
if (selectionBox) {
|
|
344
|
-
selectionBox.style.overflow = 'hidden'
|
|
345
|
-
}
|
|
346
|
-
}
|
|
347
|
-
|
|
348
|
-
const hide = useCallback((event: Event) => {
|
|
349
|
-
const target = (event.target as HTMLElement | null)
|
|
350
|
-
// if the element is not in the DOM anymore, we'll consider the click was inside the selection list
|
|
351
|
-
const isClickInsideSelectionList = !target?.isConnected || wrapper.current?.contains(target)
|
|
352
|
-
const isAction = target?.classList?.contains('action') || !!target?.closest('.action')
|
|
353
|
-
const isInsideTour = !!target?.closest('#___reactour')
|
|
354
|
-
if (!isInsideTour && (!isClickInsideSelectionList || isAction)) onHide?.()
|
|
355
|
-
}, [])
|
|
356
|
-
|
|
357
|
-
useEffect(() => {
|
|
358
|
-
handleExpand()
|
|
359
|
-
function removeListeners() {
|
|
360
|
-
detachKeyboardListeners()
|
|
361
|
-
document.removeEventListener('click', hide)
|
|
362
|
-
}
|
|
363
|
-
if (visible) {
|
|
364
|
-
setCurrent({ items })
|
|
365
|
-
attachKeyboardListeners()
|
|
366
|
-
if (onHide) setTimeout(() => document.addEventListener('click', hide), 50)
|
|
367
|
-
} else {
|
|
368
|
-
removeListeners()
|
|
369
|
-
}
|
|
370
|
-
return () => removeListeners()
|
|
371
|
-
}, [visible])
|
|
372
|
-
|
|
373
|
-
return (
|
|
374
|
-
<SelectionBox
|
|
375
|
-
id={id}
|
|
376
|
-
ref={wrapper}
|
|
377
|
-
$maxHeight={maxHeight}
|
|
378
|
-
style={style}
|
|
379
|
-
className={listToClass(['selection-list', visible ? 'visible' : undefined, className])}
|
|
380
|
-
$scroll={scroll}
|
|
381
|
-
aria-hidden={!visible}
|
|
382
|
-
$showListAsCard={showListAsCard}
|
|
383
|
-
>
|
|
384
|
-
<div className="selection-list-content">
|
|
385
|
-
{before}
|
|
386
|
-
{current.parent
|
|
387
|
-
? (
|
|
388
|
-
<Flex mt={5} mb={1} alignItems="center">
|
|
389
|
-
<IconButton
|
|
390
|
-
onClick={(ev) => {
|
|
391
|
-
// accessibility: this will tell the screen reader the section was collapsed before this button is removed from the DOM.
|
|
392
|
-
(ev.target as HTMLElement)?.setAttribute?.('aria-expanded', 'false')
|
|
393
|
-
setCurrent(current.parent ?? { items })
|
|
394
|
-
}}
|
|
395
|
-
sx={{ mr: 3 }}
|
|
396
|
-
title={t.back}
|
|
397
|
-
aria-controls={id}
|
|
398
|
-
aria-expanded={true}
|
|
399
|
-
>
|
|
400
|
-
<ArrowLeft />
|
|
401
|
-
</IconButton>
|
|
402
|
-
<Text appearance="microtext1">{current.label}</Text>
|
|
403
|
-
</Flex>
|
|
404
|
-
)
|
|
405
|
-
: undefined
|
|
406
|
-
}
|
|
407
|
-
<ul>
|
|
408
|
-
{listItems}
|
|
409
|
-
{after &&
|
|
410
|
-
<li className="action">
|
|
411
|
-
{after}
|
|
412
|
-
</li>
|
|
413
|
-
}
|
|
414
|
-
</ul>
|
|
415
|
-
</div>
|
|
416
|
-
</SelectionBox>
|
|
417
|
-
)
|
|
418
|
-
}
|
|
419
|
-
|
|
420
|
-
const dictionary = {
|
|
421
|
-
en: {
|
|
422
|
-
back: 'Go back',
|
|
423
|
-
},
|
|
424
|
-
pt: {
|
|
425
|
-
back: 'Voltar',
|
|
426
|
-
},
|
|
427
|
-
} satisfies Dictionary
|
|
1
|
+
import { Flex, IconBox, Text } from '@citric/core'
|
|
2
|
+
import { ArrowLeft, Check, ChevronRight } from '@citric/icons'
|
|
3
|
+
import { IconButton } from '@citric/ui'
|
|
4
|
+
import { WithStyle, listToClass, theme } from '@stack-spot/portal-theme'
|
|
5
|
+
import { Dictionary, useTranslate } from '@stack-spot/portal-translate'
|
|
6
|
+
import { ReactElement, useCallback, useEffect, useMemo, useState } from 'react'
|
|
7
|
+
import { styled } from 'styled-components'
|
|
8
|
+
import { AnchorComponent, useAnchorTag } from '../context/anchor'
|
|
9
|
+
import { useKeyboardControls } from '../hooks/keyboard'
|
|
10
|
+
|
|
11
|
+
interface CustomLabel {
|
|
12
|
+
/**
|
|
13
|
+
* A unique identifier for this label. This is also used to read this label to screen readers.
|
|
14
|
+
*/
|
|
15
|
+
id: string,
|
|
16
|
+
/**
|
|
17
|
+
* A custom label that can be made up of any React component.
|
|
18
|
+
*/
|
|
19
|
+
element: React.ReactNode,
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export interface Action {
|
|
23
|
+
/**
|
|
24
|
+
* The label of the action.
|
|
25
|
+
*/
|
|
26
|
+
label: string | CustomLabel,
|
|
27
|
+
/**
|
|
28
|
+
* Function to run on a click.
|
|
29
|
+
*/
|
|
30
|
+
onClick?: (event?: React.MouseEvent) => void,
|
|
31
|
+
/**
|
|
32
|
+
* URL to open on a click.
|
|
33
|
+
*/
|
|
34
|
+
href?: string,
|
|
35
|
+
/**
|
|
36
|
+
* Target of the URL to open.
|
|
37
|
+
*/
|
|
38
|
+
target?: React.AnchorHTMLAttributes<HTMLAnchorElement>['target'],
|
|
39
|
+
/**
|
|
40
|
+
* Language of the linked document.
|
|
41
|
+
*/
|
|
42
|
+
lang?: React.AnchorHTMLAttributes<HTMLAnchorElement>['lang'],
|
|
43
|
+
/**
|
|
44
|
+
* Language of the destination URL.
|
|
45
|
+
*/
|
|
46
|
+
hrefLang?: React.AnchorHTMLAttributes<HTMLAnchorElement>['hrefLang'],
|
|
47
|
+
/**
|
|
48
|
+
* The title of the action.
|
|
49
|
+
*/
|
|
50
|
+
title?: string,
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
interface ItemWithIcon {
|
|
54
|
+
/**
|
|
55
|
+
* An Icon to appear at the left of the item.
|
|
56
|
+
*/
|
|
57
|
+
icon?: React.ReactElement,
|
|
58
|
+
/**
|
|
59
|
+
* An Icon to appear at the right of the item.
|
|
60
|
+
*/
|
|
61
|
+
iconRight?: React.ReactElement,
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface ListAction extends ItemWithIcon, Action {
|
|
65
|
+
/**
|
|
66
|
+
* Whether or not this option is currently active.
|
|
67
|
+
*/
|
|
68
|
+
active?: boolean,
|
|
69
|
+
/**
|
|
70
|
+
* Icon to render when this option is active.
|
|
71
|
+
*/
|
|
72
|
+
iconActive?: React.ReactElement,
|
|
73
|
+
/**
|
|
74
|
+
* A class to be added to this item.
|
|
75
|
+
*/
|
|
76
|
+
className?: string,
|
|
77
|
+
/**
|
|
78
|
+
* Defines the ARIA role of the element for accessibility purposes. Example: "button", "dialog", etc.
|
|
79
|
+
*/
|
|
80
|
+
role?: string,
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
interface ListGroup {
|
|
84
|
+
/**
|
|
85
|
+
* If this group is rendered as a section with its items right below it or a collapsible, which requires a click to open a submenu.
|
|
86
|
+
*/
|
|
87
|
+
type?: 'section' | 'collapsible',
|
|
88
|
+
/**
|
|
89
|
+
* The items of this group.
|
|
90
|
+
*/
|
|
91
|
+
children: ListItem[],
|
|
92
|
+
/**
|
|
93
|
+
* A class to be added to this item.
|
|
94
|
+
*/
|
|
95
|
+
className?: string,
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
interface ListSection extends ListGroup {
|
|
99
|
+
type: 'section',
|
|
100
|
+
/**
|
|
101
|
+
* The section's title.
|
|
102
|
+
*/
|
|
103
|
+
label?: string,
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
interface ListCollapsible extends ListGroup, ItemWithIcon {
|
|
107
|
+
type?: 'collapsible',
|
|
108
|
+
/**
|
|
109
|
+
* The title of the collapsible menu.
|
|
110
|
+
*/
|
|
111
|
+
label: string,
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
type ListItem = ListSection | ListCollapsible | ListAction
|
|
115
|
+
|
|
116
|
+
interface CurrentItemList {
|
|
117
|
+
items: ListItem[],
|
|
118
|
+
label?: string,
|
|
119
|
+
parent?: CurrentItemList,
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
const ANIMATION_DURATION_MS = 300
|
|
123
|
+
const MAX_HEIGHT_TRANSITION = `max-height ease-in ${ANIMATION_DURATION_MS / 1000}s`
|
|
124
|
+
|
|
125
|
+
export interface SelectionListProps extends WithStyle {
|
|
126
|
+
/**
|
|
127
|
+
* The id of this selection list. This is important for accessibility. Be sure to link it to the aria-controls tag of the element who
|
|
128
|
+
* controls the visibility of this selection list.
|
|
129
|
+
*/
|
|
130
|
+
id: string,
|
|
131
|
+
/**
|
|
132
|
+
* Whether or not the selection list is visible.
|
|
133
|
+
*/
|
|
134
|
+
visible?: boolean,
|
|
135
|
+
/**
|
|
136
|
+
* The options in the selection list.
|
|
137
|
+
*/
|
|
138
|
+
items: ListItem[],
|
|
139
|
+
/**
|
|
140
|
+
* Function to run when the selection list is hidden/closed.
|
|
141
|
+
*/
|
|
142
|
+
onHide?: () => void,
|
|
143
|
+
/**
|
|
144
|
+
* The maximum height for the selection list.
|
|
145
|
+
* @default "300px"
|
|
146
|
+
*/
|
|
147
|
+
maxHeight?: string,
|
|
148
|
+
/**
|
|
149
|
+
* A React element to render right before the items.
|
|
150
|
+
*/
|
|
151
|
+
before?: ReactElement,
|
|
152
|
+
/**
|
|
153
|
+
* A React element to render right after the items.
|
|
154
|
+
*/
|
|
155
|
+
after?: ReactElement,
|
|
156
|
+
/**
|
|
157
|
+
* Whether or not this list should be scrollable.
|
|
158
|
+
*/
|
|
159
|
+
scroll?: boolean,
|
|
160
|
+
/**
|
|
161
|
+
* Show list as card
|
|
162
|
+
*/
|
|
163
|
+
showListAsCard?: boolean,
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
interface RenderOptions {
|
|
167
|
+
setCurrent: (current: CurrentItemList) => void,
|
|
168
|
+
controllerId?: string,
|
|
169
|
+
onClose?: () => void,
|
|
170
|
+
Link: AnchorComponent,
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
const SelectionBox = styled.div<{ $maxHeight: string, $scroll?: boolean, $showListAsCard?: boolean }>`
|
|
174
|
+
max-height: 0;
|
|
175
|
+
overflow-y: ${({ $scroll }) => $scroll ? 'auto' : 'hidden'};
|
|
176
|
+
overflow-x: hidden;
|
|
177
|
+
transition: ${MAX_HEIGHT_TRANSITION}, visibility 0s ${ANIMATION_DURATION_MS / 1000}s;
|
|
178
|
+
z-index: 1;
|
|
179
|
+
box-shadow: 4px 4px 48px #000;
|
|
180
|
+
border-radius: 0.5rem;
|
|
181
|
+
visibility: hidden;
|
|
182
|
+
|
|
183
|
+
.selection-list-content {
|
|
184
|
+
display: flex;
|
|
185
|
+
flex-direction: column;
|
|
186
|
+
border-radius: 0.5rem;
|
|
187
|
+
background-color: ${theme.color.light['300']};
|
|
188
|
+
padding-inline: ${({ $showListAsCard }) => $showListAsCard ? '8px' : '0'};
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
.section-title, li > a {
|
|
192
|
+
height: 40px;
|
|
193
|
+
padding: 0 8px;
|
|
194
|
+
display: flex;
|
|
195
|
+
flex-direction: row;
|
|
196
|
+
align-items: center;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
li > a {
|
|
200
|
+
gap: 4px;
|
|
201
|
+
transition: background-color 0.2s;
|
|
202
|
+
&:hover, &:focus {
|
|
203
|
+
background: ${theme.color.light['400']};
|
|
204
|
+
}
|
|
205
|
+
.label {
|
|
206
|
+
flex: 1;
|
|
207
|
+
white-space: nowrap;
|
|
208
|
+
overflow: hidden;
|
|
209
|
+
text-overflow: ellipsis;
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
|
|
213
|
+
li.action {
|
|
214
|
+
background-color: ${({ $showListAsCard }) => $showListAsCard ? theme.color.light['400'] : ''};
|
|
215
|
+
border: ${({ $showListAsCard }) => '1px solid' + $showListAsCard ? theme.color.light['500'] : 'transparent'};
|
|
216
|
+
border-radius: ${({ $showListAsCard }) => $showListAsCard ? '4px' : '0'};
|
|
217
|
+
margin-bottom: ${({ $showListAsCard }) => $showListAsCard ? '8px' : '0'};
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
li.section {
|
|
221
|
+
border-bottom: 2px solid;
|
|
222
|
+
border-bottom-color: ${({ $showListAsCard }) => $showListAsCard ? 'transparent' : theme.color.light['600']};
|
|
223
|
+
&:last-child {
|
|
224
|
+
border-bottom: none;
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
&.visible {
|
|
229
|
+
max-height: ${({ $maxHeight }) => $maxHeight};
|
|
230
|
+
visibility: visible;
|
|
231
|
+
transition: ${MAX_HEIGHT_TRANSITION};
|
|
232
|
+
}
|
|
233
|
+
`
|
|
234
|
+
|
|
235
|
+
function renderAction({
|
|
236
|
+
label, href, onClick, icon, iconRight, active, target, iconActive = <Check />,
|
|
237
|
+
className = '', lang, hrefLang, title, role = 'link',
|
|
238
|
+
}: ListAction, { onClose, Link }: RenderOptions) {
|
|
239
|
+
function handleClick(event: React.MouseEvent) {
|
|
240
|
+
onClick?.(event)
|
|
241
|
+
onClose?.()
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
const isTextLabel = typeof label === 'string'
|
|
245
|
+
|
|
246
|
+
return (
|
|
247
|
+
<li key={isTextLabel ? label : label.id} className="action" title={title}>
|
|
248
|
+
<Link href={href} onClick={handleClick} target={target} tabIndex={0} aria-current={active && 'page'}
|
|
249
|
+
className={className} lang={lang} hrefLang={hrefLang} role={role}>
|
|
250
|
+
{icon && <IconBox>{icon}</IconBox>}
|
|
251
|
+
{isTextLabel ? <Text appearance="body2" className="label">{label}</Text> : label.element}
|
|
252
|
+
{iconRight && <IconBox>{iconRight}</IconBox>}
|
|
253
|
+
{active && <IconBox>{iconActive}</IconBox>}
|
|
254
|
+
</Link>
|
|
255
|
+
</li>
|
|
256
|
+
)
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
function renderCollapsible({ label, icon, iconRight, className = '', children }:
|
|
260
|
+
ListCollapsible, { setCurrent, controllerId, Link }: RenderOptions) {
|
|
261
|
+
function handleClick(ev: React.MouseEvent) {
|
|
262
|
+
//accessibility: this will tell the screen reader the section was expanded before this link is removed from the DOM.
|
|
263
|
+
(ev.target as HTMLElement)?.setAttribute?.('aria-expanded', 'true')
|
|
264
|
+
setCurrent({ items: children, label })
|
|
265
|
+
}
|
|
266
|
+
return (
|
|
267
|
+
<li key={label} className="collapsible">
|
|
268
|
+
<Link onClick={handleClick} tabIndex={0} className={className} aria-expanded={false} aria-controls={controllerId}>
|
|
269
|
+
{icon && <IconBox>{icon}</IconBox>}
|
|
270
|
+
<Text appearance="body2" className="label">{label}</Text>
|
|
271
|
+
{iconRight && <IconBox>{iconRight}</IconBox>}
|
|
272
|
+
<IconBox><ChevronRight /></IconBox>
|
|
273
|
+
</Link>
|
|
274
|
+
</li>
|
|
275
|
+
)
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
function renderSection({ label, className = '', children }: ListSection, options: RenderOptions) {
|
|
279
|
+
return (
|
|
280
|
+
<li key={label ?? children.map(c => c.label).join('-')} className={`${className} section`}>
|
|
281
|
+
{label && <Text appearance="overheader2" colorScheme="light.700" className="section-title">{label}</Text>}
|
|
282
|
+
<ul>{children.map(i => renderItem(i, options))}</ul>
|
|
283
|
+
</li>
|
|
284
|
+
)
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
function renderItem(item: ListItem, options: RenderOptions) {
|
|
288
|
+
if ('children' in item) {
|
|
289
|
+
return item.type === 'section' ? renderSection(item, options) : renderCollapsible(item, options)
|
|
290
|
+
}
|
|
291
|
+
return renderAction(item, options)
|
|
292
|
+
}
|
|
293
|
+
|
|
294
|
+
/**
|
|
295
|
+
* Renders a component that allows the selection of one item. The list is show/hidden according to the prop `visible`.
|
|
296
|
+
*
|
|
297
|
+
* The items in this list can be grouped into multiple sections. Sections may be displayed on a column (section) or might replace the
|
|
298
|
+
* current list of options with another list of options (collapsible).
|
|
299
|
+
*
|
|
300
|
+
* This component implements keyboard controls and accessibility features.
|
|
301
|
+
* @param props the component's props {@link SelectionListProps}.
|
|
302
|
+
*/
|
|
303
|
+
export const SelectionList = ({
|
|
304
|
+
id, items, className, style, visible = true, maxHeight = '300px', onHide, before, after, scroll, showListAsCard,
|
|
305
|
+
}: SelectionListProps) => {
|
|
306
|
+
const Link = useAnchorTag()
|
|
307
|
+
const t = useTranslate(dictionary)
|
|
308
|
+
const [current, setCurrent] = useState<CurrentItemList>({ items })
|
|
309
|
+
const { keyboardControlledElement: wrapper, attachKeyboardListeners, detachKeyboardListeners } = useKeyboardControls(
|
|
310
|
+
{ onPressEscape: onHide, querySelectors: 'li.action a, li.collapsible a, button' },
|
|
311
|
+
)
|
|
312
|
+
|
|
313
|
+
const listItems = useMemo(
|
|
314
|
+
() => current.items.map(i => renderItem(
|
|
315
|
+
i,
|
|
316
|
+
{
|
|
317
|
+
setCurrent: (next: CurrentItemList) => setCurrent({ ...next, parent: current }),
|
|
318
|
+
onClose: onHide,
|
|
319
|
+
controllerId: id,
|
|
320
|
+
Link,
|
|
321
|
+
},
|
|
322
|
+
)),
|
|
323
|
+
[current],
|
|
324
|
+
)
|
|
325
|
+
|
|
326
|
+
useEffect(() => {
|
|
327
|
+
const selectionBox = wrapper.current
|
|
328
|
+
if (!selectionBox) return
|
|
329
|
+
|
|
330
|
+
const handleTransitionEnd = () => {
|
|
331
|
+
selectionBox.style.overflow = 'auto'
|
|
332
|
+
}
|
|
333
|
+
|
|
334
|
+
selectionBox.addEventListener('transitionend', handleTransitionEnd)
|
|
335
|
+
|
|
336
|
+
return () => {
|
|
337
|
+
selectionBox.removeEventListener('transitionend', handleTransitionEnd)
|
|
338
|
+
}
|
|
339
|
+
}, [])
|
|
340
|
+
|
|
341
|
+
const handleExpand = () => {
|
|
342
|
+
const selectionBox = wrapper.current
|
|
343
|
+
if (selectionBox) {
|
|
344
|
+
selectionBox.style.overflow = 'hidden'
|
|
345
|
+
}
|
|
346
|
+
}
|
|
347
|
+
|
|
348
|
+
const hide = useCallback((event: Event) => {
|
|
349
|
+
const target = (event.target as HTMLElement | null)
|
|
350
|
+
// if the element is not in the DOM anymore, we'll consider the click was inside the selection list
|
|
351
|
+
const isClickInsideSelectionList = !target?.isConnected || wrapper.current?.contains(target)
|
|
352
|
+
const isAction = target?.classList?.contains('action') || !!target?.closest('.action')
|
|
353
|
+
const isInsideTour = !!target?.closest('#___reactour')
|
|
354
|
+
if (!isInsideTour && (!isClickInsideSelectionList || isAction)) onHide?.()
|
|
355
|
+
}, [])
|
|
356
|
+
|
|
357
|
+
useEffect(() => {
|
|
358
|
+
handleExpand()
|
|
359
|
+
function removeListeners() {
|
|
360
|
+
detachKeyboardListeners()
|
|
361
|
+
document.removeEventListener('click', hide)
|
|
362
|
+
}
|
|
363
|
+
if (visible) {
|
|
364
|
+
setCurrent({ items })
|
|
365
|
+
attachKeyboardListeners()
|
|
366
|
+
if (onHide) setTimeout(() => document.addEventListener('click', hide), 50)
|
|
367
|
+
} else {
|
|
368
|
+
removeListeners()
|
|
369
|
+
}
|
|
370
|
+
return () => removeListeners()
|
|
371
|
+
}, [visible])
|
|
372
|
+
|
|
373
|
+
return (
|
|
374
|
+
<SelectionBox
|
|
375
|
+
id={id}
|
|
376
|
+
ref={wrapper}
|
|
377
|
+
$maxHeight={maxHeight}
|
|
378
|
+
style={style}
|
|
379
|
+
className={listToClass(['selection-list', visible ? 'visible' : undefined, className])}
|
|
380
|
+
$scroll={scroll}
|
|
381
|
+
aria-hidden={!visible}
|
|
382
|
+
$showListAsCard={showListAsCard}
|
|
383
|
+
>
|
|
384
|
+
<div className="selection-list-content">
|
|
385
|
+
{before}
|
|
386
|
+
{current.parent
|
|
387
|
+
? (
|
|
388
|
+
<Flex mt={5} mb={1} alignItems="center">
|
|
389
|
+
<IconButton
|
|
390
|
+
onClick={(ev) => {
|
|
391
|
+
// accessibility: this will tell the screen reader the section was collapsed before this button is removed from the DOM.
|
|
392
|
+
(ev.target as HTMLElement)?.setAttribute?.('aria-expanded', 'false')
|
|
393
|
+
setCurrent(current.parent ?? { items })
|
|
394
|
+
}}
|
|
395
|
+
sx={{ mr: 3 }}
|
|
396
|
+
title={t.back}
|
|
397
|
+
aria-controls={id}
|
|
398
|
+
aria-expanded={true}
|
|
399
|
+
>
|
|
400
|
+
<ArrowLeft />
|
|
401
|
+
</IconButton>
|
|
402
|
+
<Text appearance="microtext1">{current.label}</Text>
|
|
403
|
+
</Flex>
|
|
404
|
+
)
|
|
405
|
+
: undefined
|
|
406
|
+
}
|
|
407
|
+
<ul>
|
|
408
|
+
{listItems}
|
|
409
|
+
{after &&
|
|
410
|
+
<li className="action">
|
|
411
|
+
{after}
|
|
412
|
+
</li>
|
|
413
|
+
}
|
|
414
|
+
</ul>
|
|
415
|
+
</div>
|
|
416
|
+
</SelectionBox>
|
|
417
|
+
)
|
|
418
|
+
}
|
|
419
|
+
|
|
420
|
+
const dictionary = {
|
|
421
|
+
en: {
|
|
422
|
+
back: 'Go back',
|
|
423
|
+
},
|
|
424
|
+
pt: {
|
|
425
|
+
back: 'Voltar',
|
|
426
|
+
},
|
|
427
|
+
} satisfies Dictionary
|