feat(menu)!: allow users to specify both window and document env #694
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jzempel
requested changes
Apr 28, 2025
packages/menu/src/useMenu.ts
Outdated
Comment on lines
65
to
66
| let _document: Document | ShadowRoot = _window ? _window.document : window.document; | ||
| _document = documentProp ? documentProp : _document; |
There was a problem hiding this comment.
Suggested change
| let _document: Document | ShadowRoot = _window ? _window.document : window.document; | |
| _document = documentProp ? documentProp : _document; | |
| let _document: IUseMenuProps['document']; | |
| if (documentProp) { | |
| _document = documentProp | |
| } else { | |
| _document = _window ? _window.document : window.document; | |
| } |
...for improved readability and type reuse. Repeated ternaries are difficult to read and usually a signal for refactor.
packages/menu/src/useMenu.ts
Outdated
| }: IUseMenuProps<T, M>): IUseMenuReturnValue => { | ||
| const prefix = `${useId(idPrefix)}-`; | ||
| const triggerId = `${prefix}menu-trigger`; | ||
| const isExpandedControlled = isExpanded !== undefined; | ||
| const isSelectedItemsControlled = selectedItems !== undefined; | ||
| const isFocusedValueControlled = focusedValue !== undefined; | ||
|
|
||
| const _window = windowProp || environment; |
There was a problem hiding this comment.
I recall there being problems with initializing this outside of the handlers because it potentially references globals in a way that breaks SSR. The logic should be restored throughout to get the window and/or document as needed – probably via a utility function.
packages/menu/src/types.ts
Outdated
Comment on lines
89
to
93
| /** | ||
| * Sets the environment where the menu is rendered | ||
| * @deprecated use `window` prop instead. | ||
| * */ | ||
| environment?: Window; |
There was a problem hiding this comment.
Let's not deprecate; prefer the immediate feat(menu)!: ... breaking change in react-containers
ze-flo
changed the title
jzempel
reviewed
Apr 29, 2025
Comment on lines
+665
to
+674
| const _document = getDocument(windowProp, documentProp) as Document; | ||
|
|
||
| if (controlledIsExpanded) { | ||
| win.document.addEventListener('keydown', handleMenuKeyDown, true); | ||
| _document.addEventListener('keydown', handleMenuKeyDown, true); | ||
| } else if (!controlledIsExpanded) { | ||
| win.document.removeEventListener('keydown', handleMenuKeyDown, true); | ||
| _document.removeEventListener('keydown', handleMenuKeyDown, true); | ||
| } | ||
|
|
||
| return () => { | ||
| win.document.removeEventListener('keydown', handleMenuKeyDown, true); | ||
| (_document as Document).removeEventListener('keydown', handleMenuKeyDown, true); |
There was a problem hiding this comment.
Is it worth coercing the getDocument return value to Document so you don't need to repeatedly coerce throughout?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR updates
useMenuto allow users to specify bothwindowanddocumentenvironment independently.💥 BREAKING CHANGE:
The
environmentprop has been removed and replaced with the optionalwindowanddocumentprops to improve clarity and flexibility.Detail
optionalwindow anddocumentpropswindowandwindow.documentifprops.windowand/orprops.documentareundefined.Checklist
npm start)💂♂️ includes new unit tests