The review pattern is used for listing a summary of information entered by a user. Its content includes a heading, value, and edit link.
<Review>
The Review component wraps up the styles and markup required to make a single reviewable row. They are designed to be used either alone, as a single row, or multiple rows can be combined together one after the other to present more information. The component can take text or HTML as row content.
Code snippet
Props
| Name | Type | Default | Description |
|---|---|---|---|
childrenrequired | React.ReactNode |
| |
className | string | ||
editAriaLabel | string | Optional label to give screenreaders longer, more descriptive text to explain the context of an edit link. | |
editContent | React.ReactNode | An optional node in place of the edit link. If this defined, no edit link will be shown. | |
editHref | string | Href for the edit link. If this is undefined, no edit link will be shown. | |
editText | React.ReactNode | ||
heading | React.ReactNode | ||
headingLevel | '1' | '2' | '3' | '4' | '5' | '3' | Heading type to override default |
onEditClick | (...args: any[]) => any | An optional function that is executed on edit link click. The event and props.editHref value are passed to this function. |
Customization
The following Sass variables can be overridden to customize Review patterns: