Skip to content

Commit 4cb60bc

Browse files
committed
fix(cdk/a11y): FocusTrap deprecation docs don't render correctly
- fix invalid usage of @Breaking-Change - fix a couple of API doc typos Relates to angular#18201. Relates to angular#22136.
1 parent 9f879b2 commit 4cb60bc

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/cdk/a11y/focus-trap/focus-trap.ts

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,11 @@ import {InteractivityChecker} from '../interactivity-checker/interactivity-check
3030
*
3131
* This class currently uses a relatively simple approach to focus trapping.
3232
* It assumes that the tab order is the same as DOM order, which is not necessarily true.
33-
* Things like `tabIndex > 0`, flex `order`, and shadow roots can cause the two to misalign.
33+
* Things like `tabIndex > 0`, flex `order`, and shadow roots can cause the two to be misaligned.
3434
*
3535
* @deprecated Use `ConfigurableFocusTrap` instead.
36-
* @breaking-change for 11.0.0 Remove this class.
36+
* @breaking-change 11.0.0
37+
* TODO for 11.0.0 Remove this class.
3738
*/
3839
export class FocusTrap {
3940
private _startAnchor: HTMLElement | null;
@@ -96,7 +97,7 @@ export class FocusTrap {
9697
/**
9798
* Inserts the anchors into the DOM. This is usually done automatically
9899
* in the constructor, but can be deferred for cases like directives with `*ngIf`.
99-
* @returns Whether the focus trap managed to attach successfuly. This may not be the case
100+
* @returns Whether the focus trap managed to attach successfully. This may not be the case
100101
* if the target element isn't currently in the DOM.
101102
*/
102103
attachAnchors(): boolean {
@@ -355,7 +356,8 @@ export class FocusTrap {
355356
/**
356357
* Factory that allows easy instantiation of focus traps.
357358
* @deprecated Use `ConfigurableFocusTrapFactory` instead.
358-
* @breaking-change for 11.0.0 Remove this class.
359+
* @breaking-change 11.0.0
360+
* TODO for 11.0.0 Remove this class.
359361
*/
360362
@Injectable({providedIn: 'root'})
361363
export class FocusTrapFactory {

0 commit comments

Comments
 (0)