@edugouvfr/ngx-dsfr
Version:
NgxDsfr est un portage Angular des éléments d'interface du Système de Design de l'État Français (DSFR).
59 lines (58 loc) • 1.48 kB
TypeScript
/**
* Décrit un badge dans un groupe de badges.
*/
export interface DsfrBadge {
/**
* Libellé du badge.
*/
label: string;
/**
* Niveau d'alerte. Optionnel.
*/
severity?: DsfrBadgeSeverity;
/**
* Permet de ne pas afficher l'icône de sévérité, affichée par défaut.
*/
noIcon?: boolean;
/**
* Cette propriété est ignorée : la taille des badges dans un groupe est liée au groupe.
*
* @deprecated (since 1.9) use `DsfrBadgesGroupComponent#small` instead
*/
size?: DsfrBadgeSize;
/**
* Classe personnalisée pour la couleur du badge.
*/
customClass?: string;
}
/**
* Définit les différent niveaux de sévérité supportés par le DSFR.
*/
export declare enum DsfrBadgeSeverityConst {
NEW = "new",
INFO = "info",
SUCCESS = "success",
WARNING = "warning",
ERROR = "error"
}
/**
* Type union correspondant aux valeurs de l'enum {@link DsfrBadgeSeverityConst}.
*/
export type DsfrBadgeSeverity = `${DsfrBadgeSeverityConst}` | 'NEW' | 'SUCCESS' | 'INFO' | 'WARNING' | 'ERROR';
/**
* Définit les tailles de badge supportées par le DSFR.
*/
export declare enum DsfrBadgeSizeConst {
/**
* Petite taille.
*/
SM = "SM",
/**
* Taille normale (par défaut).
*/
MD = "MD"
}
/**
* Type union correspondant aux valeurs de l'enum {@link DsfrBadgeSeverityConst}.
*/
export type DsfrBadgeSize = `${DsfrBadgeSizeConst}`;