54 lines
1.2 KiB
TypeScript
54 lines
1.2 KiB
TypeScript
import * as React from "react";
|
|
import ReactToolbox from "../index";
|
|
|
|
export interface AvatarTheme {
|
|
/**
|
|
* Used for the root class of the element.
|
|
*/
|
|
avatar?: string;
|
|
/**
|
|
* Added to the root element when the component has image.
|
|
*/
|
|
image?: string;
|
|
/**
|
|
* Used for the root element if the component shows the letter.
|
|
*/
|
|
letter?: string;
|
|
}
|
|
|
|
export interface AvatarProps extends ReactToolbox.Props {
|
|
/**
|
|
* Children to pass through the component.
|
|
*/
|
|
children?: React.ReactNode;
|
|
/**
|
|
* Set to true if your image is not squared so it will be used as a cover for the element.
|
|
* @default false
|
|
*/
|
|
cover?: boolean;
|
|
/**
|
|
* A key to identify an Icon from Material Design Icons or a custom Icon Element.
|
|
*/
|
|
icon?: React.ReactNode;
|
|
/**
|
|
* An image source or an image element.
|
|
*/
|
|
image?: React.ReactNode;
|
|
/**
|
|
* Classnames object defining the component style.
|
|
*/
|
|
theme?: AvatarTheme;
|
|
/**
|
|
* A title for the image. If no image is provided, the first letter will be displayed as the avatar.
|
|
*/
|
|
title?: string;
|
|
/**
|
|
* Additional properties for component root element.
|
|
*/
|
|
[key: string]: any;
|
|
}
|
|
|
|
export class Avatar extends React.Component<AvatarProps, {}> { }
|
|
|
|
export default Avatar;
|