UNPKG

@atlaskit/avatar

Version:

An avatar is a visual representation of a user or entity.

44 lines (43 loc) 1.32 kB
/** * @jsxRuntime classic * @jsx jsx */ import { type FC, type ReactNode } from 'react'; import { type AppearanceType, type IndicatorSizeType, type Status } from './types'; export interface StatusProps { /** * Override the default border color of the status indicator. This accepts * any color argument that the CSS property `border-color` accepts. */ borderColor?: string; /** * Content to use as a custom status indicator. Not needed if consuming * `Status` separate to `Avatar`. */ children?: ReactNode; /** * The type of status indicator to show. */ status?: Status; } /** * __Avatar status__ * * An avatar status shows contextual information, such as if someone approves or declines something. * * - [Examples](https://atlassian.design/components/avatar/avatar-status/examples) * - [Code](https://atlassian.design/components/avatar/avatar-status/code) */ declare const AvatarStatus: FC<StatusProps>; export default AvatarStatus; interface StatusWrapperProps extends StatusProps { appearance: AppearanceType; size: IndicatorSizeType; testId?: string; } /** * __Status wrapper__ * * A status wrapper is used internally to position status on top of the avatar. */ export declare const StatusWrapper: FC<StatusWrapperProps>;