Avatar

人を表す写真、イニシャル、アイコンです。

インポート

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

例

上のプレビューはこのファイルを描画したものです。src/components/ にコピーして使い始めてください。

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 ファイルで組み立て、そのファイルをインポートしてください。

---
title: Example
---

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

<AvatarExample client:load />

client:load はページの読み込み時にアイランドをハイドレートします。ページの下の方にあるコンテンツには client:visible を使ってください。

Markdoc で使う

Markdoc のタグは Astro コンポーネントを描画しますが、このコンポーネントにはクライアントの状態が必要です。例をハイドレートする .astro ファイルで包み、そのファイルをタグとして登録してください。

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

<AvatarExample client:load />

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,
    },
  },
});

{% avatar-example /%}

バリアント

各 variant prop が受け付ける値です。

Prop	値
`size`	`xs` `sm` `md` `lg` `xl`
`layout`	`image` `icon` `initials`

構造

コンポーネントを構成するパーツと、それぞれが描画する data-refineui のロールです。

パーツ	ロール
`root`	avatar

参考

デザインのガイドとトークンの詳細は RefineUI · Avatar を参照してください。
共通のルールは MDX で使うと Markdoc で使うを参照してください。