@atlaskit/avatar
Version:
An avatar is a visual representation of a user or entity.
45 lines (44 loc) • 1.39 kB
TypeScript
/**
* @jsxRuntime classic
* @jsx jsx
*/
import { type FC, type ReactNode } from 'react';
import { type AppearanceType, type IndicatorSizeType, type Presence } from './types';
export interface PresenceProps {
/**
* Used to override the default border color of the presence indicator.
* Accepts any color argument that the border-color CSS property accepts.
*/
borderColor?: string;
/**
* Content to use as a custom presence indicator (usually not required if
* consuming Presence separate to Avatar).
*/
children?: ReactNode;
/**
* The type of presence indicator to show.
*/
presence?: Presence;
}
/**
* __Avatar presence__
*
* A presence shows an avatar’s availability.
*
* - [Examples](https://atlassian.design/components/avatar/avatar-presence/examples)
* - [Code](https://atlassian.design/components/avatar/avatar-presence/code)
* - [Usage](https://atlassian.design/components/avatar/avatar-presence/usage)
*/
declare const AvatarPresence: FC<PresenceProps>;
export default AvatarPresence;
interface PresenceWrapperProps extends PresenceProps {
appearance: AppearanceType;
size: IndicatorSizeType;
testId?: string;
}
/**
* __Presence wrapper__
*
* A presence wrapper is used internally to position presence ontop of the avatar.
*/
export declare const PresenceWrapper: FC<PresenceWrapperProps>;