Skip to content

Commit

Permalink
Don't autofocus when rendering page refreshes with morphing
Browse files Browse the repository at this point in the history
Before this change, Turbo would always focus on the first element with `[autofocus]` when a page refresh
with morphing happened  (default behavior inherited from `PageRenderer`). With this change, it will never
autofocus when a page refresh with morphing happens.

This is meant to solve the problem where you are writing on a form, and it loses the focus because a
broadcasted page refresh arrives.
  • Loading branch information
jorgemanrubia committed May 30, 2024
1 parent 89be8e4 commit 0847fe7
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 5 deletions.
4 changes: 4 additions & 0 deletions src/core/drive/morph_renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ export class MorphRenderer extends PageRenderer {
return "morph"
}

get shouldAutofocus() {
return false
}

// Private

async #morphBody() {
Expand Down
12 changes: 9 additions & 3 deletions src/core/renderer.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ export class Renderer {
return true
}

get shouldAutofocus() {
return true
}

get reloadReason() {
return
}
Expand All @@ -40,9 +44,11 @@ export class Renderer {
}

focusFirstAutofocusableElement() {
const element = this.connectedSnapshot.firstAutofocusableElement
if (element) {
element.focus()
if (this.shouldAutofocus) {
const element = this.connectedSnapshot.firstAutofocusableElement
if (element) {
element.focus()
}
}
}

Expand Down
2 changes: 1 addition & 1 deletion src/tests/fixtures/page_refresh.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ <h3>Element with Stimulus controller</h3>
<form method="get" data-turbo-action="replace" oninput="this.requestSubmit()">
<label>
Search
<input name="query">
<input name="query" autofocus>
</label>
<button>Form with params to refresh the page</button>
</form>
Expand Down
27 changes: 27 additions & 0 deletions src/tests/functional/autofocus_tests.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { expect, test } from "@playwright/test"
import { nextBody, nextEventNamed } from "../helpers/page"

test.beforeEach(async ({ page }) => {
await page.goto("/src/tests/fixtures/autofocus.html")
Expand Down Expand Up @@ -74,3 +75,29 @@ test("receiving a Turbo Stream message with an [autofocus] element when an eleme
})
await expect(page.locator("#first-autofocus-element")).toBeFocused()
})

test("don't focus on [autofocus] elements on page refreshes with morphing", async ({ page }) => {
await page.goto("/src/tests/fixtures/page_refresh.html")

const input = await page.locator("input[autofocus]")

await page.evaluate(() => {
document.getElementById("refresh-after-navigation-link").focus()
})

await nextBody(page)

const link = await page.locator("#refresh-after-navigation-link")
expect(link).toBeFocused()
expect(input).not.toBeFocused()

await page.evaluate(() => {
document.querySelector("#form").requestSubmit()
})

await nextEventNamed(page, "turbo:render", { renderMethod: "morph" })
await nextBody(page)

expect(input).not.toBeFocused()
expect(link).toBeFocused()
})
2 changes: 1 addition & 1 deletion src/tests/functional/page_refresh_tests.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ test("renders a page refresh with morphing when the paths are the same but searc
await nextEventNamed(page, "turbo:render", { renderMethod: "morph" })
})

test("renders a page refresh with morphing when the GET form paths are the same but search params are diferent", async ({ page }) => {
test("renders a page refresh with morphing when the GET form paths are the same but search params are different", async ({ page }) => {
await page.goto("/src/tests/fixtures/page_refresh.html")

const input = page.locator("form[method=get] input[name=query]")
Expand Down

0 comments on commit 0847fe7

Please sign in to comment.