@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
53 lines (52 loc) • 2.24 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes } from 'react';
import { ImageProps } from '../Image/Image';
export type ImageSliderImageProps = ImageProps;
export type ImageSliderProps = {
/** Display buttons to navigate to the previous or next image. */
controls?: boolean;
/** Label for the image if you need to translate the alt text. */
imageLabel?: string;
/** The set of images to display. */
images: ImageSliderImageProps[];
/** The label for the ‘next’ button */
nextLabel?: string;
/** The label for the ‘previous’ button */
previousLabel?: string;
} & HTMLAttributes<HTMLDivElement>;
export declare const ImageSliderRoot: import("react").ForwardRefExoticComponent<{
/** Display buttons to navigate to the previous or next image. */
controls?: boolean;
/** Label for the image if you need to translate the alt text. */
imageLabel?: string;
/** The set of images to display. */
images: ImageSliderImageProps[];
/** The label for the ‘next’ button */
nextLabel?: string;
/** The label for the ‘previous’ button */
previousLabel?: string;
} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>>;
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-media-image-slider--docs Image Slider docs at Amsterdam Design System}
*/
export declare const ImageSlider: import("react").ForwardRefExoticComponent<{
/** Display buttons to navigate to the previous or next image. */
controls?: boolean;
/** Label for the image if you need to translate the alt text. */
imageLabel?: string;
/** The set of images to display. */
images: ImageSliderImageProps[];
/** The label for the ‘next’ button */
nextLabel?: string;
/** The label for the ‘previous’ button */
previousLabel?: string;
} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>> & {
Item: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLDivElement> & {
children?: import("react").ReactNode | undefined;
} & {
slideId: number;
} & import("react").RefAttributes<HTMLDivElement>>;
};