import { BoxProps, ChakraComponent } from '@chakra-ui/react'; import { default as React } from 'react'; export declare const listVariantsArray: readonly ["ol", "ul", "dl"]; export type ListVariants = typeof listVariantsArray[number]; export interface DescriptionProps { term: string; description: string | JSX.Element; } export interface ListProps extends Omit { /** Display the list in a row. */ inline?: boolean; /** Data to render if children are not passed. For `listTypes` ordered `"ol"` * and unordered `"ul"` `List` types, the data structure is an array of strings * to renders as `li` items. For description `"dl"` `List` types, the data * structure is an array of objects with `term` and `description` properties * to render `dt` and `dd` elements, respectively. */ listItems?: (string | JSX.Element | DescriptionProps)[]; /** Remove list styling. */ noStyling?: boolean; /** Show dividers between rows for the description list variant. */ showRowDividers?: boolean; /** Optional string value used to set the text for a `Heading` component, or * a DS Heading component that can be passed in. This title only applies to * to Description Lists and will render above the list. */ title?: string | JSX.Element; /** The type of list: "ol", "ul", or "dl". "ul" by default. */ variant: ListVariants; } /** * A component that renders list item `li` elements or description item `dt` * and `dd` elements based on the `type` prop. Note that the `title` prop will * only display for the `Description` list type. */ export declare const List: ChakraComponent & React.RefAttributes>, React.PropsWithChildren>; export default List;