@bdt-component-library/structured-list-item NPM

StructuredListItem Component

About

This is a component published as its own package from our component library monorepo: https://github.com/BenefitsDataTrust/ui-components. Setup instructions, as well as higher-level goals and concerns can be found from the main project README.

Description

Handles display of structured list items according to style guide conventions.

https://zeroheight.com/990ea04ab/p/654904-structured-list

API

prop	type	required	default	explanation
children	React node	yes	no	Handles the main body section of the list item
className	string	no	""	Adds an optional classname to the component
title	string	yes	no	Sets the title text for list item
metadata	string	yes	no	Sets the metadata text section for list item
actionLeft	React node	no	null	Adds optional component for the left-side action
actionRight	React node	no	null	Adds optional component for the right-side action
isRead	boolean	no	false	Determines if the list item is in the read or unread state