Skip to content

An open source design system that's fully customizable and agent ready

TypeScript
868 B
Raw Blame
// Copyright (c) Meta Platforms, Inc. and affiliates.
'use client';

/**
 * @file AvatarGroupContext.ts
 * @input Layer-scoped React context
 * @output Exports AvatarGroup context and useAvatarGroup hook
 * @position Shared context; consumed by children for group-aware styling
 */

import {use} from 'react';
import {createLayerScopedContext} from '../Layer/layerScopedContext';
import type {AvatarShape, AvatarSize} from '../Avatar';

export interface AvatarGroupContextValue {
  size: AvatarSize;
  shape: AvatarShape;
  overlap: number;
  numericSize: number;
}

export const AvatarGroupContext =
  createLayerScopedContext<AvatarGroupContextValue | null>(
    'AvatarGroupContext',
    1,
    null,
  );
AvatarGroupContext.displayName = 'AvatarGroupContext';

export function useAvatarGroup(): AvatarGroupContextValue | null {
  return use(AvatarGroupContext);
}