-
Notifications
You must be signed in to change notification settings - Fork 1.8k
/
ProgressIndicator.js
317 lines (278 loc) · 7.44 KB
/
ProgressIndicator.js
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
/**
* Copyright IBM Corp. 2016, 2018
*
* This source code is licensed under the Apache-2.0 license found in the
* LICENSE file in the root directory of this source tree.
*/
import PropTypes from 'prop-types';
import React, { Component } from 'react';
import classnames from 'classnames';
import { settings } from 'carbon-components';
import {
CheckmarkOutline16,
Warning16,
RadioButton16,
CircleFilled16,
} from '@carbon/icons-react';
import { keys, matches } from '../../internal/keyboard';
const { prefix } = settings;
const defaultRenderLabel = (props) => <p {...props} />;
const defaultTranslations = {
'carbon.progress-step.complete': 'Complete',
'carbon.progress-step.incomplete': 'Incomplete',
'carbon.progress-step.current': 'Current',
'carbon.progress-step.invalid': 'Invalid',
};
function translateWithId(messageId) {
return defaultTranslations[messageId];
}
export function ProgressStep({
label,
description,
className,
current,
complete,
invalid,
secondaryLabel,
disabled,
onClick,
renderLabel: ProgressStepLabel,
translateWithId: t,
...rest
}) {
const classes = classnames({
[`${prefix}--progress-step`]: true,
[`${prefix}--progress-step--current`]: current,
[`${prefix}--progress-step--complete`]: complete,
[`${prefix}--progress-step--incomplete`]: !complete && !current,
[`${prefix}--progress-step--disabled`]: disabled,
[className]: className,
});
const handleKeyDown = (e) => {
if (matches(e, [keys.Enter, keys.Space])) {
onClick();
}
};
// eslint-disable-next-line react/prop-types
const SVGIcon = ({ complete, current, description, invalid, prefix }) => {
if (invalid) {
return <Warning16 className={`${prefix}--progress__warning`} />;
}
if (current) {
return (
<CircleFilled16>
<title>{description}</title>
</CircleFilled16>
);
}
if (complete) {
return (
<CheckmarkOutline16>
<title>{description}</title>
</CheckmarkOutline16>
);
}
return (
<RadioButton16>
<title>{description}</title>
</RadioButton16>
);
};
let message = t('carbon.progress-step.incomplete');
if (current) {
message = t('carbon.progress-step.current');
}
if (complete) {
message = t('carbon.progress-step.complete');
}
if (invalid) {
message = t('carbon.progress-step.invalid');
}
return (
<li className={classes}>
<button
type="button"
className={classnames(`${prefix}--progress-step-button`, {
[`${prefix}--progress-step-button--unclickable`]: !onClick || current,
})}
disabled={disabled}
aria-disabled={disabled}
tabIndex={!current && onClick && !disabled ? 0 : -1}
onClick={!current ? onClick : undefined}
onKeyDown={handleKeyDown}
title={label}
{...rest}>
<span className={`${prefix}--assistive-text`}>{message}</span>
<SVGIcon
complete={complete}
current={current}
description={description}
invalid={invalid}
prefix={prefix}
/>
<ProgressStepLabel className={`${prefix}--progress-label`}>
{label}
</ProgressStepLabel>
{secondaryLabel !== null && secondaryLabel !== undefined ? (
<p className={`${prefix}--progress-optional`}>{secondaryLabel}</p>
) : null}
<span className={`${prefix}--progress-line`} />
</button>
</li>
);
}
ProgressStep.propTypes = {
/**
* Provide an optional className to be applied to the containing `<li>` node
*/
className: PropTypes.string,
/**
* Specify whether the step has been completed
*/
complete: PropTypes.bool,
/**
* Specify whether the step is the current step
*/
current: PropTypes.bool,
/**
* Provide a description for the <ProgressStep>
*/
description: PropTypes.string,
/**
* Specify whether the step is disabled
*/
disabled: PropTypes.bool,
/**
* Index of the current step within the ProgressIndicator
*/
index: PropTypes.number,
/**
* Specify whether the step is invalid
*/
invalid: PropTypes.bool,
/**
* Provide the label for the <ProgressStep>
*/
label: PropTypes.node.isRequired,
/**
* A callback called if the step is clicked or the enter key is pressed
*/
onClick: PropTypes.func,
/**
* Provide the props that describe a progress step tooltip
*/
overflowTooltipProps: PropTypes.object,
/*
* An optional parameter to allow for overflow content to be rendered in a
* tooltip.
*/
renderLabel: PropTypes.func,
/**
* Provide an optional secondary label
*/
secondaryLabel: PropTypes.string,
/**
* The ID of the tooltip content.
*/
tooltipId: PropTypes.string,
/**
* Optional method that takes in a message id and returns an
* internationalized string.
*/
translateWithId: PropTypes.func,
};
ProgressStep.defaultProps = {
renderLabel: defaultRenderLabel,
translateWithId,
};
export class ProgressIndicator extends Component {
state = {};
static propTypes = {
/**
* Provide <ProgressStep> components to be rendered in the
* <ProgressIndicator>
*/
children: PropTypes.node,
/**
* Provide an optional className to be applied to the containing node
*/
className: PropTypes.string,
/**
* Optionally specify the current step array index
*/
currentIndex: PropTypes.number,
/**
* Optional callback called if a ProgressStep is clicked on. Returns the index of the step.
*/
onChange: PropTypes.func,
/**
* Specify whether the progress steps should be split equally in size in the div
*/
spaceEqually: PropTypes.bool,
/**
* Determines whether or not the ProgressIndicator should be rendered vertically.
*/
vertical: PropTypes.bool,
};
static defaultProps = {
currentIndex: 0,
};
static getDerivedStateFromProps({ currentIndex }, state) {
const { prevCurrentIndex } = state;
return prevCurrentIndex === currentIndex
? null
: {
currentIndex,
prevCurrentIndex: currentIndex,
};
}
renderSteps = () => {
const { onChange } = this.props;
return React.Children.map(this.props.children, (child, index) => {
// only setup click handlers if onChange event is passed
const onClick = onChange ? () => onChange(index) : undefined;
if (index === this.state.currentIndex) {
return React.cloneElement(child, {
current: true,
index,
onClick,
});
}
if (index < this.state.currentIndex) {
return React.cloneElement(child, {
complete: true,
index,
onClick,
});
}
if (index > this.state.currentIndex) {
return React.cloneElement(child, {
complete: child.props.complete || false,
index,
onClick,
});
}
return null;
});
};
render() {
const {
className,
currentIndex, // eslint-disable-line no-unused-vars
vertical,
spaceEqually,
...other
} = this.props;
const classes = classnames({
[`${prefix}--progress`]: true,
[`${prefix}--progress--vertical`]: vertical,
[`${prefix}--progress--space-equal`]: spaceEqually && !vertical,
[className]: className,
});
return (
<ul className={classes} {...other}>
{this.renderSteps()}
</ul>
);
}
}