@engie-group/fluid-design-system-angular
Version:
Fluid Design System Angular
65 lines (64 loc) • 2.35 kB
TypeScript
import { CustomIconDirective } from '../../directives/custom-icon.directive';
import { BadgeEmphasis, BadgeProperties, BadgeScale, BadgeVariant } from '@engie-group/fluid-types';
import * as i0 from "@angular/core";
export declare class BadgeComponent implements BadgeProperties {
private badgeClassName;
/**
* Badge emphasis
*
* @default `bold`
*/
emphasis?: BadgeEmphasis;
/**
* Badge variant
*
* @default `neutral`
*/
variant?: BadgeVariant;
/**
* Badge scale
*
* @default `md`
*/
scale?: BadgeScale;
/**
* Badge size (deprecated, use `scale` instead)
*
* @deprecated use `scale` instead
*/
size?: BadgeScale;
/**
* Material icon name
*/
iconName?: string;
/**
* Badge value
* (when value is a string, you can pass it directly as ng-content)
*/
value?: string | number;
/**
* When value is a number, you can pass a capedValue, so the displayed value will be `${capedValue}+`
*/
capedValue?: number;
/**
* Badge value
*/
isUppercase?: boolean;
/**
* Screen reader only unit label.
*
* @example
* // read as "12 notifications"
* <nj-badge unitLabel="notifications">12</NJBadge>
*/
unitLabel?: string;
protected customIcon?: CustomIconDirective;
protected isValueDefined(): boolean;
protected getFormattedValue(): string;
protected getBadgeEmphasisClass(): string;
protected getBadgeVariantClass(): string;
protected getBadgeScaleClass(): string;
protected getBadgeUppercaseClass(): string;
static ɵfac: i0.ɵɵFactoryDeclaration<BadgeComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<BadgeComponent, "nj-badge", never, { "emphasis": { "alias": "emphasis"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "scale": { "alias": "scale"; "required": false; }; "size": { "alias": "size"; "required": false; }; "iconName": { "alias": "iconName"; "required": false; }; "value": { "alias": "value"; "required": false; }; "capedValue": { "alias": "capedValue"; "required": false; }; "isUppercase": { "alias": "isUppercase"; "required": false; }; "unitLabel": { "alias": "unitLabel"; "required": false; }; }, {}, ["customIcon"], ["*"], true, never>;
}