Add ability to blacklist onboarding steps

This commit is contained in:
fragosti
2018-05-24 17:10:39 -07:00
parent f0af638874
commit 809ac3340c
3 changed files with 92 additions and 34 deletions

View File

@@ -6,9 +6,11 @@ import { zIndex } from 'ts/utils/style';
export interface OnboardingFlowProps {
steps: Step[];
blacklistedStepIndices: number[];
stepIndex: number;
isRunning: boolean;
onClose: () => void;
setOnboardingStep: (stepIndex: number) => void;
}
const joyrideStyleOptions: StyleOptions = {
@@ -17,16 +19,17 @@ const joyrideStyleOptions: StyleOptions = {
// Wrapper around Joyride with defaults and styles set
export class OnboardingFlow extends React.Component<OnboardingFlowProps> {
private _joyrideRef: React.RefObject<Joyride>;
constructor(props: OnboardingFlowProps) {
super(props);
this._joyrideRef = React.createRef();
public componentDidMount(): void {
this._setOnboardingStepBasedOnBlacklist(this.props.stepIndex);
}
public componentWillReceiveProps(nextProps: OnboardingFlowProps): void {
this._setOnboardingStepBasedOnBlacklist(nextProps.stepIndex);
}
public render(): React.ReactNode {
return (
<Joyride
ref={this._joyrideRef}
run={this.props.isRunning}
debug={true}
steps={this.props.steps}
@@ -37,6 +40,49 @@ export class OnboardingFlow extends React.Component<OnboardingFlowProps> {
);
}
private _setOnboardingStepBasedOnBlacklist(nextIndex: number): void {
const blacklistedSteps = this.props.blacklistedStepIndices;
const newStepIndex = this._adjustedStepBasedOnBlacklist(
this.props.stepIndex,
nextIndex,
this.props.steps.length,
blacklistedSteps,
);
this.props.setOnboardingStep(newStepIndex);
}
private _adjustedStepBasedOnBlacklist(
currentStep: number,
nextStep: number,
totalSteps: number,
blacklistedSteps: number[],
): number {
if (!blacklistedSteps.includes(nextStep)) {
return nextStep;
}
let newStep = nextStep;
const op = nextStep >= currentStep ? _.add : _.subtract;
let didSearch = false;
while (blacklistedSteps.includes(newStep)) {
newStep = op(newStep, 1);
if (newStep < 0) {
if (didSearch) {
break;
}
newStep = totalSteps - 1;
didSearch = true;
}
if (newStep >= totalSteps) {
if (didSearch) {
break;
}
newStep = 0;
didSearch = true;
}
}
return newStep;
}
private _handleChange(data: CallbackData): void {
switch (data.action) {
case 'close':