UNPKG

1.02 kBTypeScriptView Raw
1/// <reference types="react" />
2import { ViewStyle, StyleProp } from 'react-native';
3import { IconSource } from '../Icon';
4declare type Props = {
5 /**
6 * Icon to show.
7 */
8 icon: IconSource;
9 /**
10 * Color for the icon.
11 */
12 color?: string;
13 style?: StyleProp<ViewStyle>;
14};
15/**
16 * A component to show an icon in a list item.
17 *
18 * <div class="screenshots">
19 * <figure>
20 * <img class="medium" src="screenshots/list-icon.png" />
21 * </figure>
22 * </div>
23 *
24 * ## Usage
25 * ```js
26 * import * as React from 'react';
27 * import { List, Colors } from 'react-native-paper';
28 *
29 * const MyComponent = () => (
30 * <>
31 * <List.Icon color={Colors.blue500} icon="folder" />
32 * <List.Icon color={Colors.blue500} icon="equal" />
33 * <List.Icon color={Colors.blue500} icon="calendar" />
34 * </>
35 * );
36 *
37 * export default MyComponent;
38 * ```
39 */
40declare const ListIcon: {
41 ({ icon, color: iconColor, style }: Props): JSX.Element;
42 displayName: string;
43};
44export default ListIcon;