@veracity/vui/dist/avatar/avatar.types.d.ts

Veracity UI is a React component library crafted for use within Veracity applications and pages. Based on Styled Components and @xstyled.

import { ThemingProps } from "../theme/types.js";
import "../theme/index.js";
import { SystemProps } from "../system/system.js";
import "../system/index.js";
import { IconProp } from "../icon/icon.types.js";
import "../icon/index.js";
//#region src/avatar/avatar.types.d.ts
type AvatarProps = SystemProps & ThemingProps<'Avatar'> & {
  /** Available theme colors for this component. @deprecated */
  colorScheme?: 'blue' | 'green' | 'grey' | 'prussian' | 'red' | 'yellow';
  /** Displays avatar in disabled state with appropriate styling. */
  disabled?: boolean;
  /** Custom function to compute initials based on the provided name. */
  getInitials?: (name: string) => string;
  /** Renders an icon as the only content. */
  icon?: IconProp;
  /** Makes avatar clickable and focusable with correct styling. */
  isInteractive?: boolean;
  /** Displays Avatar with slightly rounded corners. */
  isSquare?: boolean;
  /** Displays initials of the provided name. */
  name?: string;
  /** Displays an image loaded from the given URL. */
  src?: string;
};
//#endregion
export { AvatarProps };

//# sourceMappingURL=avatar.types.d.ts.map