From 5e62b72dcf2fce9b4dbf3a7aca4edbc62000abb5 Mon Sep 17 00:00:00 2001
From: James Mockett <1166188+jamesmockett@users.noreply.github.com>
Date: Mon, 18 Nov 2024 11:03:35 +0000
Subject: [PATCH] Add comment to `hideImageOverlay` prop

---
 .../src/components/Card/components/ImageWrapper.tsx          | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/dotcom-rendering/src/components/Card/components/ImageWrapper.tsx b/dotcom-rendering/src/components/Card/components/ImageWrapper.tsx
index dd58f64cbf..12ee210217 100644
--- a/dotcom-rendering/src/components/Card/components/ImageWrapper.tsx
+++ b/dotcom-rendering/src/components/Card/components/ImageWrapper.tsx
@@ -36,6 +36,11 @@ type Props = {
 	imagePositionOnDesktop: ImagePositionType;
 	imagePositionOnMobile: ImagePositionType;
 	showPlayIcon: boolean;
+	/**
+	 * Forces hiding the image overlay added to pictures & slideshows on hover.
+	 * This is to allow hiding the overlay on slideshow carousels where we don't
+	 * want it to be shown whilst retaining it for existing slideshows.
+	 */
 	hideImageOverlay?: boolean;
 };