@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).
91 lines (90 loc) • 4.3 kB
TypeScript
import { EventEmitter, OnChanges, OnInit, SimpleChanges } from '@angular/core';
import { DefaultControlComponent, DsfrSelectOption, DsfrSeverity, DsfrSeverityConst } from '../../shared';
import * as i0 from "@angular/core";
export declare class DsfrFormSelectComponent extends DefaultControlComponent<any> implements OnInit, OnChanges {
/**
* Permet de personnaliser la première option (non sélectionnable). Cette propriété est positionnée à une valeur par
* défaut (ex : Sélectionnez une option) internationalisée.
*/
placeholder: string | undefined;
/**
* Indique que le champ est obligatoire, nécessaire du point de vue de l'accessibilité.
*/
required: boolean;
/**
* Permet d'ajouter un attribut 'aria-label' sur le champ de formulaire en cas de besoin.
*/
ariaLabel: string;
/**
* Ajouter l'attribut 'aria-invalid' sur le champ de formulaire.
*/
ariaInvalid: string;
/**
* Message d'erreur, quand il est présent les couleurs du contrôle changent.
*
* @deprecated (@since 1.13.0)
*/
error: string;
/**
* Message de validation, quand il est présent les couleurs du contrôle changent.
*
* @deprecated (@since 1.13.0)
*/
valid: string;
/**
* Message d'information lié au composant
*/
message: string | undefined;
/**
* Représente la sévérité du message.
*/
messageSeverity: DsfrSeverity;
/**
* Cache le label visuellement en le laissant disponible aux lecteurs d'écran.
*/
labelSrOnly: boolean;
/**
* Output équivalent de (ngModelChange) si celui n'est pas disponible.
*/
selectChange: EventEmitter<any>;
/** @internal */ messagesGroupId: string;
/**
* @internal
* https://github.com/angular/angular/issues/50233 : issue performance with ng-container/ng-template inside select for Firefox
* Dans le cas ou il n'y a pas de groupe, supprimer le 'if' côté template
* FIXME ticket toujours non résolu (v1.13)
*/
noGroup: boolean;
/** @internal fonction de comparaison */
compareFn: (o1: any, o2: any) => boolean;
/** @internal */
protected readonly DsfrSeverity: typeof DsfrSeverityConst;
private _options;
/**
* @deprecated since 1.2, utiliser `placeholder` à la place (sans H majuscule).
*/
get placeHolder(): string | undefined;
get options(): DsfrSelectOption[];
/**
* @deprecated since 1.2, utiliser `placeholder` à la place (sans H majuscule).
*/
set placeHolder(value: string | undefined);
/**
* Le modèle de présentation permettant de transmettre la liste des options.
*/
set options(value: DsfrSelectOption[]);
/** Personnalisation de la comparaison. CompareWith est une fonction qui a deux arguments: valeur option1 et valeur option2.
Si compareWith est fournie, sélection de l'option en fonction du retour de la fonction. */
set compareWith(fn: (o1: any, o2: any) => boolean);
/** @internal */
ngOnInit(): void;
ngOnChanges({ value }: SimpleChanges): void;
/** @internal */
onChange(): void;
trackByIndex: (index: number) => number;
/** @internal */
protected hasMessage(severity: DsfrSeverity): boolean;
private findOption;
static ɵfac: i0.ɵɵFactoryDeclaration<DsfrFormSelectComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DsfrFormSelectComponent, "dsfr-form-select", never, { "placeholder": { "alias": "placeholder"; "required": false; }; "required": { "alias": "required"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "ariaInvalid": { "alias": "ariaInvalid"; "required": false; }; "error": { "alias": "error"; "required": false; }; "valid": { "alias": "valid"; "required": false; }; "message": { "alias": "message"; "required": false; }; "messageSeverity": { "alias": "messageSeverity"; "required": false; }; "labelSrOnly": { "alias": "labelSrOnly"; "required": false; }; "placeHolder": { "alias": "placeHolder"; "required": false; }; "options": { "alias": "options"; "required": false; }; "compareWith": { "alias": "compareWith"; "required": false; }; }, { "selectChange": "selectChange"; }, never, ["[label]"], true, never>;
}