-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
Legends.base.tsx
428 lines (405 loc) · 13.8 KB
/
Legends.base.tsx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
import * as React from 'react';
import { IContextualMenuItem } from '@fluentui/react/lib/ContextualMenu';
import { HoverCard, HoverCardType, IExpandingCardProps } from '@fluentui/react/lib/HoverCard';
import { classNamesFunction, find, getNativeProps, buttonProperties } from '@fluentui/react/lib/Utilities';
import { ResizeGroup } from '@fluentui/react/lib/ResizeGroup';
import { IProcessedStyleSet } from '@fluentui/react/lib/Styling';
import { OverflowSet, IOverflowSetItemProps } from '@fluentui/react/lib/OverflowSet';
import { FocusZone, FocusZoneDirection } from '@fluentui/react-focus';
import {
ILegend,
ILegendsProps,
LegendShape,
ILegendsStyles,
ILegendStyleProps,
ILegendOverflowData,
} from './Legends.types';
import { Shape } from './shape';
const getClassNames = classNamesFunction<ILegendStyleProps, ILegendsStyles>();
// This is an internal interface used for rendering the legends with unique key
interface ILegendItem extends React.ButtonHTMLAttributes<HTMLButtonElement> {
name?: string;
title: string;
action: VoidFunction;
hoverAction: VoidFunction;
onMouseOutAction: VoidFunction;
color: string;
shape?: LegendShape;
key: number;
opacity?: number;
stripePattern?: boolean;
isLineLegendInBarChart?: boolean;
}
export interface ILegendState {
selectedLegend: string;
activeLegend: string;
isHoverCardVisible: boolean;
/** Set of legends selected when multiple selection is allowed */
selectedLegends: { [key: string]: boolean };
}
export class LegendsBase extends React.Component<ILegendsProps, ILegendState> {
private _hoverCardRef: HTMLDivElement;
private _classNames: IProcessedStyleSet<ILegendsStyles>;
/** Boolean variable to check if one or more legends are selected */
private _isLegendSelected = false;
public constructor(props: ILegendsProps) {
super(props);
this.state = {
selectedLegend: '',
activeLegend: '',
isHoverCardVisible: false,
selectedLegends: {},
};
}
public render(): JSX.Element {
const { theme, className, styles } = this.props;
this._classNames = getClassNames(styles!, {
theme: theme!,
className,
});
this._isLegendSelected = this.state.selectedLegend !== '' || Object.keys(this.state.selectedLegends).length > 0;
const dataToRender = this._generateData();
return (
<div className={this._classNames.root}>
{this.props.enabledWrapLines ? (
this._onRenderData(dataToRender)
) : (
<ResizeGroup
data={dataToRender}
onReduceData={this._onReduceData}
onRenderData={this._onRenderData}
onGrowData={this._onGrowData}
/>
)}
</div>
);
}
private _generateData(): ILegendOverflowData {
const { allowFocusOnLegends = true } = this.props;
const dataItems: ILegendItem[] = this.props.legends.map((legend: ILegend, index: number) => {
return {
...(allowFocusOnLegends && {
nativeButtonProps: getNativeProps<React.HTMLAttributes<HTMLButtonElement>>(legend, buttonProperties, [
'title',
]),
'aria-setsize': this.props.legends.length,
'aria-posinset': index + 1,
}),
title: legend.title,
action: legend.action!,
hoverAction: legend.hoverAction!,
onMouseOutAction: legend.onMouseOutAction!,
color: legend.color,
shape: legend.shape,
stripePattern: legend.stripePattern,
isLineLegendInBarChart: legend.isLineLegendInBarChart,
opacity: legend.opacity,
key: index,
};
});
const result: ILegendOverflowData = {
primary: dataItems,
overflow: [],
};
return result;
}
private _onRenderData = (data: IOverflowSetItemProps | ILegendOverflowData): JSX.Element => {
const { overflowProps, allowFocusOnLegends = true, canSelectMultipleLegends = false } = this.props;
const rootStyles = {
root: {
justifyContent: this.props.centerLegends ? 'center' : 'unset',
flexWrap: 'wrap',
},
};
return (
<FocusZone
{...(allowFocusOnLegends && {
role: 'listbox',
'aria-label': 'Legends',
'aria-multiselectable': canSelectMultipleLegends,
})}
>
<OverflowSet
items={data.primary}
overflowItems={data.overflow}
onRenderItem={this._renderButton}
onRenderOverflowButton={this._renderOverflowItems}
{...overflowProps}
styles={{ ...rootStyles, ...overflowProps?.styles }}
/>
</FocusZone>
);
};
private _onReduceData = (currentdata: IOverflowSetItemProps): {} | void => {
if (currentdata.primary.length === 0) {
return;
}
const overflow = [...currentdata.primary.slice(-1), ...currentdata.overflow];
const primary = currentdata.primary.slice(0, -1);
return { primary, overflow };
};
private _onGrowData = (currentdata: IOverflowSetItemProps): {} | void => {
if (currentdata.overflow.length === 0) {
return;
}
const overflow = currentdata.overflow.slice(1);
const primary = [...currentdata.primary, ...currentdata.overflow.slice(0, 1)];
return { primary, overflow };
};
/**
* This function will get called when there is an ability to
* select multiple legends
* @param legend ILegend
*/
private _canSelectMultipleLegends = (legend: ILegend): void => {
let selectedLegends = { ...this.state.selectedLegends };
if (selectedLegends[legend.title]) {
// Delete entry for the deselected legend to make
// the number of keys equal to the number of selected legends
delete selectedLegends[legend.title];
} else {
selectedLegends[legend.title] = true;
// Clear set if all legends are selected
if (Object.keys(selectedLegends).length === this.props.legends.length) {
selectedLegends = {};
}
}
this.setState({ selectedLegends });
};
/**
* This function will get called when there is
* ability to select only single legend
* @param legend ILegend
*/
private _canSelectOnlySingleLegend = (legend: ILegend): void => {
if (this.state.selectedLegend === legend.title) {
this.setState({ selectedLegend: '' });
} else {
this.setState({ selectedLegend: legend.title });
}
};
private _onClick = (legend: ILegend): void => {
if (legend.action) {
const { canSelectMultipleLegends = false } = this.props;
if (canSelectMultipleLegends) {
this._canSelectMultipleLegends(legend);
} else {
this._canSelectOnlySingleLegend(legend);
}
legend.action();
}
};
private _onRenderCompactCard = (expandingCard: IExpandingCardProps): JSX.Element => {
const { allowFocusOnLegends = true, className, styles, theme, canSelectMultipleLegends = false } = this.props;
const overflowHoverCardLegends: JSX.Element[] = [];
const classNames = getClassNames(styles!, {
theme: theme!,
className,
});
expandingCard.renderData.forEach((legend: IOverflowSetItemProps, index: number) => {
const hoverCardElement = this._renderButton(legend, index, true);
overflowHoverCardLegends.push(hoverCardElement);
});
const hoverCardData = (
<FocusZone
{...(allowFocusOnLegends && {
role: 'listbox',
'aria-label': 'Legends',
'aria-multiselectable': canSelectMultipleLegends,
})}
direction={FocusZoneDirection.vertical}
{...this.props.focusZonePropsInHoverCard}
className={classNames.hoverCardRoot}
>
{overflowHoverCardLegends}
</FocusZone>
);
return hoverCardData;
};
private _renderOverflowItems = (legends: ILegend[]) => {
const { allowFocusOnLegends = true } = this.props;
const items: IContextualMenuItem[] = [];
legends.forEach((legend: ILegend, i: number) => {
items.push({ key: i.toString(), name: legend.title, onClick: legend.action });
});
const renderOverflowData: IExpandingCardProps = { renderData: legends };
const { theme, className, styles, overflowText } = this.props;
const classNames = getClassNames(styles!, {
theme: theme!,
className,
});
const plainCardProps = {
onRenderPlainCard: this._onRenderCompactCard,
renderData: renderOverflowData,
};
const overflowString = overflowText ? overflowText : 'more';
// execute similar to "_onClick" and "_onLeave" logic at HoverCard onCardHide event
const onHoverCardHideHandler = () => {
this.setState({ isHoverCardVisible: false });
// Unhighlight the focused legend in the hover card
const activeOverflowItem = find(legends, (legend: ILegend) => legend.title === this.state.activeLegend);
if (activeOverflowItem) {
this.setState({ activeLegend: '' });
if (activeOverflowItem.onMouseOutAction) {
activeOverflowItem.onMouseOutAction();
}
}
};
return (
<HoverCard
type={HoverCardType.plain}
plainCardProps={plainCardProps}
instantOpenOnClick={true}
// eslint-disable-next-line react/jsx-no-bind
onCardHide={onHoverCardHideHandler}
setInitialFocus={true}
trapFocus={true}
onCardVisible={this._hoverCardVisible}
styles={classNames.subComponentStyles.hoverCardStyles}
cardDismissDelay={300}
target={this._hoverCardRef}
>
<div
className={classNames.overflowIndicationTextStyle}
ref={(rootElem: HTMLDivElement) => (this._hoverCardRef = rootElem)}
{...(allowFocusOnLegends && {
role: 'button',
'aria-expanded': this.state.isHoverCardVisible,
'aria-label': `${items.length} ${overflowString}`,
})}
data-is-focusable={allowFocusOnLegends}
>
{items.length} {overflowString}
</div>
</HoverCard>
);
};
private _hoverCardVisible = () => {
this.setState({ isHoverCardVisible: true });
};
private _onHoverOverLegend = (legend: ILegend) => {
if (legend.hoverAction) {
this.setState({ activeLegend: legend.title });
legend.hoverAction();
}
};
private _onLeave = (legend: ILegend) => {
if (legend.onMouseOutAction) {
this.setState({ activeLegend: '' });
legend.onMouseOutAction();
}
};
private _renderButton = (data: IOverflowSetItemProps, index?: number, overflow?: boolean) => {
const { allowFocusOnLegends = true } = this.props;
const legend: ILegend = {
title: data.title,
color: data.color,
shape: data.shape,
action: data.action,
hoverAction: data.hoverAction,
onMouseOutAction: data.onMouseOutAction,
stripePattern: data.stripePattern,
isLineLegendInBarChart: data.isLineLegendInBarChart,
opacity: data.opacity,
};
const color = this._getColor(legend.title, legend.color);
const { theme, className, styles, canSelectMultipleLegends = false } = this.props;
const classNames = getClassNames(styles!, {
theme: theme!,
className,
colorOnSelectedState: color,
borderColor: legend.color,
overflow: overflow,
stripePattern: legend.stripePattern,
isLineLegendInBarChart: legend.isLineLegendInBarChart,
opacity: legend.opacity,
});
const onClickHandler = () => {
this._onClick(legend);
};
const onHoverHandler = () => {
this._onHoverOverLegend(legend);
};
const onMouseOut = () => {
this._onLeave(legend);
};
const shape = this._getShape(classNames, legend, color);
return (
<button
{...(allowFocusOnLegends && {
'aria-selected': canSelectMultipleLegends
? !!this.state.selectedLegends[legend.title]
: this.state.selectedLegend === legend.title,
role: 'option',
'aria-label': `${legend.title}`,
'aria-setsize': data['aria-setsize'],
'aria-posinset': data['aria-posinset'],
})}
{...(data.nativeButtonProps && { ...data.nativeButtonProps })}
key={index}
className={classNames.legend}
onClick={onClickHandler}
onMouseOver={onHoverHandler}
onMouseOut={onMouseOut}
onFocus={onHoverHandler}
onBlur={onMouseOut}
data-is-focusable={allowFocusOnLegends}
/* eslint-enable react/jsx-no-bind */
>
{shape}
<div className={classNames.text}>{legend.title}</div>
</button>
);
};
private _getShape(
classNames: IProcessedStyleSet<ILegendsStyles>,
legend: ILegend,
color: string,
): React.ReactNode | string {
const svgParentProps: React.SVGAttributes<SVGElement> = {
className: classNames.shape,
};
const svgChildProps: React.SVGAttributes<SVGElement> = {
fill: color,
strokeWidth: 2,
stroke: legend.color,
};
return (
<Shape
svgProps={svgParentProps}
pathProps={svgChildProps}
shape={legend.shape as LegendShape}
classNameForNonSvg={classNames.rect}
/>
);
}
private _getColor(title: string, color: string): string {
const { theme } = this.props;
const { palette } = theme!;
let legendColor = color;
// if one or more legends are selected
if (this._isLegendSelected) {
// if the given legend (title) is one of the selected legends
if (this.state.selectedLegend === title || this.state.selectedLegends[title]) {
legendColor = color;
}
// if the given legend is unselected
else {
legendColor = palette.white;
}
}
// if no legend is selected
else {
// if the given legend is hovered
// or none of the legends is hovered
if (this.state.activeLegend === title || this.state.activeLegend === '') {
legendColor = color;
}
// if there is a hovered legend but the given legend is not the one
else {
legendColor = palette.white;
}
}
return legendColor;
}
}