Avatar

JA

PG

󰉔

导入

import {
  Avatar,
  AvatarImage,
  AvatarFallback,
  AvatarText,
  AvatarIcon,
  AvatarBadge,
} from "@pelagornis/page/components";

示例

上方预览渲染的就是这个文件。把它复制到 src/components/ 即可开始使用。

src/components/AvatarExample.tsx

import { Avatar, AvatarIcon, AvatarText, Stack } from "@pelagornis/page/components";

export default function AvatarDemo() {
  return (
    <Stack direction="row" gap="sizeMedium" align="center" wrap>
      <Avatar layout="initials" size="sm">
        <AvatarText>JA</AvatarText>
      </Avatar>
      <Avatar layout="initials" size="md" showStatus status="online">
        <AvatarText>PG</AvatarText>
      </Avatar>
      <Avatar layout="icon" size="lg">
        <AvatarIcon name="person" />
      </Avatar>
    </Stack>
  );
}

在 MDX 中使用

Avatar 由共享 React 状态的多个部件组成。写在 MDX 中的子元素会各自渲染成独立的岛，部件之间无法互通。请像上面的示例一样在 .tsx 文件中组合，再导入该文件。

src/content/docs/example.mdx

---
title: Example
---

import AvatarExample from "../../components/AvatarExample";

<AvatarExample client:load />

client:load 会在页面加载时水合该岛。位于页面靠下位置的内容请使用 client:visible。

在 Markdoc 中使用

Markdoc 标签渲染的是 Astro 组件，而这个组件需要客户端状态。请把示例包进一个负责水合的 .astro 文件，再把该文件注册为标签。

src/components/markdoc/AvatarExample.astro

---
import AvatarExample from "../AvatarExample";
---

<AvatarExample client:load />

markdoc.config.mjs

import { component, defineMarkdocConfig } from "@astrojs/markdoc/config";
import starlightMarkdoc from "@astrojs/starlight-markdoc";
import pageMarkdoc from "@pelagornis/page/markdoc";

export default defineMarkdocConfig({
  extends: [starlightMarkdoc(), pageMarkdoc()],
  tags: {
    "avatar-example": {
      render: component("./src/components/markdoc/AvatarExample.astro"),
      selfClosing: true,
    },
  },
});

src/content/docs/example.mdoc

{% avatar-example /%}

变体

每个 variant prop 可接受的取值。

Prop	取值
size	xs sm md lg xl
layout	image icon initials

结构

组件的组成部分，以及每个部分渲染的 data-refineui 角色。

部件	角色
root	avatar

参考

• 设计指南和令牌细节见 RefineUI · Avatar。
• 通用规则见在 MDX 中使用和在 Markdoc 中使用。