Skip to content
Source
Sign inSign up
TanStack/router
Open History to see the last commit

app.spec.ts

114 lines4.0 KB

1import { expect, test } from '@playwright/test'
2​
3test('restore scroll positions by page, home pages top message should not display on navigating back', async ({
4 page,
5}) => {
6 // Step 1: Navigate to the home page
7 await page.goto('/')
8​
9 await expect(page.locator('#greeting')).toContainText('Welcome Home!')
10 await expect(page.locator('#top-message')).toBeInViewport()
11​
12 // Step 2: Scroll to a position that hides the top
13 const targetScrollPosition = 1000
14 await page.evaluate(
15 (scrollPos: number) => window.scrollTo(0, scrollPos),
16 targetScrollPosition,
17 )
18​
19 // Verify initial scroll position
20 const scrollPosition = await page.evaluate(() => window.scrollY)
21 expect(scrollPosition).toBe(targetScrollPosition)
22​
23 await expect(page.locator('#top-message')).not.toBeInViewport()
24 await page.waitForTimeout(1000)
25​
26 // Step 3: Navigate to the about page
27 await page.getByRole('link', { name: 'About', exact: true }).click()
28 await expect(page.locator('#greeting')).toContainText('Hello from About!')
29​
30 // Step 4: Go back to the home page and immediately check the message
31 await page.goBack()
32​
33 // Wait for the home page to have rendered
34 await page.waitForSelector('#greeting')
35 await page.waitForTimeout(1000)
36 await expect(page.locator('#top-message')).not.toBeInViewport()
37​
38 // Confirm the scroll position was restored correctly
39 const restoredScrollPosition = await page.evaluate(() => window.scrollY)
40 expect(restoredScrollPosition).toBe(targetScrollPosition)
41})
42​
43test('restore scroll positions by element, first regular list item should not display on navigating back', async ({
44 page,
45}) => {
46 // Step 1: Navigate to the by-element page
47 await page.goto('/by-element')
48​
49 // Step 2: Scroll to a position that hides the first list item in regular list
50 const targetScrollPosition = 1000
51 await page.waitForSelector('#RegularList')
52 await expect(page.locator('#first-regular-list-item')).toBeInViewport()
53​
54 await page.evaluate(
55 (scrollPos: number) =>
56 document.querySelector('#RegularList')!.scrollTo(0, scrollPos),
57 targetScrollPosition,
58 )
59​
60 // Verify initial scroll position
61 const scrollPosition = await page.evaluate(
62 () => document.querySelector('#RegularList')!.scrollTop,
63 )
64 expect(scrollPosition).toBe(targetScrollPosition)
65​
66 await expect(page.locator('#first-regular-list-item')).not.toBeInViewport()
67​
68 // Step 3: Navigate to the about page
69 await page.getByRole('link', { name: 'About', exact: true }).click()
70 await expect(page.locator('#greeting')).toContainText('Hello from About!')
71​
72 // Step 4: Go back to the by-element page and immediately check the message
73 await page.goBack()
74​
75 // TODO: For some reason, this only works in headed mode.
76 // When someone can explain that to me, I'll fix this test.
77​
78 // Confirm the scroll position was restored correctly
79 // const restoredScrollPosition = await page.evaluate(
80 // () => document.querySelector('#RegularList')!.scrollTop,
81 // )
82 // expect(restoredScrollPosition).toBe(targetScrollPosition)
83})
84​
85test('scroll to top when not scrolled, regression test for #4782', async ({
86 page,
87}) => {
88 await page.goto('/foo')
89​
90 await expect(page.getByTestId('foo-route-component')).toBeVisible()
91​
92 let scrollPosition = await page.evaluate(() => window.scrollY)
93 expect(scrollPosition).toBe(0)
94​
95 // do not scroll, just navigate to /bar
96 await page.getByTestId('go-to-bar-link').click()
97 await expect(page.getByTestId('bar-route-component')).toBeVisible()
98​
99 const targetScrollPosition = 1000
100 await page.evaluate(
101 (scrollPos: number) => window.scrollTo(0, scrollPos),
102 targetScrollPosition,
103 )
104 scrollPosition = await page.evaluate(() => window.scrollY)
105 expect(scrollPosition).toBe(targetScrollPosition)
106​
107 // navigate back to /foo
108 await page.goBack()
109 await expect(page.getByTestId('foo-route-component')).toBeVisible()
110​
111 // check if scroll position is restored to 0 since we did not scroll on /foo
112 const restoredScrollPosition = await page.evaluate(() => window.scrollY)
113 expect(restoredScrollPosition).toBe(0)
114})