tabster - npm Package Compare versions

Comparing version 4.7.2 to 4.7.3

dist/dts/Focusable.d.ts

@@ -18,9 +18,9 @@ /*!
     findLast(options: Types.FindFirstProps): HTMLElement | null | undefined;
-    findNext(options: Types.FindNextProps): HTMLElement | null | undefined;
-    findPrev(options: Types.FindNextProps): HTMLElement | null | undefined;
+    findNext(options: Types.FindNextProps, out?: Types.FindFocusableOutputProps): HTMLElement | null | undefined;
+    findPrev(options: Types.FindNextProps, out?: Types.FindFocusableOutputProps): HTMLElement | null | undefined;
     findDefault(options: Types.FindDefaultProps): HTMLElement | null;
     findAll(options: Types.FindAllProps): HTMLElement[];
-    findElement(options: Types.FindFocusableProps): HTMLElement | null | undefined;
+    findElement(options: Types.FindFocusableProps, out?: Types.FindFocusableOutputProps): HTMLElement | null | undefined;
     private _findElements;
     private _acceptElement;
 }

dist/dts/Groupper.d.ts

@@ -17,3 +17,3 @@ /*!
     dispose(): void;
-    findNextTabbable(currentElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
+    findNextTabbable(currentElement?: HTMLElement, referenceElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
     makeTabbable(isTabbable: boolean): void;
@@ -20,0 +20,0 @@ isActive(noIfFirstIsFocused?: boolean): boolean | undefined;

dist/dts/Modalizer.d.ts

@@ -27,3 +27,3 @@ /*!
     contains(element: HTMLElement): boolean;
-    findNextTabbable(currentElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
+    findNextTabbable(currentElement?: HTMLElement, referenceElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
     triggerFocusEvent(eventName: Types.ModalizerEventName, allElements?: boolean): boolean;
@@ -30,0 +30,0 @@ private _remove;

dist/dts/Mover.d.ts

@@ -32,3 +32,3 @@ /*!
     getCurrent(): HTMLElement | null;
-    findNextTabbable(currentElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
+    findNextTabbable(currentElement?: HTMLElement, referenceElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
     acceptElement(element: HTMLElement, state: Types.FocusableAcceptElementState): number | undefined;
@@ -35,0 +35,0 @@ private _onIntersection;

dist/dts/Restorer.d.ts

@@ -8,5 +8,7 @@ /*!
 declare class Restorer extends TabsterPart<RestorerProps> implements RestorerInterface {
+    private _hasFocus;
     constructor(tabster: TabsterCore, element: HTMLElement, props: RestorerProps);
     dispose(): void;
     private _onFocusOut;
+    private _onFocusIn;
 }
@@ -24,2 +26,3 @@ export declare class RestorerAPI implements RestorerAPIType {
     private _onFocusIn;
+    private _addToHistory;
     private _restoreFocus;
@@ -26,0 +29,0 @@ createRestorer(element: HTMLElement, props: RestorerProps): Restorer;

dist/dts/State/FocusedElement.d.ts

@@ -33,3 +33,3 @@ /*!
     private _onFocusOut;
-    static findNextTabbable(tabster: Types.TabsterCore, ctx: Types.TabsterContext, container?: HTMLElement, currentElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
+    static findNextTabbable(tabster: Types.TabsterCore, ctx: Types.TabsterContext, container?: HTMLElement, currentElement?: HTMLElement, referenceElement?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): Types.NextTabbable | null;
     private _validateFocusedElement;
@@ -36,0 +36,0 @@ private _onKeyDown;

dist/dts/Types.d.ts

@@ -73,3 +73,3 @@ /*!
 export interface TabsterPartWithFindNextTabbable {
-    findNextTabbable(current?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): NextTabbable | null;
+    findNextTabbable(current?: HTMLElement, reference?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): NextTabbable | null;
 }
@@ -267,2 +267,8 @@ export interface TabsterPartWithAcceptElement {
     isFindAll?: boolean;
+    /**
+     * A flag that indicates that some focusable elements were skipped
+     * during the search and the found element is not the one the browser
+     * would normally focus if the user pressed Tab.
+     */
+    skippedFocusable?: boolean;
 }
@@ -279,2 +285,6 @@ export interface FindFocusableProps {
     /**
+     * See `referenceElement` of GetTabsterContextOptions for description.
+     */
+    referenceElement?: HTMLElement;
+    /**
      * Includes elements that can be focused programmatically.
@@ -321,4 +331,12 @@ */
 }
+export interface FindFocusableOutputProps {
+    /**
+     * An output parameter. Will be true after the findNext/findPrev() call if some focusable
+     * elements were skipped during the search and the result element not immediately next
+     * focusable after the currentElement.
+     */
+    outOfDOMOrder?: boolean;
+}
 export type FindFirstProps = Pick<FindFocusableProps, "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility">;
-export type FindNextProps = Pick<FindFocusableProps, "currentElement" | "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility" | "onUncontrolled">;
+export type FindNextProps = Pick<FindFocusableProps, "currentElement" | "referenceElement" | "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility" | "onUncontrolled">;
 export type FindDefaultProps = Pick<FindFocusableProps, "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility">;
@@ -337,4 +355,4 @@ export type FindAllProps = Pick<FindFocusableProps, "container" | "modalizerId" | "currentElement" | "isBackward" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "acceptCondition" | "ignoreUncontrolled" | "ignoreAccessibility" | "onElement">;
     findLast(options: FindFirstProps): HTMLElement | null | undefined;
-    findNext(options: FindNextProps): HTMLElement | null | undefined;
-    findPrev(options: FindNextProps): HTMLElement | null | undefined;
+    findNext(options: FindNextProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
+    findPrev(options: FindNextProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
     findDefault(options: FindDefaultProps): HTMLElement | null;
@@ -345,3 +363,3 @@ /**
     findAll(options: FindAllProps): HTMLElement[];
-    findElement(options: FindFocusableProps): HTMLElement | null | undefined;
+    findElement(options: FindFocusableProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
 }
@@ -380,3 +398,2 @@ export interface DummyInputManager {
     uncontrolled?: HTMLElement;
-    lastMoverOrGroupper?: Mover | Groupper;
     outOfDOMOrder?: boolean;
@@ -536,2 +553,12 @@ };
     checkRtl?: boolean;
+    /**
+     * The element to start computing the context from. Useful when dealing
+     * with nested structures. For example, if we have an element inside a groupper
+     * inside another groupper, the `groupper` prop in this element's contexts will
+     * be the inner groupper, but when we pass the inner groupper's parent element
+     * as `referenceElement`, the context groupper will be the outer one. Having
+     * this option simplifies searching for the next tabbable element in the
+     * environment of nested movers and grouppers.
+     */
+    referenceElement?: HTMLElement;
 }
@@ -538,0 +565,0 @@ export type TabsterContextMoverGroupper = {

dist/index.d.ts

@@ -73,3 +73,3 @@ /*!
 interface TabsterPartWithFindNextTabbable {
-    findNextTabbable(current?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): NextTabbable | null;
+    findNextTabbable(current?: HTMLElement, reference?: HTMLElement, isBackward?: boolean, ignoreUncontrolled?: boolean, ignoreAccessibility?: boolean): NextTabbable | null;
 }
@@ -267,2 +267,8 @@ interface TabsterPartWithAcceptElement {
     isFindAll?: boolean;
+    /**
+     * A flag that indicates that some focusable elements were skipped
+     * during the search and the found element is not the one the browser
+     * would normally focus if the user pressed Tab.
+     */
+    skippedFocusable?: boolean;
 }
@@ -279,2 +285,6 @@ interface FindFocusableProps {
     /**
+     * See `referenceElement` of GetTabsterContextOptions for description.
+     */
+    referenceElement?: HTMLElement;
+    /**
      * Includes elements that can be focused programmatically.
@@ -321,4 +331,12 @@ */
 }
+interface FindFocusableOutputProps {
+    /**
+     * An output parameter. Will be true after the findNext/findPrev() call if some focusable
+     * elements were skipped during the search and the result element not immediately next
+     * focusable after the currentElement.
+     */
+    outOfDOMOrder?: boolean;
+}
 type FindFirstProps = Pick<FindFocusableProps, "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility">;
-type FindNextProps = Pick<FindFocusableProps, "currentElement" | "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility" | "onUncontrolled">;
+type FindNextProps = Pick<FindFocusableProps, "currentElement" | "referenceElement" | "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility" | "onUncontrolled">;
 type FindDefaultProps = Pick<FindFocusableProps, "container" | "modalizerId" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "ignoreUncontrolled" | "ignoreAccessibility">;
@@ -337,4 +355,4 @@ type FindAllProps = Pick<FindFocusableProps, "container" | "modalizerId" | "currentElement" | "isBackward" | "includeProgrammaticallyFocusable" | "useActiveModalizer" | "acceptCondition" | "ignoreUncontrolled" | "ignoreAccessibility" | "onElement">;
     findLast(options: FindFirstProps): HTMLElement | null | undefined;
-    findNext(options: FindNextProps): HTMLElement | null | undefined;
-    findPrev(options: FindNextProps): HTMLElement | null | undefined;
+    findNext(options: FindNextProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
+    findPrev(options: FindNextProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
     findDefault(options: FindDefaultProps): HTMLElement | null;
@@ -345,3 +363,3 @@ /**
     findAll(options: FindAllProps): HTMLElement[];
-    findElement(options: FindFocusableProps): HTMLElement | null | undefined;
+    findElement(options: FindFocusableProps, out?: FindFocusableOutputProps): HTMLElement | null | undefined;
 }
@@ -380,3 +398,2 @@ interface DummyInputManager {
     uncontrolled?: HTMLElement;
-    lastMoverOrGroupper?: Mover | Groupper;
     outOfDOMOrder?: boolean;
@@ -536,2 +553,12 @@ };
     checkRtl?: boolean;
+    /**
+     * The element to start computing the context from. Useful when dealing
+     * with nested structures. For example, if we have an element inside a groupper
+     * inside another groupper, the `groupper` prop in this element's contexts will
+     * be the inner groupper, but when we pass the inner groupper's parent element
+     * as `referenceElement`, the context groupper will be the outer one. Having
+     * this option simplifies searching for the next tabbable element in the
+     * environment of nested movers and grouppers.
+     */
+    referenceElement?: HTMLElement;
 }
@@ -759,2 +786,3 @@ type TabsterContextMoverGroupper = {
 type Types_d_FindFocusableProps = FindFocusableProps;
+type Types_d_FindFocusableOutputProps = FindFocusableOutputProps;
 type Types_d_FindFirstProps = FindFirstProps;
@@ -891,2 +919,3 @@ type Types_d_FindNextProps = FindNextProps;
     Types_d_FindFocusableProps as FindFocusableProps,
+    Types_d_FindFocusableOutputProps as FindFocusableOutputProps,
     Types_d_FindFirstProps as FindFirstProps,
@@ -893,0 +922,0 @@ Types_d_FindNextProps as FindNextProps,

package.json

 {
     "name": "tabster",
-    "version": "4.7.2",
+    "version": "4.7.3",
     "description": "Focus Management Tools for Web",
@@ -5,0 +5,0 @@ "author": "Marat Abdullin <[e-mail]>",

No alert changes

Improved metrics

Total package byte prevSize

1925278

increased by0.35%

Lines of code

16887

increased by0.51%

No dependency changes