@edugouvfr/ngx-dsfr/lib/forms/form-input/base-input.component.d.ts

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

import { EventEmitter } from '@angular/core';
import { DefaultControlComponent, DsfrSeverity } from '../../shared';
import { DsfrInputMode, DsfrInputType } from './form-input.model';
import * as i0 from "@angular/core";
/**
 * BaseInputComponent n'embarque que les propriétés d'un input Html
 */
export declare abstract class BaseInputComponent extends DefaultControlComponent<string> {
    /**
     * L'attribut HTML de saisie semi-automatique permet aux développeurs Web de spécifier l'éventuelle autorisation
     * dont dispose l'agent utilisateur pour fournir une assistance automatisée dans le remplissage des valeurs des
     * champs du formulaire, ainsi que des conseils au navigateur quant au type d'informations attendues dans le champ.
     * Ex : email, name, etc.
     */
    autocomplete: string | undefined;
    /**
     * 👓 Correspond à l'attribut `aria-autocomplete`.<br />
     * L'attribut `aria-autocomplete` indique si la saisie de texte peut déclencher l'affichage d'une ou plusieurs
     * prédictions de la valeur prévue par l'utilisateur pour une zone de liste déroulante, une zone de recherche ou
     * une zone de texte et spécifie comment les prédictions seront présentées si elles sont effectuées.
     * Ex : `ariaAutocomplete="list"` lorsque la saisie d'une valeur fait apparaitre une liste de suggestions.<br />
     * Valeur par défaut : `undefined` (n'apparait pas comme attribut dans l'html).
     * @since 1.4
     */
    ariaAutocomplete: string;
    /**
     * 👓 Correspond à l'attribut `aria-expanded`.<br />
     * L'attribut `aria-expanded` est défini sur un élément pour indiquer si un contrôle est développé ou réduit,
     * et si les éléments contrôlés sont affichés ou masqués. <br />
     * Valeur par défaut : `undefined` (n'apparait pas comme attribut dans l'html).
     * @since 1.4
     */
    ariaExpanded: boolean | undefined;
    /**
     * 👓 Correspond à l'attribut `aria-label`.<br />
     * L'attribut `aria-label` est utilisé pour définir une légende non visible associée à un élément HTML dont le
     * sens est transmis uniquement par le visuel.<br />
     * Valeur par défaut : `undefined` (n'apparait pas comme attribut dans l'html).
     */
    ariaLabel: string;
    /**
     * 👓 Les [rôles ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles) fournissent une
     * signification sémantique au contenu, permettant aux lecteurs d'écran et à d'autres outils de présenter et
     * de prendre en charge l'interaction avec un objet d'une manière cohérente avec les attentes des utilisateurs
     * concernant ce type d'objet. Les rôles ARIA peuvent être utilisés pour décrire des éléments qui n'existent
     * pas nativement en HTML ou qui existent, mais ne bénéficient pas encore d'une prise en charge complète par
     * le navigateur. Ex : `toolbar`, `tabpanel`, etc.<br />
     * Valeur par défaut : `undefined` (n'apparait pas comme attribut dans l'html).
     * @since 1.4
     */
    role: string;
    /**
     * Une chaîne de caractères, on ou off, qui indique si la correction automatique est activée.
     * [Safari uniquement](https://developer.mozilla.org/fr/docs/Web/HTML/Element/input#autocorrect).
     * @since 1.6
     */
    autoCorrect: boolean;
    /**
     * Indique si le champ est obligatoire ou non, faux par défaut.
     */
    required: boolean;
    /**
     * Placeholder de l'input.
     */
    placeholder: string;
    /**
     * Attribut min de l'input.
     */
    min: string;
    /**
     * Attribut max de l'input.
     */
    max: string;
    /**
     * Attribut minLength de l'input.
     */
    minLength: number;
    /**
     * Attribut maxLength de l'input.
     */
    maxLength: number;
    /** Désactive la correction orthographique sur les champs relatifs au nom et aux prénoms. */
    spellCheck: boolean;
    /**
     * Ajoute un icon à droite dans le champ de saisie.
     */
    icon: string;
    /**
     * Pattern de l'input.
     */
    pattern: string;
    /**
     * Ajout d'un style spécifique, permet par exemple de la limiter la largeur d'un input.
     */
    customClass: string;
    /**
     * Change la mise en page d'un input accompagné d'un bouton.
     */
    inputWrapMode: 'addon' | 'action';
    /**
     * Message d'information lié au composant
     */
    message: string | undefined;
    /**
     * Représente la sévérité du message. 🔥 `WARNING` n'est pas géré dans cette version.
     */
    severity: DsfrSeverity;
    /**
     * Émet un événement, si la propriété `pattern` est définie, à chaque changement de la valeur de l'input avec
     * une valeur booléenne indiquant si le `pattern` est validé ou non.
     */
    patternValueChange: EventEmitter<boolean>;
    /**
     * L'input mode est initialisé par défaut en fonction du type de l'input, 'decimal', 'url' ne sont pas traité pour
     * l'instant.
     * @internal
     */
    inputMode: DsfrInputMode;
    /**
     * Id de la div affichant les messages d'erreur ou de validation.
     * @internal
     */
    readonly messagesGroupId: string;
    private _type;
    get type(): DsfrInputType;
    /** @deprecated since 1.11.0 use placeholder instead (all lowercase) */
    get placeHolder(): string;
    /**
     * Permet de récupérer le message d'erreur s'il existe
     * @since 1.11
     */
    get error(): string | undefined;
    /**
     * Permet de récupérer le message de validation s'il existe
     * @since 1.11
     */
    get valid(): string | undefined;
    /**
     * Type de l'input, 'text' par défaut.
     */
    set type(value: DsfrInputType);
    /**
     * Positionne un message d'erreur
     * @since 1.11
     */
    set error(value: string | undefined);
    /**
     * Positionne un message de validation
     * @since 1.11
     */
    set valid(value: string | undefined);
    /** @deprecated since 1.11.0 use placeholder instead (all lowercase) */
    set placeHolder(value: string);
    /**
     * À l'écoute de la valeur afin d'émettre un événement dans le cas où on a un pattern.
     * @internal
     */
    onPatternValueChange(): void;
    /** @internal */
    isNumber(): boolean;
    /** @internal */
    hasMessages(): boolean;
    static ɵfac: i0.ɵɵFactoryDeclaration<BaseInputComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<BaseInputComponent, "ng-component", never, { "autocomplete": { "alias": "autocomplete"; "required": false; }; "ariaAutocomplete": { "alias": "ariaAutocomplete"; "required": false; }; "ariaExpanded": { "alias": "ariaExpanded"; "required": false; }; "ariaLabel": { "alias": "ariaLabel"; "required": false; }; "role": { "alias": "role"; "required": false; }; "autoCorrect": { "alias": "autoCorrect"; "required": false; }; "required": { "alias": "required"; "required": false; }; "placeholder": { "alias": "placeholder"; "required": false; }; "min": { "alias": "min"; "required": false; }; "max": { "alias": "max"; "required": false; }; "minLength": { "alias": "minLength"; "required": false; }; "maxLength": { "alias": "maxLength"; "required": false; }; "spellCheck": { "alias": "spellCheck"; "required": false; }; "icon": { "alias": "icon"; "required": false; }; "pattern": { "alias": "pattern"; "required": false; }; "customClass": { "alias": "customClass"; "required": false; }; "inputWrapMode": { "alias": "inputWrapMode"; "required": false; }; "message": { "alias": "message"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; "type": { "alias": "type"; "required": false; }; "error": { "alias": "error"; "required": false; }; "valid": { "alias": "valid"; "required": false; }; "placeHolder": { "alias": "placeHolder"; "required": false; }; }, { "patternValueChange": "patternValueChange"; }, never, never, false, never>;
}