From f74a107b3c49a0e00bd867ac5758546e2ea965a7 Mon Sep 17 00:00:00 2001 From: Vincent Smedinga Date: Fri, 26 Jul 2024 14:47:09 +0200 Subject: [PATCH] chore: Document default values for Form Error List (#1458) --- packages/react/src/FormErrorList/FormErrorList.tsx | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/packages/react/src/FormErrorList/FormErrorList.tsx b/packages/react/src/FormErrorList/FormErrorList.tsx index 9f0b11ab9c..2b7d8bc48c 100644 --- a/packages/react/src/FormErrorList/FormErrorList.tsx +++ b/packages/react/src/FormErrorList/FormErrorList.tsx @@ -18,17 +18,25 @@ export type FormErrorListProps = { /** * 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: FormError[] - /** Whether the component receives focus on first render */ + /** + * Whether the component receives focus on first render + * @default true + */ focusOnRender?: boolean - /** The text for the Heading. */ + /** + * The text for the Heading. + * @default Verbeter de fouten voor u verder gaat + */ heading?: string /** * The hierarchical level of the Heading within the document. * Note: this intentionally does not change the font size. + * @default 2 */ headingLevel?: HeadingProps['level'] } & HTMLAttributes