/**
 * @ Author: Redon Alla
 * @ Create Time: 2024-06-07 23:29:01
 * @ Modified by: Redon Alla
 * @ Modified time: 2025-03-22 23:25:17
 * @ Description: AvatarGroup Component - A React component that displays a group of `Avatar` components.
 */
import React from 'react';
import { AvatarGroupProps } from './props';
/**
 * AvatarGroup Component
 *
 * A React component that displays a group of `Avatar` components. It allows customization of the
 * sorting order, border properties, and padding of the individual avatars within the group.
 *
 * @component
 * @param {AvatarGroupProps} props - The properties passed to the AvatarGroup component.
 * @returns {React.ReactElement} An AvatarGroup component instance.
 *
 * @example
 * ```typescript jsx
 * <AvatarGroup sortIndex="desc" itemBorderWidth="hairline" itemBorderColor="primary" itemPadding={8}>
 *   <Avatar type="image" source={{ uri: 'https://example.com/image1.jpg' }} />
 *   <Avatar type="icon" icon="user" />
 *   <Avatar type="text" text="RA" />
 * </AvatarGroup>
 * ```
 *
 * @property {('asc' | 'desc')} [props.sortIndex='asc'] - The sorting order of the avatar items. 'asc' for ascending (default), 'desc' for descending. This affects the z-index of the avatars, allowing them to overlap in a specific order.
 * @property {string} [props.itemBorderWidth='thick'] - The border width of each avatar item. It can be a predefined value from the theme's border widths (e.g., 'thin', 'medium', 'thick') or a custom string value. Defaults to 'thick'.
 * @property {React.ReactNode} props.children - The `Avatar` components to be displayed in the group. Only `Avatar` components are allowed as children.
 * @property {StyleProp<ViewStyle>} [props.style] - Additional styles to be applied to the container `View` of the group.
 * @property {number} [props.itemPadding=13] - The padding around each avatar item, in pixels. Default is 13.
 * @property {string} [props.itemBorderColor] - The border color for each avatar item. It can be a color name from the theme (e.g., 'primary', 'secondary') or a custom color string (e.g., '#FF0000'). If not provided, it defaults to the 'card' color from the theme.
 * @property {object} [props.restProps] - Additional props to be passed to the container `View`.
 *
 * @throws {Error} Throws an error if a child is not a valid `Avatar` component.
 *
 * @context {ThemeContext} - The theme context used for theming. Provides access to theme colors and border widths.
 */
declare const AvatarGroup: React.FC<AvatarGroupProps>;
export default AvatarGroup;