#923: rename a11YNotificationEnabled to a11YScreenreaderModeEnabled

it-at-m · Jun 3, 2024 · 7074941 · 7074941
1 parent 28cb0f3
commit 7074941
Show file tree

Hide file tree

Showing 7 changed files with 45 additions and 38 deletions.
diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/components/UI/help/AppHelpMenu.vue b/digiwf-apps/packages/apps/digiwf-tasklist/src/components/UI/help/AppHelpMenu.vue
@@ -38,11 +38,11 @@
         Screenreader Optimierung
         <v-switch
           :aria-label="
-            a11YNotificationEnabled()
+            a11YScreenreaderModeEnabled()
               ? 'ist aktiviert, deaktivieren mit Entertaste'
               : 'ist deaktiviert, aktivieren mit Entertaste'
           "
-          :input-value="a11YNotificationEnabled()"
+          :input-value="a11YScreenreaderModeEnabled()"
           class="ml-2"
           dense
         >
@@ -88,7 +88,12 @@ export default defineComponent({
   emits: ["openKeyBindingsDialoge", "closeKeyBindingsDialoge"],
   setup: (components, {emit}) => {
     const theme = useTheme();
-    const {isHighContrastModeEnabled, setHighContrastModeEnabled, a11YNotificationEnabled, setA11YNotificationEnabled} =
+    const {
+      isHighContrastModeEnabled,
+      setHighContrastModeEnabled,
+      a11YScreenreaderModeEnabled,
+      setA11YScreenreaderModeEnabled
+    } =
       useAccessibility();
 
     emit("openKeyBindingsDialoge");
@@ -105,14 +110,14 @@ export default defineComponent({
     };
 
     const changeA11YNotificationMode = () => {
-      const isEnabled = a11YNotificationEnabled();
-      setA11YNotificationEnabled(!isEnabled);
+      const isEnabled = a11YScreenreaderModeEnabled();
+      setA11YScreenreaderModeEnabled(!isEnabled);
     };
 
     return {
       changeMode,
       isHighContrastModeEnabled,
-      a11YNotificationEnabled,
+      a11YScreenreaderModeEnabled,
       changeA11YNotificationMode
 
     };

diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/components/schema/VMultiUserInput.vue b/digiwf-apps/packages/apps/digiwf-tasklist/src/components/schema/VMultiUserInput.vue
@@ -178,9 +178,9 @@ export default defineComponent({
     const errorMessage = ref("");
     const currentSearch = ref("");
 
-    const a11YNotificationEnabled = useAccessibility().a11YNotificationEnabled;
+    const a11YScreenreaderModeEnabled = useAccessibility().a11YScreenreaderModeEnabled;
 
-    const screenreaderMode = computed(() => a11YNotificationEnabled());
+    const screenreaderMode = computed(() => a11YScreenreaderModeEnabled());
 
     const autocompletion = ref();
 

diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/components/schema/VUserInput.vue b/digiwf-apps/packages/apps/digiwf-tasklist/src/components/schema/VUserInput.vue
@@ -149,9 +149,9 @@ export default defineComponent({
 
     const noDataText = ref<string>("Tippen, um Suche zu starten");
 
-    const a11YNotificationEnabled = useAccessibility().a11YNotificationEnabled;
+    const a11YScreenreaderModeEnabled = useAccessibility().a11YScreenreaderModeEnabled;
 
-    const screenreaderMode = computed(() => a11YNotificationEnabled());
+    const screenreaderMode = computed(() => a11YScreenreaderModeEnabled());
 
     watch(searchText, (newValue) => {
       searchUsersBySearchString(newValue);

diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/middleware/snackbar.ts b/digiwf-apps/packages/apps/digiwf-tasklist/src/middleware/snackbar.ts
@@ -23,7 +23,7 @@ export enum MessageType {
 }
 
 export const useNotification = (): NotificationContext => {
-  const { a11YNotificationEnabled } = useAccessibility();
+  const { a11YScreenreaderModeEnabled } = useAccessibility();
   const messageText = ref<string | undefined>(undefined);
   const location = ref<RawLocation | undefined>();
   const snackbarVisible = ref<boolean>(false);
@@ -42,7 +42,7 @@ export const useNotification = (): NotificationContext => {
         location.value = targetLocation;
         messageType.value = type;
 
-        if (!a11YNotificationEnabled()) {
+        if (!a11YScreenreaderModeEnabled()) {
           router.push(targetLocation);
           snackbarVisible.value = true;
         } else if (type === MessageType.SUCCESS) {

diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/store/modules/accessibility.spec.ts b/digiwf-apps/packages/apps/digiwf-tasklist/src/store/modules/accessibility.spec.ts
@@ -5,51 +5,51 @@ describe("accessibility", () => {
     it("should return current value if high contrast mode is set to false", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: false,
-        a11YNotificationEnabled: false,
+        a11YScreenreaderModeEnabled: false,
       };
       const result = accessibility.getters.isHighContrastModeEnabled(state);
       expect(result).toBeFalsy();
     });
     it("should return current value if high contrast mode is set to true", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: true,
-        a11YNotificationEnabled: false,
+        a11YScreenreaderModeEnabled: false,
       };
       const result = accessibility.getters.isHighContrastModeEnabled(state);
       expect(result).toBeTruthy();
     });
     it("should return default value false if no value is set", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: undefined,
-        a11YNotificationEnabled: undefined,
+        a11YScreenreaderModeEnabled: undefined,
       } as any; // so that we can set value to undefined
       const result = accessibility.getters.isHighContrastModeEnabled(state);
       expect(result).toBeFalsy();
     });
   });
-  describe("getters:isA11YNotificationEnabled", () => {
+  describe("getters:isA11YScreenreaderModeEnabled", () => {
     it("should return current value if a11 notification is set to false", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: false,
-        a11YNotificationEnabled: false,
+        a11YScreenreaderModeEnabled: false,
       };
-      const result = accessibility.getters.isA11YNotificationEnabled(state);
+      const result = accessibility.getters.isA11YScreenreaderModeEnabled(state);
       expect(result).toBeFalsy();
     });
     it("should return current value if a11 notification is set to true", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: false,
-        a11YNotificationEnabled: true,
+        a11YScreenreaderModeEnabled: true,
       };
-      const result = accessibility.getters.isA11YNotificationEnabled(state);
+      const result = accessibility.getters.isA11YScreenreaderModeEnabled(state);
       expect(result).toBeTruthy();
     });
     it("should return default value false if no value is set", () => {
       const state: AccessibilityState = {
         highContrastModeEnabled: undefined,
-        a11YNotificationEnabled: undefined,
+        a11YScreenreaderModeEnabled: undefined,
       } as any; // so that we can set value to undefined
-      const result = accessibility.getters.isA11YNotificationEnabled(state);
+      const result = accessibility.getters.isA11YScreenreaderModeEnabled(state);
       expect(result).toBeFalsy();
     });
   });

diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/store/modules/accessibility.ts b/digiwf-apps/packages/apps/digiwf-tasklist/src/store/modules/accessibility.ts
@@ -2,12 +2,12 @@ import { useStore } from "../../hooks/store";
 
 export interface AccessibilityState {
   highContrastModeEnabled: boolean;
-  a11YNotificationEnabled: boolean;
+  a11YScreenreaderModeEnabled: boolean;
 }
 
 const defaultAccessibilityState: AccessibilityState = {
   highContrastModeEnabled: false,
-  a11YNotificationEnabled: false,
+  a11YScreenreaderModeEnabled: false,
 };
 
 export const accessibility = {
@@ -19,25 +19,27 @@ export const accessibility = {
         ? state.highContrastModeEnabled
         : defaultAccessibilityState.highContrastModeEnabled;
     },
-    isA11YNotificationEnabled: (state: AccessibilityState): boolean => {
-      return state.a11YNotificationEnabled !== undefined
-        ? state.a11YNotificationEnabled
-        : defaultAccessibilityState.a11YNotificationEnabled;
+    isA11YScreenreaderModeEnabled: (state: AccessibilityState): boolean => {
+      return state.a11YScreenreaderModeEnabled !== undefined
+        ? state.a11YScreenreaderModeEnabled
+        : defaultAccessibilityState.a11YScreenreaderModeEnabled;
     },
   },
   mutations: {
     setHighContrastModeEnabled: (state: AccessibilityState, enabled: boolean) =>
       (state.highContrastModeEnabled = enabled),
-    setA11YNotificationEnabled: (state: AccessibilityState, enabled: boolean) =>
-      (state.a11YNotificationEnabled = enabled),
+    setA11YScreenreaderModeEnabled: (
+      state: AccessibilityState,
+      enabled: boolean
+    ) => (state.a11YScreenreaderModeEnabled = enabled),
   },
 };
 
 export interface Accessibility {
   isHighContrastModeEnabled: () => boolean;
   setHighContrastModeEnabled: (value: boolean) => void;
-  a11YNotificationEnabled: () => boolean;
-  setA11YNotificationEnabled: (value: boolean) => void;
+  a11YScreenreaderModeEnabled: () => boolean;
+  setA11YScreenreaderModeEnabled: (value: boolean) => void;
 }
 
 export const useAccessibility = (): Accessibility => {
@@ -47,9 +49,9 @@ export const useAccessibility = (): Accessibility => {
       store.getters["accessibility/isHighContrastModeEnabled"],
     setHighContrastModeEnabled: (enabled: boolean) =>
       store.commit("accessibility/setHighContrastModeEnabled", enabled),
-    a11YNotificationEnabled: () =>
-      store.getters["accessibility/isA11YNotificationEnabled"],
-    setA11YNotificationEnabled: (enabled: boolean) =>
-      store.commit("accessibility/setA11YNotificationEnabled", enabled),
+    a11YScreenreaderModeEnabled: () =>
+      store.getters["accessibility/isA11YScreenreaderModeEnabled"],
+    setA11YScreenreaderModeEnabled: (enabled: boolean) =>
+      store.commit("accessibility/setA11YScreenreaderModeEnabled", enabled),
   };
 };
diff --git a/digiwf-apps/packages/apps/digiwf-tasklist/src/views/TaskDetail.vue b/digiwf-apps/packages/apps/digiwf-tasklist/src/views/TaskDetail.vue
@@ -249,7 +249,7 @@ const safeValidation = ref(false);
 
 const {showMessageAndLeavePage} = useNotificationContext();
 
-const a11YNotificationEnabled = useAccessibility().a11YNotificationEnabled;
+const a11YScreenreaderModeEnabled = useAccessibility().a11YScreenreaderModeEnabled;
 
 /**
  * toggle for showing fab menu
@@ -379,7 +379,7 @@ const handleCompleteTask = (model: any) => {
 
 const handleSaveTask = (): Promise<void> => {
   hasChanges.value = false;
-  if (!a11YNotificationEnabled()) {
+  if (!a11YScreenreaderModeEnabled()) {
     safeValidation.value = true;
   }
   return saveTask(model.value)