From 2a2c373ccf3496c8b79c702d6dd3837683ec56ef Mon Sep 17 00:00:00 2001 From: Vincent Smedinga Date: Tue, 5 Nov 2024 20:27:47 +0100 Subject: [PATCH] Update documentation --- packages/css/src/components/image-slider/README.md | 2 ++ packages/react/src/ImageSlider/ImageSlider.tsx | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/css/src/components/image-slider/README.md b/packages/css/src/components/image-slider/README.md index 7fd89082ce..92d818f70d 100644 --- a/packages/css/src/components/image-slider/README.md +++ b/packages/css/src/components/image-slider/README.md @@ -17,6 +17,8 @@ The images do not slide automatically. - Use this for a series of images that belong together. - Provide at least 2 images and at most 5. - Feature the most essential image first. +- All images must have the same aspect ratio. + Note that very wide or tall aspect ratios are not supported. - Assume that some or many users will not navigate between the slides and only see the first image. Display all images separately if you want each of them to receive attention. - A full-width Image Slider should run from one edge of the Screen to the other; diff --git a/packages/react/src/ImageSlider/ImageSlider.tsx b/packages/react/src/ImageSlider/ImageSlider.tsx index 0e300d15b0..1608421fb9 100644 --- a/packages/react/src/ImageSlider/ImageSlider.tsx +++ b/packages/react/src/ImageSlider/ImageSlider.tsx @@ -15,7 +15,7 @@ import { Ratio } from '../AspectRatio' import { Image, ImageProps } from '../Image/Image' export type ImageSliderImageProps = Omit & { - /** Specify the aspect ratio to use for the images. */ + /** The aspect ratio to use for the images. Options: `tall`, `square`, `wide`, and `x-wide`. */ aspectRatio: Pick }