Angular アバターコンポーネント | ng-hub-ui-avatar

イニシャル、フォールバック画像、プレゼンスバッジ、CSS 変数を備えた Angular アバターコンポーネント。再利用可能なユーザー識別 UI を構築できます。

API リファレンス

avatar の完全な仕様をここにまとめました。バインド、リッスン、プロジェクション、テーマ設定ができるすべてが一か所に集約されています。必要なものを接続し、好きなようにスタイリングしてください — standalone で signal フレンドリーです。

インプット

22 個のインプットで avatar を調整。通常の Angular @Input と同じようにバインドできます。

名前型デフォルト説明
sizestring | number50アバターのサイズ。数値だけならピクセル、CSS の長さ(1.75rem、50%、calc(2rem + 12px))はそのまま描画されます
namestring | null—画像ソースが失敗したときにイニシャルを生成するためのユーザー名
srcstring | SafeUrl | null—アバターの主要なカスタム画像ソース URL
altstring | null—アクセシビリティのためのアバター画像の代替テキスト
roundbooleantrueアバターを円形にする(true)か、cornerRadius に従わせるか
interactivebooleanfalseアバターをインタラクティブなコントロールとしてマークします:role=“button” を公開し、フォーカス可能にし、Enter/Space で clickOnAvatar を発火します。(clickOnAvatar) をバインドするときは必ず有効にしてください。
bgColorstring—テキストアバターの背景色。指定しない場合は自動生成されます
autoColorbooleantrue`true`(既定)の場合、イニシャルアバターは名前のハッシュから背景色を生成します。`false` にすると `--hub-avatar-bg-color` 変数でテーマ設定できます。明示的な `bgColor` は常に優先されます。
fgColorstring | undefined—イニシャルと投影されたコンテンツの色。未指定なら、背景に応じて WCAG の基準を満たすほう——黒か白——をアバターが選びます。明示した値は、コントラストにかかわらず常に優先されます。
borderColorstring—アバター周囲のボーダー色
cornerRadiusstring | number0round が false のときの角丸半径
textSizeRationumber3アバターサイズからテキストサイズを計算する比率(size / textSizeRatio)
initialsSizestring | number0表示するイニシャルの数を制限します(0 = 制限なし)
facebookIdstring | null—プロフィール画像用の Facebook ユーザー ID(ベストエフォート、API 制限が適用される場合があります)
githubIdstring | null—プロフィール画像を取得するための GitHub ユーザー名
gravatarIdstring | null—プロフィール画像を取得するための Gravatar のメールアドレスまたは MD5 ハッシュ
valuestring | null—カスタム値をアバターとして表示します(例: "75%"、"+5")
styleRecord<string, string | number | null | undefined> | string—レンダリングされた内容(画像・イニシャル・投影コンテンツのスロット)にマージされるインラインスタイル。スタイルオブジェクトまたは CSS 文字列を受け取り、ホスト要素には適用されません
referrerpolicystring | null—アバター画像のリファラーポリシー(例: "no-referrer")
placeholderstring—最後の手段となる画像。ほかに何も描かれていないあいだ(解決したソースがない、ソースが指定されていない、あるいは読み込み中)で、イニシャルもない場合にだけ表示されます。フォールバック連鎖には決して加わらないため、`src` のようにイニシャルを追い越すことはありません。
badgestring | number | boolean | nullnull角のオーバーレイ:`badge` / `[badge]="true"` → ドット、`badge="4k"` → ラベル付きピル、null / 未指定 → なし。
badgeColorHubAvatarBadgeColor | string | nullnullバッジのセマンティックカラー(primary · secondary · success · danger · warning · info · light · dark)→ `--hub-sys-color-*`。

アウトプット

avatar の動作に反応 — ロジックを接続できる 1 個のイベント。

名前型説明
clickOnAvatarOutputEmitterRef<Source | null>クリック時、および `interactive` 指定時は Enter/Space でも発行されます。アバターを描画しているソース(`sourceType`、`sourceId`、`getAvatar(size)` を持ちます。解決したものがなければ null)を返します。`Source` はパッケージから公開されているので、ハンドラーは any に逃げずに型を書けます

メソッド

avatar をコードから操作 — プログラム操作のための 1 個のメソッドを備えています。

名前シグネチャ戻り値説明
Source.getAvatargetAvatar(size: number): stringstring指定したサイズでそのソースが描くものを解決します。リモートのソースなら画像の URL、ローカルならイニシャルや素のテキストです。`Source` は `clickOnAvatar` のペイロードで、パッケージから公開されています。

テンプレート

テンプレートはまだドキュメント化されていません。