UNPKG

827 BTypeScriptView Raw
1import * as React from 'react';
2import { OverridableComponent, OverrideProps } from '../OverridableComponent';
3
4export interface ListTypeMap<P = {}, D extends React.ElementType = 'ul'> {
5 props: P & {
6 dense?: boolean;
7 disablePadding?: boolean;
8 subheader?: React.ReactElement;
9 };
10 defaultComponent: D;
11 classKey: ListClassKey;
12}
13
14/**
15 *
16 * Demos:
17 *
18 * - [Lists](https://mui.com/components/lists/)
19 * - [Transfer List](https://mui.com/components/transfer-list/)
20 *
21 * API:
22 *
23 * - [List API](https://mui.com/api/list/)
24 */
25declare const List: OverridableComponent<ListTypeMap>;
26
27export type ListClassKey = 'root' | 'padding' | 'dense' | 'subheader';
28
29export type ListProps<
30 D extends React.ElementType = ListTypeMap['defaultComponent'],
31 P = {}
32> = OverrideProps<ListTypeMap<P, D>, D>;
33
34export default List;