primeng/types/primeng-types-chip.d.ts

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

import { TemplateRef } from '@angular/core';
import { PassThroughOption, PassThrough } from 'primeng/api';

/**
 * Custom pass-through(pt) options.
 * @template I Type of instance.
 *
 * @see {@link Chip.pt}
 * @group Interface
 */
interface ChipPassThroughOptions<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 image's DOM element.
     */
    image?: PassThroughOption<HTMLImageElement, I>;
    /**
     * Used to pass attributes to the icon's DOM element.
     */
    icon?: PassThroughOption<HTMLSpanElement, I>;
    /**
     * Used to pass attributes to the label's DOM element.
     */
    label?: PassThroughOption<HTMLDivElement, I>;
    /**
     * Used to pass attributes to the remove icon's DOM element.
     */
    removeIcon?: PassThroughOption<HTMLElement, I>;
}
/**
 * Defines valid pass-through options in Chip component.
 * @see {@link ChipPassThroughOptions}
 *
 * @template I Type of instance.
 */
type ChipPassThrough<I = unknown> = PassThrough<I, ChipPassThroughOptions<I>>;
/**
 * Defines valid templates in Chip.
 * @group Templates
 */
interface ChipTemplates {
    /**
     * Custom content template.
     */
    content(): TemplateRef<void>;
    /**
     * Custom remove icon template.
     */
    removeicon(): TemplateRef<void>;
}
interface ChipProps {
    label?: string;
    icon?: string | undefined;
    image?: string | undefined;
    alt?: string | undefined;
    style?: {
        [klass: string]: any;
    } | null | undefined;
    styleClass?: string | undefined;
    removable?: boolean | undefined;
    removeIcon?: string | undefined;
}

export type { ChipPassThrough, ChipPassThroughOptions, ChipProps, ChipTemplates };