Skip to content

Commit

Permalink
chore: Document default values for Form Error List (#1458)
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentSmedinga authored Jul 26, 2024
1 parent 72bff49 commit f74a107
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions packages/react/src/FormErrorList/FormErrorList.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -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<HTMLDivElement>
Expand Down

0 comments on commit f74a107

Please sign in to comment.