tabster - npm Package Compare versions

Comparing version 4.6.0 to 4.7.0

dist/dts/index.d.ts

@@ -5,2 +5,2 @@ /*!
  */
-export { createTabster, getTabster, disposeTabster, forceCleanup, mergeTabsterProps, getTabsterAttribute, setTabsterAttribute, getGroupper, getMover, getCrossOrigin, getDeloser, getModalizer, getObservedElement, getOutline, getInternal, makeNoOp, isNoOp, Types, } from "./Tabster";
+export { createTabster, getTabster, disposeTabster, forceCleanup, mergeTabsterProps, getTabsterAttribute, setTabsterAttribute, getGroupper, getMover, getCrossOrigin, getDeloser, getModalizer, getObservedElement, getOutline, getInternal, getRestorer, makeNoOp, isNoOp, Types, } from "./Tabster";

dist/dts/Modalizer.d.ts

@@ -41,6 +41,7 @@ /*!
     private _alwaysAccessibleSelector;
+    private _accessibleCheck;
     activeId: string | undefined;
     currentIsOthersAccessible: boolean | undefined;
     activeElements: WeakRef<HTMLElement>[];
-    constructor(tabster: Types.TabsterCore, alwaysAccessibleSelector?: string);
+    constructor(tabster: Types.TabsterCore, alwaysAccessibleSelector?: string, accessibleCheck?: Types.ModalizerElementAccessibleCheck);
     dispose(): void;
@@ -47,0 +48,0 @@ createModalizer(element: HTMLElement, props: Types.ModalizerProps, sys: Types.SysProps | undefined): Types.Modalizer;

dist/dts/Tabster.d.ts

@@ -44,7 +44,13 @@ /*!
  * status announcements.
+ * @param accessibleCheck An optional callback that will be called when
+ * active Modalizer wants to hide an element that doesn't belong to it from
+ * the screen readers by setting aria-hidden. Similar to alwaysAccessibleSelector
+ * but allows to address the elements programmatically rather than with a selector.
+ * If the callback returns true, the element will not receive aria-hidden.
  */
-export declare function getModalizer(tabster: Types.Tabster, alwaysAccessibleSelector?: string): Types.ModalizerAPI;
+export declare function getModalizer(tabster: Types.Tabster, alwaysAccessibleSelector?: string, accessibleCheck?: Types.ModalizerElementAccessibleCheck): Types.ModalizerAPI;
 export declare function getObservedElement(tabster: Types.Tabster): Types.ObservedElementAPI;
 export declare function getCrossOrigin(tabster: Types.Tabster): Types.CrossOriginAPI;
 export declare function getInternal(tabster: Types.Tabster): Types.InternalAPI;
+export declare function getRestorer(tabster: Types.Tabster): Types.RestorerAPI;
 export declare function disposeTabster(tabster: Types.Tabster, allInstances?: boolean): void;
@@ -51,0 +57,0 @@ /**

dist/dts/Types.d.ts

@@ -364,2 +364,7 @@ /*!
 }
+export declare const RestorerTypes: {
+    readonly Source: 0;
+    readonly Target: 1;
+};
+export type RestorerType = typeof RestorerTypes[keyof typeof RestorerTypes];
 export declare const MoverDirections: MoverDirections;
@@ -574,2 +579,18 @@ export type MoverDirection = MoverDirections[keyof MoverDirections];
 }
+interface RestorerAPIInternal {
+}
+export interface RestorerAPI extends RestorerAPIInternal, Disposable {
+}
+export interface Restorer extends Disposable, TabsterPart<RestorerProps> {
+}
+/**
+ * A signature for the accessibleCheck callback from getModalizer().
+ * It is called when active Modalizer sets aria-hidden on elements outsidef of it.
+ *
+ * @param element The element that is about to receive aria-hidden.
+ * @param activeModalizerElements The container elements of the active modalizer.
+ * @returns true if the element should remain accessible and should not receive
+ * aria-hidden.
+ */
+export type ModalizerElementAccessibleCheck = (element: HTMLElement, activeModalizerElements?: HTMLElement[]) => boolean;
 export interface DeloserOnElement {
@@ -584,2 +605,5 @@ deloser: Deloser;
 }
+export interface RestorerOnElement {
+    restorer: Restorer;
+}
 export interface FocusableOnElement {
@@ -606,2 +630,5 @@ focusable: FocusableProps;
 }
+export interface RestorerProps {
+    type: RestorerType;
+}
 export type TabsterAttributeProps = Partial<{
@@ -618,2 +645,3 @@ deloser: DeloserProps;
     sys: SysProps;
+    restorer: RestorerProps;
 }>;
@@ -627,3 +655,3 @@ export interface TabsterAttributeOnElement {
 }
-export type TabsterOnElement = Partial<RootOnElement & DeloserOnElement & ModalizerOnElement & FocusableOnElement & MoverOnElement & GroupperOnElement & ObservedOnElement & OutlineOnElement & UncontrolledOnElement & SysOnElement>;
+export type TabsterOnElement = Partial<RootOnElement & DeloserOnElement & ModalizerOnElement & FocusableOnElement & MoverOnElement & GroupperOnElement & ObservedOnElement & OutlineOnElement & UncontrolledOnElement & SysOnElement & RestorerOnElement>;
 export interface OutlineElements {
@@ -630,0 +658,0 @@ container: HTMLDivElement;

dist/dts/Utils.d.ts

@@ -206,2 +206,3 @@ /*!
 export declare function augmentAttribute(tabster: Types.TabsterCore, element: HTMLElement, name: string, value?: string | null): boolean;
+export declare function getTabsterAttributeOnElement(element: HTMLElement): Types.TabsterAttributeProps | null;
 export {};

dist/index.d.ts

@@ -357,2 +357,7 @@ /*!
 }
+declare const RestorerTypes: {
+    readonly Source: 0;
+    readonly Target: 1;
+};
+type RestorerType = typeof RestorerTypes[keyof typeof RestorerTypes];
 interface MoverDirections {
@@ -574,2 +579,18 @@ Both: 0;
 }
+interface RestorerAPIInternal {
+}
+interface RestorerAPI extends RestorerAPIInternal, Disposable {
+}
+interface Restorer extends Disposable, TabsterPart<RestorerProps> {
+}
+/**
+ * A signature for the accessibleCheck callback from getModalizer().
+ * It is called when active Modalizer sets aria-hidden on elements outsidef of it.
+ *
+ * @param element The element that is about to receive aria-hidden.
+ * @param activeModalizerElements The container elements of the active modalizer.
+ * @returns true if the element should remain accessible and should not receive
+ * aria-hidden.
+ */
+type ModalizerElementAccessibleCheck = (element: HTMLElement, activeModalizerElements?: HTMLElement[]) => boolean;
 interface DeloserOnElement {
@@ -584,2 +605,5 @@ deloser: Deloser;
 }
+interface RestorerOnElement {
+    restorer: Restorer;
+}
 interface FocusableOnElement {
@@ -606,2 +630,5 @@ focusable: FocusableProps;
 }
+interface RestorerProps {
+    type: RestorerType;
+}
 type TabsterAttributeProps = Partial<{
@@ -618,2 +645,3 @@ deloser: DeloserProps;
     sys: SysProps;
+    restorer: RestorerProps;
 }>;
@@ -627,3 +655,3 @@ interface TabsterAttributeOnElement {
 }
-type TabsterOnElement = Partial<RootOnElement & DeloserOnElement & ModalizerOnElement & FocusableOnElement & MoverOnElement & GroupperOnElement & ObservedOnElement & OutlineOnElement & UncontrolledOnElement & SysOnElement>;
+type TabsterOnElement = Partial<RootOnElement & DeloserOnElement & ModalizerOnElement & FocusableOnElement & MoverOnElement & GroupperOnElement & ObservedOnElement & OutlineOnElement & UncontrolledOnElement & SysOnElement & RestorerOnElement>;
 interface OutlineElements {
@@ -740,2 +768,4 @@ container: HTMLDivElement;
 declare const Types_d_MoverDirections: typeof MoverDirections;
+declare const Types_d_RestorerTypes: typeof RestorerTypes;
+type Types_d_RestorerType = RestorerType;
 type Types_d_MoverDirection = MoverDirection;
@@ -774,5 +804,9 @@ type Types_d_NextTabbable = NextTabbable;
 type Types_d_ModalizerAPI = ModalizerAPI;
+type Types_d_RestorerAPI = RestorerAPI;
+type Types_d_Restorer = Restorer;
+type Types_d_ModalizerElementAccessibleCheck = ModalizerElementAccessibleCheck;
 type Types_d_DeloserOnElement = DeloserOnElement;
 type Types_d_RootOnElement = RootOnElement;
 type Types_d_ModalizerOnElement = ModalizerOnElement;
+type Types_d_RestorerOnElement = RestorerOnElement;
 type Types_d_FocusableOnElement = FocusableOnElement;
@@ -785,2 +819,3 @@ type Types_d_MoverOnElement = MoverOnElement;
 type Types_d_SysOnElement = SysOnElement;
+type Types_d_RestorerProps = RestorerProps;
 type Types_d_TabsterAttributeProps = TabsterAttributeProps;
@@ -867,2 +902,4 @@ type Types_d_TabsterAttributeOnElement = TabsterAttributeOnElement;
     Types_d_MoverDirections as MoverDirections,
+    Types_d_RestorerTypes as RestorerTypes,
+    Types_d_RestorerType as RestorerType,
     Types_d_MoverDirection as MoverDirection,
@@ -901,5 +938,9 @@ Types_d_NextTabbable as NextTabbable,
     Types_d_ModalizerAPI as ModalizerAPI,
+    Types_d_RestorerAPI as RestorerAPI,
+    Types_d_Restorer as Restorer,
+    Types_d_ModalizerElementAccessibleCheck as ModalizerElementAccessibleCheck,
     Types_d_DeloserOnElement as DeloserOnElement,
     Types_d_RootOnElement as RootOnElement,
     Types_d_ModalizerOnElement as ModalizerOnElement,
+    Types_d_RestorerOnElement as RestorerOnElement,
     Types_d_FocusableOnElement as FocusableOnElement,
@@ -912,2 +953,3 @@ Types_d_MoverOnElement as MoverOnElement,
     Types_d_SysOnElement as SysOnElement,
+    Types_d_RestorerProps as RestorerProps,
     Types_d_TabsterAttributeProps as TabsterAttributeProps,
@@ -996,7 +1038,13 @@ Types_d_TabsterAttributeOnElement as TabsterAttributeOnElement,
  * status announcements.
+ * @param accessibleCheck An optional callback that will be called when
+ * active Modalizer wants to hide an element that doesn't belong to it from
+ * the screen readers by setting aria-hidden. Similar to alwaysAccessibleSelector
+ * but allows to address the elements programmatically rather than with a selector.
+ * If the callback returns true, the element will not receive aria-hidden.
  */
-declare function getModalizer(tabster: Tabster, alwaysAccessibleSelector?: string): ModalizerAPI;
+declare function getModalizer(tabster: Tabster, alwaysAccessibleSelector?: string, accessibleCheck?: ModalizerElementAccessibleCheck): ModalizerAPI;
 declare function getObservedElement(tabster: Tabster): ObservedElementAPI;
 declare function getCrossOrigin(tabster: Tabster): CrossOriginAPI;
 declare function getInternal(tabster: Tabster): InternalAPI;
+declare function getRestorer(tabster: Tabster): RestorerAPI;
 declare function disposeTabster(tabster: Tabster, allInstances?: boolean): void;
@@ -1013,2 +1061,2 @@ /**
 
-export { Types_d as Types, createTabster, disposeTabster, forceCleanup, getCrossOrigin, getDeloser, getGroupper, getInternal, getModalizer, getMover, getObservedElement, getOutline, getTabster, getTabsterAttribute, isNoOp, makeNoOp, mergeTabsterProps, setTabsterAttribute };
+export { Types_d as Types, createTabster, disposeTabster, forceCleanup, getCrossOrigin, getDeloser, getGroupper, getInternal, getModalizer, getMover, getObservedElement, getOutline, getRestorer, getTabster, getTabsterAttribute, isNoOp, makeNoOp, mergeTabsterProps, setTabsterAttribute };

package.json

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

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1918597

increased by2.35%

Number of package files

31

increased by3.33%

Lines of code

16801

increased by2.33%

Worsened metrics

Number of low supply chain risk alerts

74

increased by2.78%

No dependency changes