Update documentation

Amsterdam · Nov 5, 2024 · 2a2c373 · 2a2c373
1 parent a4d9306
commit 2a2c373
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git 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
@@ -15,7 +15,7 @@ import { Ratio } from '../AspectRatio'
 import { Image, ImageProps } from '../Image/Image'
 
 export type ImageSliderImageProps = Omit<ImageProps, 'aspectRatio'> & {
-  /** 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<Ratio, 'tall' | 'square' | 'wide' | 'x-wide'>
 }