@heroui/avatar
Version:
The Avatar component is used to represent a user, and displays the profile picture, initials or fallback icon.
139 lines (136 loc) • 4.31 kB
JavaScript
"use client";
import {
useAvatarGroupContext
} from "./chunk-JUJ53SJZ.mjs";
// src/use-avatar.ts
import { avatar } from "@heroui/theme";
import { useProviderContext } from "@heroui/system";
import { mergeProps } from "@react-aria/utils";
import { useDOMRef, filterDOMProps } from "@heroui/react-utils";
import { clsx, safeText, dataAttr } from "@heroui/shared-utils";
import { useFocusRing } from "@react-aria/focus";
import { useMemo, useCallback } from "react";
import { useImage } from "@heroui/use-image";
import { useHover } from "@react-aria/interactions";
function useAvatar(originalProps = {}) {
var _a, _b, _c, _d, _e, _f;
const globalContext = useProviderContext();
const groupContext = useAvatarGroupContext();
const isInGroup = !!groupContext;
const {
as,
ref,
src,
name,
icon,
classNames,
fallback,
alt = name || "avatar",
imgRef: imgRefProp,
color = (_a = groupContext == null ? void 0 : groupContext.color) != null ? _a : "default",
radius = (_b = groupContext == null ? void 0 : groupContext.radius) != null ? _b : "full",
size = (_c = groupContext == null ? void 0 : groupContext.size) != null ? _c : "md",
isBordered = (_d = groupContext == null ? void 0 : groupContext.isBordered) != null ? _d : false,
isDisabled = (_e = groupContext == null ? void 0 : groupContext.isDisabled) != null ? _e : false,
isFocusable = false,
getInitials = safeText,
ignoreFallback = false,
showFallback: showFallbackProp = false,
ImgComponent = "img",
imgProps,
className,
onError,
disableAnimation: disableAnimationProp,
...otherProps
} = originalProps;
const Component = as || "span";
const domRef = useDOMRef(ref);
const imgRef = useDOMRef(imgRefProp);
const { isFocusVisible, isFocused, focusProps } = useFocusRing();
const { isHovered, hoverProps } = useHover({ isDisabled });
const disableAnimation = (_f = disableAnimationProp != null ? disableAnimationProp : globalContext == null ? void 0 : globalContext.disableAnimation) != null ? _f : false;
const imageStatus = useImage({ src, onError, ignoreFallback });
const isImgLoaded = imageStatus === "loaded";
const shouldFilterDOMProps = typeof ImgComponent === "string";
const showFallback = (!src || !isImgLoaded) && showFallbackProp;
const slots = useMemo(
() => {
var _a2;
return avatar({
color,
radius,
size,
isBordered,
isDisabled,
isInGroup,
disableAnimation,
isInGridGroup: (_a2 = groupContext == null ? void 0 : groupContext.isGrid) != null ? _a2 : false
});
},
[
color,
radius,
size,
isBordered,
isDisabled,
disableAnimation,
isInGroup,
groupContext == null ? void 0 : groupContext.isGrid
]
);
const baseStyles = clsx(classNames == null ? void 0 : classNames.base, className);
const canBeFocused = useMemo(() => {
return isFocusable || as === "button";
}, [isFocusable, as]);
const getAvatarProps = useCallback(
(props = {}) => ({
ref: domRef,
tabIndex: canBeFocused ? 0 : -1,
"data-hover": dataAttr(isHovered),
"data-focus": dataAttr(isFocused),
"data-focus-visible": dataAttr(isFocusVisible),
className: slots.base({
class: clsx(baseStyles, props == null ? void 0 : props.className)
}),
...mergeProps(otherProps, hoverProps, canBeFocused ? focusProps : {})
}),
[canBeFocused, slots, baseStyles, focusProps, otherProps]
);
const getImageProps = useCallback(
(props = {}) => ({
ref: imgRef,
src,
"data-loaded": dataAttr(isImgLoaded),
className: slots.img({ class: classNames == null ? void 0 : classNames.img }),
...mergeProps(
imgProps,
props,
filterDOMProps({ disableAnimation }, {
enabled: shouldFilterDOMProps
})
)
}),
[slots, isImgLoaded, imgProps, disableAnimation, src, imgRef, shouldFilterDOMProps]
);
return {
Component,
ImgComponent,
src,
alt,
icon,
name,
imgRef,
slots,
classNames,
fallback,
isImgLoaded,
showFallback,
ignoreFallback,
getInitials,
getAvatarProps,
getImageProps
};
}
export {
useAvatar
};