@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
34 lines (33 loc) • 1.67 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes, PropsWithChildren } from 'react';
export declare const descriptionListTermsWidths: readonly ["narrow", "medium", "wide"];
type DescriptionListTermsWidth = (typeof descriptionListTermsWidths)[number];
export type DescriptionListProps = PropsWithChildren<HTMLAttributes<HTMLDListElement>> & {
/** Changes the text colour for readability on a dark background. */
color?: 'inverse';
termsWidth?: DescriptionListTermsWidth;
};
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-text-description-list--docs Description List docs at Amsterdam Design System}
*/
export declare const DescriptionList: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLDListElement> & {
children?: import("react").ReactNode | undefined;
} & {
/** Changes the text colour for readability on a dark background. */
color?: "inverse";
termsWidth?: DescriptionListTermsWidth;
} & import("react").RefAttributes<HTMLDListElement>> & {
Description: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;
Section: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLDivElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLDivElement>>;
Term: import("react").ForwardRefExoticComponent<HTMLAttributes<HTMLElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLElement>>;
};
export {};