File size: 4,506 Bytes
1e92f2d |
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 |
import * as React from 'react'
import { render, RenderResult } from '@testing-library/react'
import { is } from '@react-spring/shared'
import { Lookup } from '@react-spring/types'
import { SpringContextProvider, type ISpringContext } from '../SpringContext'
import { SpringValue } from '../SpringValue'
import { SpringRef } from '../SpringRef'
import { useSpring } from './useSpring'
describe('useSpring', () => {
let springs: Lookup<SpringValue>
let ref: SpringRef
// Call the "useSpring" hook and update local variables.
const [update, context] = createUpdater(({ args }) => {
const result = useSpring(...args)
if (is.fun(args[0]) || args.length == 2) {
springs = result[0] as any
ref = result[1]
} else {
springs = result as any
ref = undefined as any
}
return null
})
describe('when only a props object is passed', () => {
it('is updated every render', () => {
update({ x: 0 })
expect(springs.x.goal).toBe(0)
update({ x: 1 })
expect(springs.x.goal).toBe(1)
})
it('does not return a ref', () => {
update({ x: 0 })
expect(ref).toBeUndefined()
})
describe('when SpringContext has "pause={false}"', () => {
it('stays paused if last rendered with "pause: true"', () => {
const props = { from: { t: 0 }, to: { t: 1 } }
// Paused by context.
context.set({ pause: true })
update({ ...props, pause: false })
expect(springs.t.isPaused).toBeTruthy()
// Paused by props and context.
update({ ...props, pause: true })
expect(springs.t.isPaused).toBeTruthy()
// Paused by props.
context.set({ pause: false })
expect(springs.t.isPaused).toBeTruthy()
// Resumed.
update({ ...props, pause: false })
expect(springs.t.isPaused).toBeFalsy()
})
})
})
describe('when both a props object and a deps array are passed', () => {
it('is updated only when a dependency changes', () => {
update({ x: 0 }, [1])
expect(springs.x.goal).toBe(0)
update({ x: 1 }, [1])
expect(springs.x.goal).toBe(0)
update({ x: 1 }, [2])
expect(springs.x.goal).toBe(1)
})
it('returns a ref', () => {
update({ x: 0 }, [1])
testIsRef(ref)
})
})
describe('when only a props function is passed', () => {
it('is never updated on render', () => {
update(() => ({ x: 0 }))
expect(springs.x.goal).toBe(0)
update(() => ({ x: 1 }))
expect(springs.x.goal).toBe(0)
})
it('returns a ref', () => {
update(() => ({ x: 0 }))
testIsRef(ref)
})
})
describe('when both a props function and a deps array are passed', () => {
it('is updated when a dependency changes', () => {
update(() => ({ x: 0 }), [1])
expect(springs.x.goal).toBe(0)
update(() => ({ x: 1 }), [1])
expect(springs.x.goal).toBe(0)
update(() => ({ x: 1 }), [2])
expect(springs.x.goal).toBe(1)
})
it('returns a ref', () => {
update(() => ({ x: 0 }), [1])
testIsRef(ref)
})
})
})
interface TestContext extends ISpringContext {
set(values: ISpringContext): void
}
function createUpdater(Component: React.ComponentType<{ args: [any, any?] }>) {
let prevElem: React.JSX.Element | undefined
let result: RenderResult | undefined
const context: TestContext = {
set(values) {
Object.assign(this, values)
if (prevElem) {
renderWithContext(prevElem)
}
},
}
// Ensure `context.set` is ignored.
Object.defineProperty(context, 'set', {
value: context.set,
enumerable: false,
})
afterEach(() => {
result = prevElem = undefined
for (const key in context) {
delete (context as any)[key]
}
})
function renderWithContext(elem: React.JSX.Element) {
const wrapped = (
<SpringContextProvider {...context}>{elem}</SpringContextProvider>
)
if (result) result.rerender(wrapped)
else result = render(wrapped)
return result
}
type Args = Parameters<typeof useSpring>
const update = (...args: [Args[0], Args[1]?]) =>
renderWithContext((prevElem = <Component args={args} />))
return [update, context] as const
}
function testIsRef(ref: SpringRef | null) {
const props = [
'add',
'delete',
'pause',
'resume',
'set',
'start',
'stop',
'update',
'_getProps',
]
props.forEach(prop => expect(ref).toHaveProperty(prop))
}
|