master - add CSS variables and modules ordering

ranbuch · Mar 28, 2024 · 48444c3 · 48444c3
1 parent c90c32a
commit 48444c3
Show file tree

Hide file tree

Showing 8 changed files with 340 additions and 147 deletions.
diff --git a/dist/interfaces/accessibility.interface.d.ts b/dist/interfaces/accessibility.interface.d.ts
@@ -1,5 +1,5 @@
-import { ICommon, IUnitsDim } from "./common.interface";
-import { IMenuInterface } from "./menu.interface";
+import { ICommon, IUnitsDim } from './common.interface';
+import { IMenuInterface } from './menu.interface';
 export interface IAccessibility {
     menuInterface: IMenuInterface;
     options: IAccessibilityOptions;
@@ -25,6 +25,7 @@ export interface IAccessibility {
     resetIfDefined(src: string, dest: any, prop: string): void;
     onChange(updateSession: boolean): void;
     createScreenShot(url: string): Promise<string>;
+    injectCss(): void;
 }
 export interface IAccessibilityOptions {
     icon?: IAccessibilityIconOptions;
@@ -39,12 +40,14 @@ export interface IAccessibilityOptions {
     textEmlMode?: boolean;
     animations?: IAccessibilityAnimationsOptions;
     modules?: IAccessibilityModulesOptions;
+    modulesOrder?: Array<IAccessibilityModuleOrder>;
     session?: IAccessibilitySessionOptions;
     iframeModals?: Array<IIframeModal>;
     customFunctions?: Array<ICustomFunction>;
     statement?: IAccessibilityUrlOptions;
     feedback?: IAccessibilityUrlOptions;
     language?: IAccessibilityLanguageOptions;
+    suppressCssInjection?: boolean;
 }
 export interface ICustomFunction {
     method: Function;
@@ -68,7 +71,7 @@ export interface IAccessibilityIconOptions {
     color?: string;
     img?: string;
     circular?: boolean;
-    circularBorder?: false;
+    circularBorder?: true | false;
     fontFaceSrc?: Array<string>;
     fontClass?: string;
     useEmojis?: boolean;
@@ -158,6 +161,28 @@ export interface IAccessibilityModulesOptions {
     speechToText: boolean;
     disableAnimations: boolean;
 }
+export declare enum AccessibilityModulesType {
+    increaseText = 1,
+    decreaseText = 2,
+    increaseTextSpacing = 3,
+    decreaseTextSpacing = 4,
+    increaseLineHeight = 5,
+    decreaseLineHeight = 6,
+    invertColors = 7,
+    grayHues = 8,
+    bigCursor = 9,
+    readingGuide = 10,
+    underlineLinks = 11,
+    textToSpeech = 12,
+    speechToText = 13,
+    disableAnimations = 14,
+    iframeModals = 15,
+    customFunctions = 16
+}
+export interface IAccessibilityModuleOrder {
+    order: number;
+    type: AccessibilityModulesType;
+}
 export interface IAccessibilitySessionOptions {
     persistent: boolean;
 }

diff --git a/dist/interfaces/accessibility.interface.js b/dist/interfaces/accessibility.interface.js
@@ -2,4 +2,25 @@
 
 Object.defineProperty(exports, "__esModule", {
   value: true
-});
+});
+exports.AccessibilityModulesType = void 0;
+var AccessibilityModulesType;
+exports.AccessibilityModulesType = AccessibilityModulesType;
+(function (AccessibilityModulesType) {
+  AccessibilityModulesType[AccessibilityModulesType["increaseText"] = 1] = "increaseText";
+  AccessibilityModulesType[AccessibilityModulesType["decreaseText"] = 2] = "decreaseText";
+  AccessibilityModulesType[AccessibilityModulesType["increaseTextSpacing"] = 3] = "increaseTextSpacing";
+  AccessibilityModulesType[AccessibilityModulesType["decreaseTextSpacing"] = 4] = "decreaseTextSpacing";
+  AccessibilityModulesType[AccessibilityModulesType["increaseLineHeight"] = 5] = "increaseLineHeight";
+  AccessibilityModulesType[AccessibilityModulesType["decreaseLineHeight"] = 6] = "decreaseLineHeight";
+  AccessibilityModulesType[AccessibilityModulesType["invertColors"] = 7] = "invertColors";
+  AccessibilityModulesType[AccessibilityModulesType["grayHues"] = 8] = "grayHues";
+  AccessibilityModulesType[AccessibilityModulesType["bigCursor"] = 9] = "bigCursor";
+  AccessibilityModulesType[AccessibilityModulesType["readingGuide"] = 10] = "readingGuide";
+  AccessibilityModulesType[AccessibilityModulesType["underlineLinks"] = 11] = "underlineLinks";
+  AccessibilityModulesType[AccessibilityModulesType["textToSpeech"] = 12] = "textToSpeech";
+  AccessibilityModulesType[AccessibilityModulesType["speechToText"] = 13] = "speechToText";
+  AccessibilityModulesType[AccessibilityModulesType["disableAnimations"] = 14] = "disableAnimations";
+  AccessibilityModulesType[AccessibilityModulesType["iframeModals"] = 15] = "iframeModals";
+  AccessibilityModulesType[AccessibilityModulesType["customFunctions"] = 16] = "customFunctions";
+})(AccessibilityModulesType || (exports.AccessibilityModulesType = AccessibilityModulesType = {}));
diff --git a/dist/main.bundle.js b/dist/main.bundle.js
diff --git a/dist/main.d.ts b/dist/main.d.ts
@@ -3,6 +3,7 @@ import { Common } from './common';
 import { IAccessibility, IAccessibilityOptions, ISessionState, IStateValues } from './interfaces/accessibility.interface';
 import { IMenuInterface } from './interfaces/menu.interface';
 export declare class Accessibility implements IAccessibility {
+    static CSS_CLASS_NAME: string;
     private _isReading;
     private _common;
     private _storage;
@@ -31,15 +32,18 @@ export declare class Accessibility implements IAccessibility {
     initFontSize(): void;
     fontFallback(): void;
     deleteOppositesIfDefined(options: IAccessibilityOptions): IAccessibilityOptions;
+    addModuleOrderIfNotDefined(): void;
     disabledUnsupportedFeatures(): void;
     injectCss(): void;
+    removeCSS(): void;
     injectIcon(): HTMLElement;
     parseKeys(arr: Array<any>): string;
     injectMenu(): HTMLElement;
     getVoices(): Promise<SpeechSynthesisVoice[]>;
     injectTts(): Promise<void>;
     addListeners(): void;
-    disableUnsupportedModules(): void;
+    sortModuleTypes(): void;
+    disableUnsupportedModulesAndSort(): void;
     resetAll(): void;
     resetTextSize(): void;
     resetLineHeight(): void;

diff --git a/dist/main.js b/dist/main.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "accessibility",
-  "version": "4.5.12",
+  "version": "5.0.0",
   "description": "add accessibility to your website",
   "main": "index.js",
   "exports": {

diff --git a/src/interfaces/accessibility.interface.ts b/src/interfaces/accessibility.interface.ts
@@ -1,5 +1,5 @@
-import { ICommon, IUnitsDim } from "./common.interface";
-import { IMenuInterface } from "./menu.interface";
+import { ICommon, IUnitsDim } from './common.interface';
+import { IMenuInterface } from './menu.interface';
 
 export interface IAccessibility {
     menuInterface: IMenuInterface;
@@ -26,6 +26,8 @@ export interface IAccessibility {
     resetIfDefined(src: string, dest: any, prop: string): void;
     onChange(updateSession: boolean): void;
     createScreenShot(url: string): Promise<string>;
+    injectCss(): void;
+    removeCSS(): void;
 }
 
 export interface IAccessibilityOptions {
@@ -41,12 +43,14 @@ export interface IAccessibilityOptions {
     textEmlMode?: boolean;
     animations?: IAccessibilityAnimationsOptions;
     modules?: IAccessibilityModulesOptions;
+    modulesOrder?: Array<IAccessibilityModuleOrder>;
     session?: IAccessibilitySessionOptions;
     iframeModals?: Array<IIframeModal>;
     customFunctions?: Array<ICustomFunction>;
     statement?: IAccessibilityUrlOptions;
     feedback?: IAccessibilityUrlOptions;
     language?: IAccessibilityLanguageOptions;
+    suppressCssInjection?: boolean;
 }
 
 export interface ICustomFunction {
@@ -73,7 +77,7 @@ export interface IAccessibilityIconOptions {
     color?: string;
     img?: string;
     circular?: boolean;
-    circularBorder?: false,
+    circularBorder?: true | false;
     fontFaceSrc?: Array<string>;
     fontClass?: string;
     useEmojis?: boolean;
@@ -175,6 +179,30 @@ export interface IAccessibilityModulesOptions {
     disableAnimations: boolean;
 }
 
+export enum AccessibilityModulesType {
+    increaseText = 1,
+    decreaseText = 2,
+    increaseTextSpacing = 3,
+    decreaseTextSpacing = 4,
+    increaseLineHeight = 5,
+    decreaseLineHeight = 6,
+    invertColors = 7,
+    grayHues = 8,
+    bigCursor = 9,
+    readingGuide = 10,
+    underlineLinks = 11,
+    textToSpeech = 12,
+    speechToText = 13,
+    disableAnimations = 14,
+    iframeModals = 15,
+    customFunctions = 16,
+}
+
+export interface IAccessibilityModuleOrder {
+    order: number;
+    type: AccessibilityModulesType;
+}
+
 export interface IAccessibilitySessionOptions {
     persistent: boolean;
 }