Merge branch 'main' into update-icons-1730902902

shopware · Nov 7, 2024 · 81f4a97 · 81f4a97
2 parents c9a47fb + ed9bf7a
commit 81f4a97
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 85 deletions.
diff --git a/.changeset/rude-shoes-rush.md b/.changeset/rude-shoes-rush.md
@@ -0,0 +1,5 @@
+---
+"@shopware-ag/meteor-component-library": patch
+---
+
+Improve accessibility of mt-field-error
diff --git a/.../src/components/feedback-indicator/mt-progress-bar/mt-progress-bar.interactive.stories.ts b/.../src/components/feedback-indicator/mt-progress-bar/mt-progress-bar.interactive.stories.ts
@@ -83,14 +83,6 @@ export const VisualTestError: MtProgressBarStory = {
       detail: "Error while sending variants",
     },
   },
-  play: async ({ canvasElement }) => {
-    const canvas = within(canvasElement);
-
-    const errorMessage = canvas.getByLabelText("Error message");
-
-    expect(errorMessage).toBeDefined();
-    expect(errorMessage.innerText).toContain("Error while sending variants");
-  },
 };
 
 export const VisualTestLabel: MtProgressBarStory = {

diff --git a/packages/component-library/src/components/form/_internal/mt-field-error/mt-field-error.vue b/packages/component-library/src/components/form/_internal/mt-field-error/mt-field-error.vue
@@ -1,106 +1,82 @@
 <template>
   <mt-text
+    v-if="!!error"
     as="span"
     size="2xs"
     color="color-text-critical-default"
-    v-if="!!error"
     class="mt-field__error"
-    aria-label="Error message"
   >
-    <mt-icon name="solid-exclamation-circle" />
-    {{ errorMessage }}
+    <mt-icon name="solid-exclamation-circle" size="0.75rem" aria-hidden="true" />
+
+    <span>{{ errorMessage }}</span>
   </mt-text>
 </template>
 
-<script lang="ts">
-import { defineComponent } from "vue";
+<script setup lang="ts">
+import { computed } from "vue";
 import MtIcon from "../../../icons-media/mt-icon/mt-icon.vue";
 import MtText from "@/components/content/mt-text/mt-text.vue";
+import { useI18n } from "@/composables/useI18n";
 
-export default defineComponent({
-  name: "MtFieldError",
+const props = defineProps<{
+  error?: Record<string, any> | null;
+}>();
 
-  i18n: {
-    messages: {
-      en: {
-        "mt-field-error": {
-          FRAMEWORK__MISSING_PRIVILEGE_ERROR: "Missing permissions",
-          FRAMEWORK__DELETE_RESTRICTED: "Deletion failed",
-          INVALID_MEDIA_URL: "Please enter a valid URL to upload a file.",
-          CONTENT__MISSING_RULE_TYPE_EXCEPTION: "You must choose a type for this rule.",
-          CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT:
-            "The type can not be assigned while category is an entry point.",
-          SHOPWARE_INVALID_IP: "Please enter a valid IP address.",
-          INVALID_URL: "Please enter a valid url.",
-          INVALID_MAIL: "Please enter a valid email address.",
-          FRAMEWORK__RATE_LIMIT_EXCEEDED:
-            "Too many requests. Please wait {seconds} seconds before trying again.",
-          DUPLICATED_URL: "This URL is already in use. Please choose another URL.",
-          "c1051bb4-d103-4f74-8988-acbcafc7fdc3": "This field must not be empty.",
-        },
-      },
-      de: {
-        "mt-field-error": {
-          FRAMEWORK__MISSING_PRIVILEGE_ERROR: "Fehlende Berechtigungen",
-          FRAMEWORK__DELETE_RESTRICTED: "Löschen fehlgeschlagen",
-          INVALID_MEDIA_URL: "Bitte gib eine gültige URL ein, um eine Datei hochzuladen.",
-          CONTENT__MISSING_RULE_TYPE_EXCEPTION: "Du musst einen Typ für diese Regel auswählen.",
-          CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT:
-            "Dieser Typ kann nicht gewählt werden, während die Kategorie als Einstiegspunkt festgelegt ist.",
-          SHOPWARE_INVALID_IP: "Bitte gib eine gültige IP-Adresse ein.",
-          INVALID_URL: "Bitte gib eine gültige URL ein.",
-          INVALID_MAIL: "Bitte gib eine gültige E-Mail-Adresse ein.",
-          FRAMEWORK__RATE_LIMIT_EXCEEDED:
-            "Zu viele Anfragen. Bitte warten Sie {seconds} Sekunden, bevor Sie es erneut versuchen.",
-          DUPLICATED_URL: "Diese URL wird bereits genutzt. Bitte wähle eine andere Domain.",
-          "c1051bb4-d103-4f74-8988-acbcafc7fdc3": "Dieses Feld darf nicht leer sein",
-        },
-      },
-    },
-  },
+const errorMessage = computed(() => {
+  if (!props.error) return "";
 
-  components: {
-    "mt-icon": MtIcon,
-    "mt-text": MtText,
-  },
+  const translation = t(props.error.code, props.error.parameters || {});
+  const noTranslationFound = translation === props.error.code;
 
-  props: {
-    error: {
-      type: Object,
-      required: false,
-      default: null,
-    },
-  },
-
-  computed: {
-    errorMessage(): string {
-      if (!this.error) {
-        return "";
-      }
-
-      const translationKey = `mt-field-error.${this.error.code}`;
-      const translation = this.$tc(translationKey, 1, this.error.parameters || {});
+  return noTranslationFound ? props.error.detail : translation;
+});
 
-      if (translation === translationKey) {
-        return this.error.detail;
-      }
-      return translation;
+const { t } = useI18n({
+  messages: {
+    en: {
+      "mt-field-error": {
+        FRAMEWORK__MISSING_PRIVILEGE_ERROR: "Missing permissions",
+        FRAMEWORK__DELETE_RESTRICTED: "Deletion failed",
+        INVALID_MEDIA_URL: "Please enter a valid URL to upload a file.",
+        CONTENT__MISSING_RULE_TYPE_EXCEPTION: "You must choose a type for this rule.",
+        CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT:
+          "The type can not be assigned while category is an entry point.",
+        SHOPWARE_INVALID_IP: "Please enter a valid IP address.",
+        INVALID_URL: "Please enter a valid url.",
+        INVALID_MAIL: "Please enter a valid email address.",
+        FRAMEWORK__RATE_LIMIT_EXCEEDED:
+          "Too many requests. Please wait {seconds} seconds before trying again.",
+        DUPLICATED_URL: "This URL is already in use. Please choose another URL.",
+        "c1051bb4-d103-4f74-8988-acbcafc7fdc3": "This field must not be empty.",
+      },
+    },
+    de: {
+      "mt-field-error": {
+        FRAMEWORK__MISSING_PRIVILEGE_ERROR: "Fehlende Berechtigungen",
+        FRAMEWORK__DELETE_RESTRICTED: "Löschen fehlgeschlagen",
+        INVALID_MEDIA_URL: "Bitte gib eine gültige URL ein, um eine Datei hochzuladen.",
+        CONTENT__MISSING_RULE_TYPE_EXCEPTION: "Du musst einen Typ für diese Regel auswählen.",
+        CONTENT__INVALID_CATEGORY_TYPE_AS_ENTRY_POINT:
+          "Dieser Typ kann nicht gewählt werden, während die Kategorie als Einstiegspunkt festgelegt ist.",
+        SHOPWARE_INVALID_IP: "Bitte gib eine gültige IP-Adresse ein.",
+        INVALID_URL: "Bitte gib eine gültige URL ein.",
+        INVALID_MAIL: "Bitte gib eine gültige E-Mail-Adresse ein.",
+        FRAMEWORK__RATE_LIMIT_EXCEEDED:
+          "Zu viele Anfragen. Bitte warten Sie {seconds} Sekunden, bevor Sie es erneut versuchen.",
+        DUPLICATED_URL: "Diese URL wird bereits genutzt. Bitte wähle eine andere Domain.",
+        "c1051bb4-d103-4f74-8988-acbcafc7fdc3": "Dieses Feld darf nicht leer sein",
+      },
     },
   },
 });
 </script>
 
-<style lang="scss">
+<style scoped>
 .mt-field__error {
   display: flex;
   align-items: center;
   gap: 4px;
   margin-top: 4px;
-
-  #meteor-icon-kit__solid-exclamation-circle {
-    width: 12px;
-    height: 12px;
-    color: var(--color-icon-critical-default);
-  }
+  color: var(--color-icon-critical-default);
 }
 </style>