Skip to content
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

Add appear timeout #462

Merged
merged 3 commits into from Feb 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/Transition.js
Expand Up @@ -212,7 +212,8 @@ class Transition extends React.Component {
if (timeout != null && typeof timeout !== 'number') {
exit = timeout.exit
enter = timeout.enter
appear = timeout.appear
// TODO: remove fallback for next major
appear = timeout.appear !== undefined ? timeout.appear : enter
dimensi marked this conversation as resolved.
Show resolved Hide resolved
}
return { exit, enter, appear }
}
Expand Down Expand Up @@ -240,7 +241,7 @@ class Transition extends React.Component {
: mounting

const timeouts = this.getTimeouts()

const enterTimeout = appearing ? timeouts.appear : timeouts.enter
// no enter animation skip right to ENTERED
// if we are mounting and running this it means appear _must_ be set
if (!mounting && !enter) {
Expand All @@ -255,8 +256,7 @@ class Transition extends React.Component {
this.safeSetState({ status: ENTERING }, () => {
this.props.onEntering(node, appearing)

// FIXME: appear timeout?
this.onTransitionEnd(node, timeouts.enter, () => {
this.onTransitionEnd(node, enterTimeout, () => {
this.safeSetState({ status: ENTERED }, () => {
this.props.onEntered(node, appearing)
})
Expand Down Expand Up @@ -438,9 +438,12 @@ Transition.propTypes = {
* timeout={{
* enter: 300,
* exit: 500,
* appear: 500,
* }}
* ```
*
* If the value of appear is not set, then the value from enter is taken.
*
* @type {number | { enter?: number, exit?: number }}
*/
timeout: (props, ...args) => {
Expand Down
3 changes: 2 additions & 1 deletion src/utils/PropTypes.js
Expand Up @@ -6,7 +6,8 @@ export const timeoutsShape =
PropTypes.number,
PropTypes.shape({
enter: PropTypes.number,
exit: PropTypes.number
exit: PropTypes.number,
appear: PropTypes.number,
}).isRequired
])
: null;
Expand Down
47 changes: 47 additions & 0 deletions test/Transition-test.js
Expand Up @@ -131,6 +131,53 @@ describe('Transition', () => {
inst.setProps({ in: true })
})

describe('appearing timeout', () => {
it('should use enter timeout if appear not set', done => {
let calledBeforeEntered = false
setTimeout(() => {
calledBeforeEntered = true
}, 10)
const wrapper = mount(
<Transition in={true} timeout={{ enter: 20, exit: 10 }} appear>
<div />
</Transition>
)

wrapper.setProps({
onEntered() {
if (calledBeforeEntered) {
done()
} else {
throw new Error('wrong timeout')
}
},
})
})

it('should use appear timeout if appear is set', done => {
const wrapper = mount(
<Transition in={true} timeout={{ enter: 20, exit: 10, appear: 5 }} appear>
<div />
</Transition>
)

let isCausedLate = false
setTimeout(() => {
isCausedLate = true
}, 15)

wrapper.setProps({
onEntered() {
if (isCausedLate) {
throw new Error('wrong timeout')
} else {
done()
}
}
})
})
})

describe('entering', () => {
let wrapper

Expand Down