Skip to content

Replace UNSAFE_componentWillReceiveProps with Modern Lifecycle Methods #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: v1
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 46 additions & 33 deletions src/Tour.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,30 +52,43 @@ class Tour extends Component {
}
}

UNSAFE_componentWillReceiveProps(nextProps) {
const { isOpen, update, updateDelay } = this.props
static getDerivedStateFromProps(nextProps, prevState) {
if (!prevState.isOpen && nextProps.isOpen) {
return {
isOpen: true,
current: nextProps.startAt !== undefined ? nextProps.startAt : prevState.current
}
} else if (prevState.isOpen && !nextProps.isOpen) {
return {
isOpen: false
}
}

if (!isOpen && nextProps.isOpen) {
this.open(nextProps.startAt)
} else if (isOpen && !nextProps.isOpen) {
if (prevState.isOpen && nextProps.isOpen && prevState.current !== nextProps.goToStep) {
return {
current: nextProps.goToStep
}
}

return null;
}

componentDidUpdate(prevProps) {
const { isOpen, update, updateDelay, steps, onRequestClose } = this.props;

if (!prevProps.isOpen && isOpen) {
this.open(this.props.startAt)
} else if (prevProps.isOpen && !isOpen) {
this.close()
}

if (isOpen && update !== nextProps.update) {
if (nextProps.steps[this.state.current]) {
if (prevProps.isOpen && isOpen && prevProps.update !== update) {
if (steps[this.state.current]) {
setTimeout(this.showStep, updateDelay)
} else {
this.props.onRequestClose()
onRequestClose()
}
}

if (
isOpen &&
nextProps.isOpen &&
this.state.current !== nextProps.goToStep
) {
this.gotoStep(nextProps.goToStep)
}
}

componentWillUnmount() {
Expand Down Expand Up @@ -209,8 +222,8 @@ class Tour extends Component {
const offset = scrollOffset
? scrollOffset
: attrs.height > h
? -25
: -(h / 2) + attrs.height / 2
? -25
: -(h / 2) + attrs.height / 2
scrollSmooth.to(node, {
context: hx.isBody(parentScroll) ? window : parentScroll,
duration: scrollDuration,
Expand Down Expand Up @@ -466,11 +479,11 @@ class Tour extends Component {
steps[current] &&
(typeof steps[current].content === 'function'
? steps[current].content({
close: onRequestClose,
goTo: this.gotoStep,
inDOM,
step: current + 1,
})
close: onRequestClose,
goTo: this.gotoStep,
inDOM,
step: current + 1,
})
: steps[current].content)
}
>
Expand All @@ -482,11 +495,11 @@ class Tour extends Component {
{steps[current] &&
(typeof steps[current].content === 'function'
? steps[current].content({
close: onRequestClose,
goTo: this.gotoStep,
inDOM,
step: current + 1,
})
close: onRequestClose,
goTo: this.gotoStep,
inDOM,
step: current + 1,
})
: steps[current].content)}
{showNumber && (
<Badge data-tour-elem="badge" accentColor={accentColor}>
Expand Down Expand Up @@ -536,10 +549,10 @@ class Tour extends Component {
current === steps.length - 1
? lastStepNextButton
? onRequestClose
: () => {}
: () => { }
: typeof nextStep === 'function'
? nextStep
: this.nextStep
? nextStep
: this.nextStep
}
disabled={
!lastStepNextButton && current === steps.length - 1
Expand All @@ -549,8 +562,8 @@ class Tour extends Component {
lastStepNextButton && current === steps.length - 1
? lastStepNextButton
: nextButton
? nextButton
: null
? nextButton
: null
}
/>
)}
Expand Down