@amsterdam/design-system-react
Version:
All React components from the Amsterdam Design System. Use it to compose pages in your website or application.
69 lines (68 loc) • 2.24 kB
TypeScript
/**
* @license EUPL-1.2+
* Copyright Gemeente Amsterdam
*/
import type { HTMLAttributes } from 'react';
import type { HeadingProps } from '../Heading';
export type ErrorLink = {
id: string;
label: string;
};
export type InvalidFormAlertProps = {
/**
* The text following the error count.
* This is used to show the error count in the document title.
* @default { plural: 'invoerfouten', singular: 'invoerfout' }
*/
errorCountLabel?: {
plural: string;
singular: string;
};
/** The list of error messages to display. */
errors: ErrorLink[];
/**
* Whether the component receives focus on first render
* @default true
*/
focusOnRender?: boolean;
/**
* The text for the Heading.
* @default Verbeter de fouten voor u verder gaat
*/
heading?: string;
/**
* The hierarchical level of the Invalid Form Alert’s Heading within the document.
* There is no default value; determine the correct level for each instance.
* Note: this intentionally does not change the font size.
**/
headingLevel: HeadingProps['level'];
} & HTMLAttributes<HTMLDivElement>;
export declare const InvalidFormAlert: import("react").ForwardRefExoticComponent<{
/**
* The text following the error count.
* This is used to show the error count in the document title.
* @default { plural: 'invoerfouten', singular: 'invoerfout' }
*/
errorCountLabel?: {
plural: string;
singular: string;
};
/** The list of error messages to display. */
errors: ErrorLink[];
/**
* Whether the component receives focus on first render
* @default true
*/
focusOnRender?: boolean;
/**
* The text for the Heading.
* @default Verbeter de fouten voor u verder gaat
*/
heading?: string;
/**
* The hierarchical level of the Invalid Form Alert’s Heading within the document.
* There is no default value; determine the correct level for each instance.
* Note: this intentionally does not change the font size.
**/
headingLevel: HeadingProps["level"];
} & HTMLAttributes<HTMLDivElement> & import("react").RefAttributes<HTMLDivElement>>;