@edugouvfr/ngx-dsfr/lib/shared/models/select.model.d.ts

NgxDsfr est un portage Angular des éléments d'interface du Système de Design de l'État Français (DSFR).

import { DsfrOption } from './option.model';
/**
 * Décrit une option dans le contexte du composant `select`.
 */
export interface DsfrSelectOption extends DsfrOption {
    /**
     * Désactive l'option.
     */
    disabled?: boolean;
    /**
     * Permet de grouper plusieurs options.
     */
    options?: DsfrSelectOption[];
}
/**
 * Décrit le modèle d'un composant `select`.
 */
export interface DsfrSelect {
    /**
     * Le libellé du select.
     */
    label: string;
    /**
     * Le modèle de présentation permettant de transmettre la liste des options.
     */
    options: DsfrSelectOption[];
    /**
     * Attribut name de l'input.
     */
    name: string;
    /**
     * Attribut ariaLabel pour legende non visible.
     */
    ariaLabel?: string;
    /**
     * Message d'erreur de l'input.
     */
    error?: string;
    /**
     * Message de validation de l'input.
     */
    valid?: string;
    /**
     * Text additionel décrivant le champs.
     */
    hint?: string;
    /**
     * Indique que le champs est obligatoite.
     */
    required?: boolean;
    /**
     * Attribut 'id' du champ, généré automatiquement par défaut.
     */
    id?: string;
    /**
     * Permer de désactiver le champs.
     */
    disabled?: boolean;
    /**
     * La valeur gérée par le champ de formulaire.
     */
    value: string;
    /**
     * 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;
}