fix: rename erroneous title attribute to alt

igordanchenko · Jun 1, 2022 · d9be101 · d9be101
1 parent 6cc2a91
commit d9be101
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 9 deletions.
diff --git a/src/core/components/ImageSlide.tsx b/src/core/components/ImageSlide.tsx
@@ -67,7 +67,7 @@ export const ImageSlide = ({ slide: image, render }: ImageSlideProps) => {
                 onError={onError}
                 className={clsx(cssClass("slide_image"), state !== "complete" && cssClass("slide_image_loading"))}
                 draggable={false}
-                alt={image.title}
+                alt={image.alt}
                 {...(image.srcSet
                     ? {
                           // this approach does not account for carousel padding,

diff --git a/src/types.ts b/src/types.ts
@@ -3,23 +3,24 @@ import PropTypes from "prop-types";
 
 /** Image slide properties */
 export interface SlideImage {
-    /** Image URL */
+    /** image URL */
     src?: string;
-    title?: string;
-    /** Image aspect ratio */
+    /** image 'alt' attribute */
+    alt?: string;
+    /** image aspect ratio */
     aspectRatio?: number;
-    /** Alternative images to be passed to 'srcSet' */
+    /** alternative images to be passed to 'srcSet' */
     srcSet?: {
-        /** Image URL */
+        /** image URL */
         src: string;
-        /** Image width in pixels */
+        /** image width in pixels */
         width: number;
     }[];
 }
 
 /** Supported slide types */
 export interface SlideTypes {
-    /** Image slide type */
+    /** image slide type */
     SlideImage: SlideImage;
 }
 
@@ -90,7 +91,7 @@ export interface Callbacks {
 
 /** Lightbox properties */
 export interface LightboxProps {
-    /** Open flag. If true, the lightbox is open. */
+    /** if `true`, the lightbox is open */
     open: boolean;
     /** a callback to close the lightbox */
     close: () => void;