primeng/types/primeng-types-avatar.d.ts

PrimeNG is a premium UI library for Angular featuring a rich set of 90+ components, a theme designer, various theme alternatives such as Material, Bootstrap, Tailwind, premium templates and professional support. In addition, it integrates with PrimeBlock,

import { PassThrough, PassThroughOption } from 'primeng/api';

/**
 * Defines the size of the avatar.
 * @group Types
 */
type AvatarSize = 'normal' | 'large' | 'xlarge';
/**
 * Defines the shape of the avatar.
 * @group Types
 */
type AvatarShape = 'square' | 'circle';
/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Avatar.pt}
 * @group Interface
 */
interface AvatarPassThroughOptions<I = unknown> {
    /**
     * Used to pass attributes to the host's DOM element.
     */
    host?: PassThroughOption<HTMLElement, I>;
    /**
     * Used to pass attributes to the root's DOM element.
     */
    root?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the label's DOM element.
     */
    label?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the icon's DOM element.
     */
    icon?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the image's DOM element.
     */
    image?: PassThroughOption<HTMLImageElement, I>;
}
/**
 * Defines valid pass-through options in Avatar component.
 * @see {@link AvatarPassThroughOptions}
 *
 * @template I Type of instance.
 */
type AvatarPassThrough<I = unknown> = PassThrough<I, AvatarPassThroughOptions<I>>;

export type { AvatarPassThrough, AvatarPassThroughOptions, AvatarShape, AvatarSize };