@payfit/unity-components
Version:
49 lines (48 loc) • 1.91 kB
TypeScript
import { VariantProps } from '@payfit/unity-themes';
import { PropsWithChildren } from 'react';
import { avatarBase } from '../Avatar.variants.js';
import * as React from 'react';
export type AvatarPairProps = PropsWithChildren<{
/** Variant of the avatar pair. they match the variants of the Avatar component */
variant: NonNullable<VariantProps<typeof avatarBase>['variant']>;
/**
* Set to true to visually hide the avatar pair
* @default false
*/
isHidden?: boolean;
/** Accessible label for the avatar */
'aria-label'?: string;
/** ID of the element that labels the avatar */
'aria-labelledby'?: string;
/** ID of the element that describes the avatar */
'aria-describedby'?: string;
/** Additional details for the avatar */
'aria-details'?: string;
/** Indicates if the avatar is hidden from assistive technologies */
'aria-hidden'?: boolean;
}>;
/**
* The `AvatarPair` component displays a paired, smaller avatar in the bottom-right corner of the containing avatar.
*/
declare const AvatarPair: React.ForwardRefExoticComponent<{
/** Variant of the avatar pair. they match the variants of the Avatar component */
variant: NonNullable<VariantProps<typeof avatarBase>["variant"]>;
/**
* Set to true to visually hide the avatar pair
* @default false
*/
isHidden?: boolean;
/** Accessible label for the avatar */
'aria-label'?: string;
/** ID of the element that labels the avatar */
'aria-labelledby'?: string;
/** ID of the element that describes the avatar */
'aria-describedby'?: string;
/** Additional details for the avatar */
'aria-details'?: string;
/** Indicates if the avatar is hidden from assistive technologies */
'aria-hidden'?: boolean;
} & {
children?: React.ReactNode | undefined;
} & React.RefAttributes<HTMLSpanElement>>;
export { AvatarPair };