Skip to content

feat: support focusTrap #542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zombieJ merged 1 commit into from
Jan 5, 2026
Merged

feat: support focusTrap #542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Dialog/Content/Panel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,15 @@ const Panel = React.forwardRef<PanelRef, PanelProps>((props, ref) => {
classNames: modalClassNames,
styles: modalStyles,
isFixedPos,
focusTrap,
} = props;

// ================================= Refs =================================
const { panel: panelRef } = React.useContext(RefContext);
const internalRef = useRef<HTMLDivElement>(null);
const mergedRef = useComposeRef(holderRef, panelRef, internalRef);

useLockFocus(visible && isFixedPos, () => internalRef.current);
useLockFocus(visible && isFixedPos && focusTrap !== false, () => internalRef.current);
Copy link

@gemini-code-assist gemini-code-assist bot Jan 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability and to use a more modern JavaScript/TypeScript feature, you could use the nullish coalescing operator (??). The expression focusTrap ?? true is equivalent to focusTrap !== false for boolean and undefined values, and it more clearly conveys the intent of defaulting to true when focusTrap is not provided. Note that the parentheses are important due to operator precedence.

Suggested change
useLockFocus(visible && isFixedPos && focusTrap !== false, () => internalRef.current);
useLockFocus(visible && isFixedPos && (focusTrap ?? true), () => internalRef.current);


React.useImperativeHandle(ref, () => ({
focus: () => {
Expand Down
1 change: 1 addition & 0 deletions src/IDialogPropTypes.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ export type IDialogPropTypes = {
// https://github.com/ant-design/ant-design/issues/19771
// https://github.com/react-component/dialog/issues/95
focusTriggerAfterClose?: boolean;
focusTrap?: boolean;

// Refs
panelRef?: React.Ref<HTMLDivElement>;
Expand Down
18 changes: 18 additions & 0 deletions tests/focus.spec.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,22 @@ describe('Dialog.Focus', () => {

expect(globalThis.__useLockFocusVisible).toBe(false);
});

it('should not lock focus when focusTrap is false', () => {
render(
<Dialog
visible
focusTrap={false}
styles={{
wrapper: { position: 'fixed' },
}}
/>,
);

act(() => {
jest.runAllTimers();
});

expect(globalThis.__useLockFocusVisible).toBe(false);
});
});
Loading