feat: excludes emoji from a11y container with alt caption

khiga8 · Aug 23, 2023 · 430502e · 430502e
1 parent 601b4fd
commit 430502e
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/src/utils.js b/src/utils.js
@@ -113,6 +113,11 @@ function validateImagesWithAnchorParent(parent, image) {
 }
 
 function validateImagesWithNonAnchorParent(parent, image) {
+  const isEmoji = image.classList.contains("emoji");
+  if (isEmoji) {
+    return;
+  }
+
   const hasAltTextAttribute = image.hasAttribute("alt");
   const altText = hasAltTextAttribute && image.getAttribute("alt").trim();
   if (!hasAltTextAttribute) {

diff --git a/tests/utils.test.js b/tests/utils.test.js
@@ -195,6 +195,22 @@ describe("validateImages", () => {
       expect(document.querySelector(".github-a11y-img-invalid-alt")).toBe(null);
     });
 
+    test("does not flag if image is an emoji", () => {
+      console.log("am i run");
+      document.body.innerHTML = `
+        <p id="cat">
+          <img class="emoji" alt="Some cat." src="some_cat.png" />
+        </p>
+      `;
+      const parent = document.querySelector("#cat");
+      const img = document.querySelector("img");
+      validateImages(parent, img);
+      const captionContainer = document.querySelector(
+        ".github-a11y-img-container"
+      );
+      expect(captionContainer).toBe(null);
+    });
+
     test("surfaces alt if image has alt", () => {
       document.body.innerHTML = `
         <p id="cat">