carbon-react
Version:
A library of reusable React components for easily building user interfaces.
35 lines (34 loc) • 1.35 kB
TypeScript
import React from "react";
import { MarginProps } from "styled-system";
import { TagProps } from "../../__internal__/utils/helpers/tags/tags";
import { ProfileSize } from "./profile.config";
export interface ProfileProps extends MarginProps, TagProps {
/**
* @private
* @internal
* @ignore
* Sets className for component. INTERNAL USE ONLY. */
className?: string;
/** Custom source URL */
src?: string;
/** The `alt` HTML string. */
alt?: string;
/** Define the name to display. */
name?: string;
/** Define the email to use. */
email?: string;
/** Define read-only text to display. */
text?: string;
/** Define initials to display image. */
initials?: string;
/** Allow to setup size for the component */
size?: ProfileSize;
/** Use a dark background. */
darkBackground?: boolean;
/** The hex code of the background colour to be passed to the avatar */
backgroundColor?: string;
/** The hex code of the foreground colour to be passed to the avatar. Must be used in conjunction with `backgroundColor` */
foregroundColor?: string;
}
export declare const Profile: ({ src, alt, className, initials, name, size, email, text, darkBackground, backgroundColor, foregroundColor, ...props }: ProfileProps) => React.JSX.Element;
export default Profile;