[DOCS]: PopoverPanel modal incorrectly says default=true and makes others inert

[david-crespo]

This bit of the docs appears to be incorrect.

https://headlessui.com/react/popover

Based on the description of #3124 both of the following are intentional, so the fix would be to the docs rather than the code.

modal defaults to false

headlessui/packages/@headlessui-react/src/components/popover/popover.tsx

Line 815 in 045f2bc

modal = false,

PopoverPanel does not call useOthersInert

headlessui/packages/@headlessui-react/src/components/popover/popover.tsx

Lines 857 to 861 in 045f2bc

	// Ensure we close the popover as soon as the button becomes hidden
	useOnDisappear(state.button, () => dispatch({ type: ActionTypes.ClosePopover }), visible)
	// Enable scroll locking when the popover is visible, and `modal` is enabled
	useScrollLock(ownerDocument, state.__demoMode ? false : modal && visible)

[RobinMalfait]

Good catch!

You are right that the Popover component doesn't set the inert attribute on other elements. We've updated the docs accordingly. Thanks

[david-crespo]

Thanks! I don’t want to be pedantic, but it still says modal defaults to true and I don’t think it does.

Fixed now too.