primeng/types/primeng-types-badge.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 badge.
 * @group Types
 */
type BadgeSize = 'small' | 'large' | 'xlarge' | null;
/**
 * Defines the severity of the badge.
 * @group Types
 */
type BadgeSeverity = 'secondary' | 'info' | 'success' | 'warn' | 'danger' | 'contrast' | null;
/**
 * Custom passthrough(pt) options.
 * @see {@link Badge.pt}
 * @group Interface
 */
interface BadgePassThroughOptions<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<HTMLElement, I>;
}
/**
 * Defines valid pass-through options in Badge component.
 * @see {@link BadgePassThroughOptions}
 *
 * @template I Type of instance.
 */
type BadgePassThrough<I = unknown> = PassThrough<I, BadgePassThroughOptions<I>>;

export type { BadgePassThrough, BadgePassThroughOptions, BadgeSeverity, BadgeSize };