@kubit-ui-web/react-components
Version:
Kubit React Components is a customizable, accessible library of React web components, designed to enhance your application's user experience
22 lines (21 loc) • 818 B
TypeScript
import React from 'react';
import { IAvatar } from './types/avatar';
declare const AvatarBoundary: <S extends string | undefined>(props: IAvatar<S>, ref: React.ForwardedRef<HTMLDivElement | HTMLButtonElement>) => JSX.Element;
/**
* @description
* Avatar component is a component that shows an icon, image or initials.
* @param {React.PropsWithChildren<IAvatar<S>>} props
* @returns {JSX.Element}
* @example
* <Avatar
* dataTestId="avatar"
* icon={<Icon name="user" />}
* initials="JD"
* image="https://www.w3schools.com/howto/img_avatar.png"
* size="M"
* />
*/
declare const Avatar: <S extends string | unknown>(props: React.PropsWithChildren<IAvatar<S>> & {
ref?: React.ForwardedRef<HTMLDivElement | HTMLButtonElement> | undefined | null;
}) => ReturnType<typeof AvatarBoundary>;
export { Avatar };