Skip to content

fix(dialog, modal, sheet): preserve focus-trap extra containers across internal trap updates #11548

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
jcfranco merged 1 commit into from
Feb 14, 2025
Merged

fix(dialog, modal, sheet): preserve focus-trap extra containers across internal trap updates #11548

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 packages/calcite-components/src/components/dialog/dialog.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,7 +286,8 @@ export class Dialog extends LitElement implements OpenCloseComponent {
async updateFocusTrapElements(
extraContainers?: FocusTrapOptions["extraContainers"],
): Promise<void> {
this.focusTrap.updateContainerElements(extraContainers);
this.focusTrap.setExtraContainers(extraContainers);
this.focusTrap.updateContainerElements();
}

/** When defined, provides a condition to disable focus trapping. When `true`, prevents focus trapping. */
Expand Down
3 changes: 2 additions & 1 deletion packages/calcite-components/src/components/modal/modal.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,8 @@ export class Modal extends LitElement implements OpenCloseComponent {
async updateFocusTrapElements(
extraContainers?: FocusTrapOptions["extraContainers"],
): Promise<void> {
this.focusTrap.updateContainerElements(extraContainers);
this.focusTrap.setExtraContainers(extraContainers);
this.focusTrap.updateContainerElements();
}

// #endregion
Expand Down
3 changes: 2 additions & 1 deletion packages/calcite-components/src/components/sheet/sheet.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,8 @@ export class Sheet extends LitElement implements OpenCloseComponent {
async updateFocusTrapElements(
extraContainers?: FocusTrapOptions["extraContainers"],
): Promise<void> {
this.focusTrap.updateContainerElements(extraContainers);
this.focusTrap.setExtraContainers(extraContainers);
this.focusTrap.updateContainerElements();
}

// #endregion
Expand Down
23 changes: 15 additions & 8 deletions packages/calcite-components/src/controllers/useFocusTrap.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,16 @@ export interface UseFocusTrap {
overrideFocusTrapEl: (el: HTMLElement) => void;

/**
* Updates focusable elements within the trap.
* Sets the extra containers to be used in the focus trap.
*
* @see https://github.com/focus-trap/focus-trap#trapupdatecontainerelements
*/
updateContainerElements: (extraContainers?: FocusTrapOptions["extraContainers"]) => void;
setExtraContainers: (extraContainers?: FocusTrapOptions["extraContainers"]) => void;

/**
* Updates focusable elements within the trap.
*/
updateContainerElements: () => void;
}

interface UseFocusTrapOptions<T extends LitElement = LitElement> {
Expand Down Expand Up @@ -100,6 +105,7 @@ export const useFocusTrap = <T extends FocusTrapComponent>(
return makeGenericController<UseFocusTrap, T>((component, controller) => {
let focusTrap: FocusTrap;
let focusTrapEl: HTMLElement;
let effectiveContainers: FocusTrapOptions["extraContainers"];
const internalFocusTrapOptions = options.focusTrapOptions;

controller.onConnected(() => {
Expand All @@ -123,11 +129,9 @@ export const useFocusTrap = <T extends FocusTrapComponent>(
...internalFocusTrapOptions,
...component.focusTrapOptions,
};
effectiveContainers ||= getEffectiveContainerElements(targetEl, component);

focusTrap = createFocusTrap(
getEffectiveContainerElements(targetEl, component),
createFocusTrapOptions(targetEl, effectiveFocusTrapOptions),
);
focusTrap = createFocusTrap(effectiveContainers, createFocusTrapOptions(targetEl, effectiveFocusTrapOptions));
}

if (
Expand All @@ -146,9 +150,12 @@ export const useFocusTrap = <T extends FocusTrapComponent>(

focusTrapEl = el;
},
updateContainerElements: (extraContainers?: FocusTrapOptions["extraContainers"]) => {
setExtraContainers: (extraContainers?: FocusTrapOptions["extraContainers"]) => {
const targetEl = focusTrapEl || component.el;
return focusTrap?.updateContainerElements(getEffectiveContainerElements(targetEl, component, extraContainers));
effectiveContainers = getEffectiveContainerElements(targetEl, component, extraContainers);
},
updateContainerElements: () => {
return focusTrap?.updateContainerElements(effectiveContainers);
},
};
});
Expand Down