@naturacosmeticos/natds-web
Version:
A collection of components from Natura Design System for React websites and webapps
36 lines (35 loc) • 1.24 kB
TypeScript
import { AvatarProps as MaterialAvatarProps } from '@material-ui/core/Avatar/Avatar';
import { IAvatarSizes } from '@naturacosmeticos/natds-styles';
export declare type AvatarColor = 'primary' | 'secondary' | 'default' | string;
export declare type AvatarSize = keyof IAvatarSizes;
/**
* @deprecated `rounded` and `square` variants are deprecated since version 0.19.
* They will be removed at version 1.0, when all Avatar variants will be `circle` by default.
*/
export declare type AvatarVariant = 'circle' | 'rounded' | 'square';
export interface IAvatarProps extends Omit<MaterialAvatarProps, 'variant'> {
/**
* The color of the Avatar, using the tokens from the current theme
*
* @default "default"
* @optional
* @type AvatarColors
*/
color?: AvatarColor;
/**
* The possible sizes of the Avatar
*
* @default "standard"
* @optional
* @todo Adopt new avatar sizes for 1.0
* @type AvatarSizes
*/
size?: AvatarSize;
/**
* The shape of the avatar.
*
* @deprecated `variant` property is deprecated since 0.19.0.
* It will be removed on 1.0 and all Avatar variants will be `circle` by default.
*/
variant?: AvatarVariant;
}