gestalt
Version:
A set of React UI components which enforce Pinterest's design language
23 lines (22 loc) • 1.12 kB
TypeScript
import { ReactElement, ReactNode } from 'react';
type Props = {
/**
* Use List.Item to build nested lists. Use List to combine different types nested lists. See [subcomponents](https://gestalt.pinterest.systems/web/list#Subcomponents).
*/
children?: ReactNode;
/**
* The content of the list item. See the [text variant](https://gestalt.pinterest.systems/web/list#Text-and-label) for guidance.
*/
text: string | ReactElement;
};
/**
* [List.Item](https://gestalt.pinterest.systems/web/list#List.Item) is a subcomponent of [List](https://gestalt.pinterest.systems/web/list). List.Item represents the `<li>` tag nested within a `<ul>` or `<ol>` list tag.
*
* Lists that don't require a alternating between "ordered", "unordered" or "base" can just nest List.Item into each other to build nested lists. If type alternation is required, use [List](https://gestalt.pinterest.systems/web/list#List)
*
*/
declare function ListItem({ text, children }: Props): import("react/jsx-runtime").JSX.Element;
declare namespace ListItem {
var displayName: string;
}
export default ListItem;