UNPKG

957 BTypeScriptView Raw
1import * as React from "react";
2import * as StyledSystem from "styled-system";
3import { BoxProps } from "../Box";
4import { Omit } from "../common-types";
5import { IconProps } from "../Icon";
6import { PseudoBoxProps } from "../PseudoBox";
7
8interface IList {
9 /**
10 * The `list-style-type` of the list
11 */
12 styleType?: StyledSystem.ResponsiveValue<
13 React.CSSProperties["listStyleType"]
14 >;
15 /**
16 * The `list-style-position` of the list
17 */
18 stylePos?: StyledSystem.ResponsiveValue<
19 React.CSSProperties["listStylePosition"]
20 >;
21 /**
22 * The space between each list item
23 */
24 spacing?: StyledSystem.MarginBottomProps["marginBottom"];
25}
26
27type ListProps = IList & BoxProps;
28declare const List: React.FC<ListProps>;
29export const ListItem: React.FC<PseudoBoxProps>;
30
31type ListIconProps = Omit<IconProps, "name"> & {
32 icon: IconProps["name"] | React.ComponentType;
33};
34
35export const ListIcon: React.FC<ListIconProps>;
36
37export default List;