Add shouldAutoFocus prop to Overlay, SideSheet, and Dialog components #1535
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #1404
Overview
This PR introduces a prop to
Overlay
,SideSheet
andDialog
that allows a consumer to disable the default autofocus behavior that lives inOverlay.js
. As noted in that task, there are certain cases where the behavior can be incorrect or undesirable but there's no obvious way to opt out of it. This PR addresses that - retaining the current behavior, but opening up a way to disable it if needed.Screenshots (if applicable)
Behavior can be demoed in the respective Storybook areas:
https://deploy-preview-1535--evergreen-storybook.netlify.app/?path=/story/overlay--autofocus-disabled
https://deploy-preview-1535--evergreen-storybook.netlify.app/?path=/story/side-sheet--autofocus-disabled
(Scroll to bottom and click button 'Show Dialog with autofocus disabled')
https://deploy-preview-1535--evergreen-storybook.netlify.app/?path=/story/dialog--dialog
Documentation