react-native-paper
Version:
Material design for React Native
42 lines • 1.02 kB
TypeScript
import * as React from 'react';
import { StyleProp, View, ViewStyle } from 'react-native';
import type { ThemeProp } from '../../types';
import { IconSource } from '../Icon';
export type Props = React.ComponentPropsWithRef<typeof View> & {
/**
* Icon to display for the `Avatar`.
*/
icon: IconSource;
/**
* Size of the avatar.
*/
size?: number;
/**
* Custom color for the icon.
*/
color?: string;
style?: StyleProp<ViewStyle>;
/**
* @optional
*/
theme?: ThemeProp;
};
/**
* Avatars can be used to represent people in a graphical way.
*
* ## Usage
* ```js
* import * as React from 'react';
* import { Avatar } from 'react-native-paper';
*
* const MyComponent = () => (
* <Avatar.Icon size={24} icon="folder" />
* );
* ```
*/
declare const Avatar: {
({ icon, size, style, theme: themeOverrides, ...rest }: Props): React.JSX.Element;
displayName: string;
};
export default Avatar;
//# sourceMappingURL=AvatarIcon.d.ts.map