@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
31 lines (30 loc) • 1.26 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { OlHTMLAttributes, PropsWithChildren } from 'react';
export type OrderedListProps = PropsWithChildren<OlHTMLAttributes<HTMLOListElement>> & {
/** Changes the text colour for readability on a dark background. */
color?: 'inverse';
/** Whether the list items show a marker. */
markers?: boolean;
/** The size of the text. */
size?: 'small';
};
/**
* @see {@link https://designsystem.amsterdam/?path=/docs/components-text-ordered-list--docs Ordered List docs at Amsterdam Design System}
*/
export declare const OrderedList: import("react").ForwardRefExoticComponent<OlHTMLAttributes<HTMLOListElement> & {
children?: import("react").ReactNode | undefined;
} & {
/** Changes the text colour for readability on a dark background. */
color?: "inverse";
/** Whether the list items show a marker. */
markers?: boolean;
/** The size of the text. */
size?: "small";
} & import("react").RefAttributes<HTMLOListElement>> & {
Item: import("react").ForwardRefExoticComponent<import("react").LiHTMLAttributes<HTMLLIElement> & {
children?: import("react").ReactNode | undefined;
} & import("react").RefAttributes<HTMLLIElement>>;
};