@yamada-ui/react/dist/cjs/components/avatar/use-avatar.cjs.map

React UI components of the Yamada, by the Yamada, for the Yamada built with React and Emotion

{"version":3,"file":"use-avatar.cjs","names":["useI18n","getGroupProps: PropGetter","getRootProps: PropGetter","getImageProps: PropGetter<\"img\">","mergeRefs"],"sources":["../../../../src/components/avatar/use-avatar.ts"],"sourcesContent":["\"use client\"\n\nimport type { ReactElement, ReactNode } from \"react\"\nimport type { HTMLProps, PropGetter } from \"../../core\"\nimport { useCallback, useEffect, useRef, useState } from \"react\"\nimport { useI18n } from \"../../providers/i18n-provider\"\nimport { dataAttr, handlerAll, mergeRefs } from \"../../utils\"\n\nconst defaultFormat = (name: string) => {\n  const names = name.trim().split(\" \")\n  const firstName = names[0] ?? \"\"\n  const lastName = names.length > 1 ? names[names.length - 1] : \"\"\n\n  return firstName && lastName\n    ? `${firstName.charAt(0)}${lastName.charAt(0)}`\n    : firstName.charAt(0)\n}\n\nexport interface UseAvatarProps extends HTMLProps {\n  /**\n   * The name of the person in the avatar.\n   *\n   * - If `src` has loaded, the name will be used as the `alt` attribute of the `img`\n   * - If `src` is not loaded, the name will be used to create the initials\n   */\n  name?: string\n  /**\n   * The image url of the avatar.\n   */\n  src?: HTMLProps<\"img\">[\"src\"]\n  /**\n   * List of sources to use for different screen resolutions.\n   */\n  srcSet?: HTMLProps<\"img\">[\"srcSet\"]\n  /**\n   * The `HTMLImageElement` property `alt`.\n   */\n  alt?: HTMLProps<\"img\">[\"alt\"]\n  /**\n   * The `HTMLImageElement` property `crossOrigin`.\n   */\n  crossOrigin?: HTMLProps<\"img\">[\"crossOrigin\"]\n  /**\n   * The fallback text to display if the image is not provided.\n   */\n  fallback?: ReactNode\n  /**\n   * Function to get the initials to display.\n   */\n  format?: (name: string) => string\n  /**\n   * The avatar icon to use.\n   */\n  icon?: ReactElement\n  /**\n   * Defines loading strategy.\n   */\n  loading?: HTMLProps<\"img\">[\"loading\"]\n  /**\n   * Defining which referrer is sent when fetching the resource.\n   *\n   * @default 'no-referrer'\n   */\n  referrerPolicy?: HTMLProps<\"img\">[\"referrerPolicy\"]\n}\n\nexport const useAvatar = ({\n  name,\n  src,\n  srcSet,\n  alt,\n  crossOrigin,\n  fallback: fallbackMessage,\n  format = defaultFormat,\n  icon,\n  loading,\n  referrerPolicy = \"no-referrer\",\n  ...rest\n}: UseAvatarProps = {}) => {\n  const imageRef = useRef<HTMLImageElement>(null)\n  const initials = name ? format(name) : undefined\n  const [loaded, setLoaded] = useState<boolean>(false)\n  const fallback = !src || !loaded\n  const { t } = useI18n(\"avatar\")\n\n  useEffect(() => {\n    if (!imageRef.current) return\n\n    if (!!imageRef.current.src && imageRef.current.complete) setLoaded(true)\n  }, [])\n\n  const getGroupProps: PropGetter = useCallback((props) => ({ ...props }), [])\n\n  const getRootProps: PropGetter = useCallback(\n    (props) => ({\n      ...rest,\n      ...props,\n      \"data-fallback\": dataAttr(!!fallbackMessage),\n      \"data-loaded\": dataAttr(loaded),\n    }),\n    [loaded, fallbackMessage, rest],\n  )\n\n  const getImageProps: PropGetter<\"img\"> = useCallback(\n    ({ ref, onLoad, ...props } = {}) => ({\n      ...props,\n      ref: mergeRefs(ref, imageRef),\n      src,\n      srcSet,\n      alt: name || alt,\n      crossOrigin,\n      draggable: false,\n      hidden: fallback,\n      loading,\n      referrerPolicy,\n      onLoad: handlerAll(onLoad, () => setLoaded(true)),\n    }),\n    [src, srcSet, alt, crossOrigin, loading, referrerPolicy, fallback, name],\n  )\n\n  const getFallbackProps: PropGetter = useCallback(\n    (props) => ({\n      ...props,\n      \"aria-label\": !fallbackMessage\n        ? name || alt || t(\"Avatar Icon\")\n        : undefined,\n      children: fallbackMessage || initials || icon,\n      hidden: !fallback,\n      role: \"img\",\n    }),\n    [name, initials, fallback, icon, fallbackMessage, alt, t],\n  )\n\n  return {\n    name,\n    loaded,\n    getFallbackProps,\n    getGroupProps,\n    getImageProps,\n    getRootProps,\n  }\n}\n\nexport type UseAvatarReturn = ReturnType<typeof useAvatar>\n"],"mappings":";;;;;;;;;;;AAQA,MAAM,iBAAiB,SAAiB;CACtC,MAAM,QAAQ,KAAK,MAAM,CAAC,MAAM,IAAI;CACpC,MAAM,YAAY,MAAM,MAAM;CAC9B,MAAM,WAAW,MAAM,SAAS,IAAI,MAAM,MAAM,SAAS,KAAK;AAE9D,QAAO,aAAa,WAChB,GAAG,UAAU,OAAO,EAAE,GAAG,SAAS,OAAO,EAAE,KAC3C,UAAU,OAAO,EAAE;;AAmDzB,MAAa,aAAa,EACxB,MACA,KACA,QACA,KACA,aACA,UAAU,iBACV,SAAS,eACT,MACA,SACA,iBAAiB,cACjB,GAAG,SACe,EAAE,KAAK;CACzB,MAAM,6BAAoC,KAAK;CAC/C,MAAM,WAAW,OAAO,OAAO,KAAK,GAAG;CACvC,MAAM,CAAC,QAAQ,iCAA+B,MAAM;CACpD,MAAM,WAAW,CAAC,OAAO,CAAC;CAC1B,MAAM,EAAE,MAAMA,8BAAQ,SAAS;AAE/B,4BAAgB;AACd,MAAI,CAAC,SAAS,QAAS;AAEvB,MAAI,CAAC,CAAC,SAAS,QAAQ,OAAO,SAAS,QAAQ,SAAU,WAAU,KAAK;IACvE,EAAE,CAAC;CAEN,MAAMC,wCAAyC,WAAW,EAAE,GAAG,OAAO,GAAG,EAAE,CAAC;CAE5E,MAAMC,uCACH,WAAW;EACV,GAAG;EACH,GAAG;EACH,iEAA0B,CAAC,CAAC,gBAAgB;EAC5C,+DAAwB,OAAO;EAChC,GACD;EAAC;EAAQ;EAAiB;EAAK,CAChC;CAED,MAAMC,wCACH,EAAE,KAAK,OAAQ,GAAG,UAAU,EAAE,MAAM;EACnC,GAAG;EACH,KAAKC,sBAAU,KAAK,SAAS;EAC7B;EACA;EACA,KAAK,QAAQ;EACb;EACA,WAAW;EACX,QAAQ;EACR;EACA;EACA,0DAAmB,cAAc,UAAU,KAAK,CAAC;EAClD,GACD;EAAC;EAAK;EAAQ;EAAK;EAAa;EAAS;EAAgB;EAAU;EAAK,CACzE;AAeD,QAAO;EACL;EACA;EACA,0CAfC,WAAW;GACV,GAAG;GACH,cAAc,CAAC,kBACX,QAAQ,OAAO,EAAE,cAAc,GAC/B;GACJ,UAAU,mBAAmB,YAAY;GACzC,QAAQ,CAAC;GACT,MAAM;GACP,GACD;GAAC;GAAM;GAAU;GAAU;GAAM;GAAiB;GAAK;GAAE,CAC1D;EAMC;EACA;EACA;EACD"}