import * as i0 from '@angular/core'; /** * Determines the igxBadge type */ declare const IgxBadgeType: { readonly PRIMARY: "primary"; readonly INFO: "info"; readonly SUCCESS: "success"; readonly WARNING: "warning"; readonly ERROR: "error"; }; type IgxBadgeType = (typeof IgxBadgeType)[keyof typeof IgxBadgeType]; /** * Badge provides visual notifications used to decorate avatars, menus, etc. * * @igxModule IgxBadgeModule * * @igxTheme igx-badge-theme * * @igxKeywords badge, icon, notification * * @igxGroup Data Entry & Display * * @remarks * The Ignite UI Badge is used to decorate avatars, navigation menus, or other components in the * application when visual notification is needed. They are usually designed as icons with a predefined * style to communicate information, success, warnings, or errors. * * @example * ```html * * * */ declare class IgxBadgeComponent { /** * Sets/gets the `id` of the badge. * * @remarks * If not set, the `id` will have value `"igx-badge-0"`. * * @example * ```html * * ``` */ id: string; /** * Sets/gets the type of the badge. * * @remarks * Allowed values are `primary`, `info`, `success`, `warning`, `error`. * Providing an invalid value won't display a badge. * * @example * ```html * * ``` */ type: string | IgxBadgeType; /** * Sets/gets the value to be displayed inside the badge. * * @remarks * If an `icon` property is already set the `icon` will be displayed. * If neither a `value` nor an `icon` is set the content of the badge will be empty. * * @example * ```html * * ``` */ value: string | number; /** * Sets/gets an icon for the badge from the material icons set. * * @remarks * Has priority over the `value` property. * If neither a `value` nor an `icon` is set the content of the badge will be empty. * Providing an invalid value won't display anything. * * @example * ```html * * ``` */ icon: string; /** * The name of the icon set. Used in case the icon is from a different icon set. */ iconSet: string; /** * Sets/gets the role attribute value. * * @example * ```typescript * @ViewChild("MyBadge", { read: IgxBadgeComponent }) * public badge: IgxBadgeComponent; * * badge.role = 'status'; * ``` */ role: string; /** * Sets/gets the css class to use on the badge. * * @example * ```typescript * @ViewChild("MyBadge", { read: IgxBadgeComponent }) * public badge: IgxBadgeComponent; * * badge.cssClass = 'my-badge-class'; * ``` */ cssClass: string; /** * Sets a square shape to the badge, if `shape` is set to `square`. * By default the shape of the badge is rounded. * * @example * ```html * * ``` */ shape: 'rounded' | 'square'; /** @hidden @internal */ get _squareShape(): boolean; /** * Sets/gets the aria-label attribute value. * * @example * ```typescript * @ViewChild("MyBadge", { read: IgxBadgeComponent }) * public badge: IgxBadgeComponent; * * badge.label = 'badge'; * ``` */ label: string; /** * Sets/gets whether the badge is outlined. * Default value is `false`. * * @example * ```html * * ``` */ outlined: boolean; /** * Sets/gets whether the badge is displayed as a dot. * When true, the badge will be rendered as a minimal 8px indicator without any content. * Default value is `false`. * * @example * ```html * * ``` */ dot: boolean; /** * Defines a human-readable, accessor, author-localized description for * the `type` and the `icon` or `value` of the element. * * @hidden * @internal */ get roleDescription(): string; get infoClass(): boolean; get successClass(): boolean; get warningClass(): boolean; get errorClass(): boolean; static ɵfac: i0.ɵɵFactoryDeclaration; static ɵcmp: i0.ɵɵComponentDeclaration; static ngAcceptInputType_outlined: unknown; static ngAcceptInputType_dot: unknown; } /** * @hidden * IMPORTANT: The following is NgModule exported for backwards-compatibility before standalone components */ declare class IgxBadgeModule { static ɵfac: i0.ɵɵFactoryDeclaration; static ɵmod: i0.ɵɵNgModuleDeclaration; static ɵinj: i0.ɵɵInjectorDeclaration; } export { IgxBadgeComponent, IgxBadgeModule, IgxBadgeType };