-
Notifications
You must be signed in to change notification settings - Fork 375
/
Carousel.tsx
280 lines (238 loc) · 9.78 KB
/
Carousel.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
import { IconButton } from "office-ui-fabric-react/lib/Button";
import { initializeIcons } from '@uifabric/icons';
initializeIcons();
import * as React from "react";
import styles from "./Carousel.module.scss";
import { ICarouselProps, ICarouselState, CarouselButtonsDisplay, CarouselButtonsLocation } from ".";
import { css, ICssInput } from "@uifabric/utilities/lib";
import { ProcessingState } from "./ICarouselState";
import { Spinner } from "office-ui-fabric-react/lib/Spinner";
import { isArray } from "@pnp/common";
import * as telemetry from '../../common/telemetry';
export class Carousel extends React.Component<ICarouselProps, ICarouselState> {
constructor(props: ICarouselProps) {
super(props);
const currentIndex = props.startIndex ? props.startIndex : 0;
telemetry.track('ReactCarousel', {});
this.state = {
currentIndex,
processingState: ProcessingState.idle
};
}
/**
* Handles component update lifecycle method.
* @param prevProps
*/
public componentDidUpdate(prevProps: ICarouselProps) {
const currProps = this.props;
const prevPropsElementKey = prevProps.triggerPageEvent && prevProps.element ? (prevProps.element as JSX.Element).key : null;
const nextPropsElementKey = currProps.triggerPageEvent && currProps.element ? (currProps.element as JSX.Element).key : null;
// Checking if component is in processing state and the key of the current element has been changed
if (this.state.processingState === ProcessingState.processing && nextPropsElementKey != null && prevPropsElementKey != nextPropsElementKey) {
this.setState({
processingState: ProcessingState.idle
});
}
}
public render(): React.ReactElement<ICarouselProps> {
const { currentIndex, processingState } = this.state;
const { containerStyles, contentContainerStyles, containerButtonsStyles, prevButtonStyles, nextButtonStyles, loadingComponentContainerStyles } = this.props;
const prevButtonIconName = this.props.prevButtonIconName ? this.props.prevButtonIconName : "ChevronLeft";
const nextButtonIconName = this.props.nextButtonIconName ? this.props.nextButtonIconName : "ChevronRight";
const processing = processingState === ProcessingState.processing;
const prevButtonDisabled = processing || this.isCarouselButtonDisabled(false);
const nextButtonDisabled = processing || this.isCarouselButtonDisabled(true);
const loadingComponent = this.props.loadingComponent ? this.props.loadingComponent : <Spinner />;
const element = this.getElementToDisplay();
return (
<div className={this.getMergedStyles(styles.container, containerStyles)}>
<div className={this.getMergedStyles(this.getButtonContainerStyles(), containerButtonsStyles)}
onClick={() => { if (!prevButtonDisabled) { this.onCarouselButtonClicked(false); } }} >
<IconButton
className={this.getMergedStyles(this.getButtonStyles(false), prevButtonStyles)}
iconProps={{ iconName: prevButtonIconName }}
disabled={prevButtonDisabled}
onClick={() => { this.onCarouselButtonClicked(false); }} />
</div>
<div className={this.getMergedStyles(styles.contentContainer, contentContainerStyles)}>
{
processing &&
<div className={this.getMergedStyles(styles.loadingComponent, loadingComponentContainerStyles)}>
{loadingComponent}
</div>
}
{
!processing && element &&
element
}
</div>
<div className={this.getMergedStyles(this.getButtonContainerStyles(), containerButtonsStyles)}
onClick={() => { if (!nextButtonDisabled) { this.onCarouselButtonClicked(true); } }}>
<IconButton
className={this.getMergedStyles(this.getButtonStyles(true), nextButtonStyles)}
iconProps={{ iconName: nextButtonIconName }}
disabled={nextButtonDisabled}
onClick={() => { this.onCarouselButtonClicked(true); }} />
</div>
</div>
);
}
/**
* Return merged styles for Button containers.
*/
private getButtonContainerStyles(): string {
const buttonsDisplayMode = this.props.buttonsDisplay ? this.props.buttonsDisplay : CarouselButtonsDisplay.block;
let buttonDisplayModeCss = "";
switch (buttonsDisplayMode) {
case CarouselButtonsDisplay.block:
buttonDisplayModeCss = styles.blockButtonsContainer;
break;
case CarouselButtonsDisplay.buttonsOnly:
buttonDisplayModeCss = styles.buttonsOnlyContainer;
break;
case CarouselButtonsDisplay.hidden:
buttonDisplayModeCss = styles.hiddenButtonsContainer;
break;
default:
return "";
}
const buttonsLocation = this.props.buttonsLocation ? this.props.buttonsLocation : CarouselButtonsLocation.top;
let buttonsLocationCss = "";
switch (buttonsLocation) {
case CarouselButtonsLocation.top:
buttonsLocationCss = styles.blockButtonsContainer;
break;
case CarouselButtonsLocation.center:
buttonsLocationCss = styles.centralButtonsContainer;
break;
case CarouselButtonsLocation.bottom:
buttonsLocationCss = styles.bottomButtonsContainer;
break;
default:
return "";
}
const result = css(buttonDisplayModeCss, buttonsLocationCss);
return result;
}
/**
* Return merged styles for Buttons.
* @param nextButton
*/
private getButtonStyles(nextButton: boolean) {
const buttonsDisplayMode = this.props.buttonsDisplay ? this.props.buttonsDisplay : CarouselButtonsDisplay.block;
let result = "";
if (buttonsDisplayMode === CarouselButtonsDisplay.buttonsOnly) {
result = nextButton ? styles.buttonsOnlyNextButton : styles.buttonsOnlyPrevButton;
}
return css(result);
}
/**
* Merges the styles of the components.
*/
private getMergedStyles = (componentStyles: string, userStyles?: ICssInput): string => {
const mergedStyles = userStyles ? css(componentStyles, userStyles) : css(componentStyles);
return mergedStyles;
}
/**
* Determines if the carousel button can be clicked.
*/
private isCarouselButtonDisabled = (nextButton: boolean): boolean => {
// false by default
const isInfinite = this.props.isInfinite != undefined ? this.props.isInfinite : false;
const currentIndex = this.state.currentIndex;
let result = false;
// Use validation from parent control or calcualte it based on the current index
if (nextButton) {
result = this.props.canMoveNext != undefined ?
!this.props.canMoveNext :
(currentIndex === (this.props.element as JSX.Element[]).length - 1) && !isInfinite;
} else {
result = this.props.canMovePrev != undefined ?
!this.props.canMovePrev :
(0 === currentIndex) && !isInfinite;
}
return result;
}
/**
* Handles carousel button click.
*/
private onCarouselButtonClicked = (nextButtonClicked: boolean): void => {
const currentIndex = this.state.currentIndex;
let nextIndex = this.state.currentIndex;
let processingState = ProcessingState.processing;
// Trigger parent control to update provided element
if (this.props.triggerPageEvent) {
// Index validation needs to be done by the parent control specyfing canMove Next|Prev
nextIndex = nextButtonClicked ? (currentIndex + 1) : (currentIndex - 1);
// Trigger parent to provide new data
this.props.triggerPageEvent(nextIndex);
processingState = ProcessingState.processing;
} else {
nextIndex = this.getNextIndex(nextButtonClicked);
const canMoveNext = this.props.canMoveNext != undefined ? this.props.canMoveNext : true;
const canMovePrev = this.props.canMovePrev != undefined ? this.props.canMovePrev : true;
if (canMoveNext && nextButtonClicked && this.props.onMoveNextClicked) {
this.props.onMoveNextClicked(nextIndex);
}
else if (canMovePrev && !nextButtonClicked && this.props.onMovePrevClicked) {
this.props.onMovePrevClicked(nextIndex);
}
processingState = ProcessingState.idle;
}
this.setState({
currentIndex: nextIndex,
processingState
});
}
/**
* Returns next index after carousel button is clicked.
*/
private getNextIndex = (nextButtonClicked: boolean): number => {
const currentIndex = this.state.currentIndex;
let nextIndex = currentIndex;
const isInfinite = this.props.isInfinite !== undefined ? this.props.isInfinite : false;
const length = (this.props.element as JSX.Element[]).length;
// Next Button clicked
if (nextButtonClicked) {
// If there is next element
if (currentIndex < length - 1) {
nextIndex = currentIndex + 1;
}
// In no more elements are available but it isInfiniteLoop -> reset index to the first element
else if (isInfinite) {
nextIndex = 0;
}
}
// Prev Button clicked
else {
if (currentIndex - 1 >= 0) {
// If there is previous element
nextIndex = currentIndex - 1;
} else if (isInfinite) {
// If there is no previous element but isInfitineLoop -> reset index to the last element
nextIndex = length - 1;
}
}
return nextIndex;
}
/**
* Returns current element to be displayed.
*/
private getElementToDisplay = (): JSX.Element => {
const { element } = this.props;
const currentIndex = this.state.currentIndex;
let result : JSX.Element = null;
// If no element has been provided.
if (!element) {
result = null;
}
// Retrieve proper element from the array
else if (isArray(element) && currentIndex >= 0 && (element as JSX.Element[]).length > currentIndex) {
result = element[currentIndex];
}
else {
result = element as JSX.Element;
}
return result;
}
}