Skip to content

Commit

Permalink
Ensure page doesn't scroll down when pressing Escape to close the `…
Browse files Browse the repository at this point in the history
…Dialog` component (#3218)

* ensure we blur the `document.activeElement` when pressing `Escape`

* update changelog
  • Loading branch information
RobinMalfait committed May 21, 2024
1 parent 300e9eb commit 045f2bc
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
1 change: 1 addition & 0 deletions packages/@headlessui-react/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- [internal] Don’t set a focus fallback for Dialog’s in demo mode ([#3194](https://github.com/tailwindlabs/headlessui/pull/3194))
- Ensure page doesn't scroll down when pressing `Escape` to close the `Dialog` component ([#3218](https://github.com/tailwindlabs/headlessui/pull/3218))

## [2.0.3] - 2024-05-07

Expand Down
15 changes: 15 additions & 0 deletions packages/@headlessui-react/src/components/dialog/dialog.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,21 @@ function DialogFn<TTag extends ElementType = typeof DEFAULT_DIALOG_TAG>(
if (event.key !== Keys.Escape) return
event.preventDefault()
event.stopPropagation()

// Ensure that we blur the current activeElement to prevent maintaining
// focus and potentially scrolling the page to the end (because the Dialog
// is rendered in a Portal at the end of the document.body and the browser
// tries to keep the focused element in view)
//
// Typically only happens in Safari.
if (
document.activeElement &&
'blur' in document.activeElement &&
typeof document.activeElement.blur === 'function'
) {
document.activeElement.blur()
}

close()
})

Expand Down

0 comments on commit 045f2bc

Please sign in to comment.