@rws-aoa/react-library/dist/components/atoms/list/List.d.ts

RWS AOA Design System

import { SxProps } from '@mui/material';
import { JSX } from 'react';
export interface AoaListItem {
    /**
     * Data-qa tag to apply to the list item
     */
    readonly dataQa?: string;
    /**
     * Key of the list item
     */
    readonly key: string;
    /**
     * Value of the list item
     */
    readonly value: JSX.Element | string;
}
export interface AoaListProps {
    /**
     * Data-qa tag to apply to the list
     */
    readonly 'data-qa'?: string;
    /**
     * Key-value pairs to show as a list
     */
    readonly listItems: AoaListItem[];
    /**
     * Any additional CSSProperties to pass to the component
     */
    readonly sx?: SxProps;
}
/**
 * Creates a key-value list using pre-defined Rijkswaterstaat styling
 *
 * @example
 * ```jsx
 *
 * <AoaList listItems={[{ key: 'Name', value: 'John Connor' }]} />
 *
 * ```
 */
export declare function AoaList({ listItems, 'data-qa': dataQa, sx }: AoaListProps): import("react/jsx-runtime").JSX.Element;
//# sourceMappingURL=List.d.ts.map