Have ideas?
Examples
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
React
Name | Type | Default | Description |
---|---|---|---|
children required | ReactNode | Review component's body content. | |
className | string | ||
editAriaLabel | string | Optional label to give screenreaders longer, more descriptive text to explain the context of an edit link. | |
editContent | 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 | ReactNode | ||
heading | ReactNode | ||
headingLevel | ReviewHeadingLevel | 3 | Heading type to override default <h3> . |
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. |
Styles
The following CSS variables can be overridden to customize Review patterns:
Component maturity
For more information about how we tested and validated our work for each checklist item, read our component maturity documentation.