@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).
184 lines (183 loc) • 8 kB
TypeScript
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> {
/**
* Correspond à l'attribut `autocomplete`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/autocomplete) <br />
* Ex : email, name, etc.
*/
autocomplete: string | undefined;
/**
* 👓 Correspond à l'attribut `aria-autocomplete`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-autocomplete).
* Ex : `ariaAutocomplete="list"`.
* Valeur par défaut `undefined` (n'apparait pas comme attribut dans l'html).
*
* @since 1.4
*/
ariaAutocomplete: string;
/**
* 👓 Correspond à l'attribut `aria-expanded`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-expanded).
* Valeur par défaut `undefined` (n'apparait pas comme attribut dans l'html).
*
* @since 1.4
*/
ariaExpanded: boolean | undefined;
/**
* 👓 Correspond à l'attribut `aria-label`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label).
* Valeur par défaut `undefined` (n'apparait pas comme attribut dans l'html).
*/
ariaLabel: string;
/**
* 👓 Correspond à l'attribut `aria-invalid`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-invalid).
* Valeur par défaut `undefined` (n'apparait pas comme attribut dans l'html).
*/
ariaInvalid: string | undefined;
/**
* 👓 Correspond à l'attribut `role`,
* cf. [definition](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/role).
* Valeur par défaut `undefined` (n'apparait pas comme attribut dans l'html).
*/
inputRole: 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;
/**
* Attribut spellcheck pour surcharger la vérification de la correction orthographique
*/
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.
*/
messageSeverity: DsfrSeverity;
/** Attribut readonly de l'input */
readonly: boolean;
/**
* É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;
/**
* @internal
* @deprecated (since 1.12.0) use messageSeverity instead
*/
get severity(): DsfrSeverity;
/** @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.
* @deprecated (since 1.11) Utiliser `message`/`messageSeverity` à la place
*/
get error(): string | undefined;
/**
* Permet de récupérer le message de validation s'il existe
* @deprecated (since 1.11) Utiliser `message`/`messageSeverity` à la place
*/
get valid(): string | undefined;
/**
* Type de l'input, 'text' par défaut.
*/
set type(value: DsfrInputType);
/**
* 👓 Correspond à l'attribut `role`, *
* @deprecated (since 1.15.1) utiliser inputRole à la place
*/
set role(value: string);
/**
* @internal
* @deprecated (since 1.12.0) utiliser messageSeverity à la place
*/
set severity(value: DsfrSeverity);
/**
* Positionne un message d'erreur.
*
* @deprecated (since 1.11) utiliser message+messageSeverity à la place
*/
set error(value: string | undefined);
/**
* Positionne un message de validation.
*
* @deprecated (since 1.11) utiliser message+messageSeverity à la place
*/
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;
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; }; "ariaInvalid": { "alias": "ariaInvalid"; "required": false; }; "inputRole": { "alias": "inputRole"; "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; }; "messageSeverity": { "alias": "messageSeverity"; "required": false; }; "readonly": { "alias": "readonly"; "required": false; }; "type": { "alias": "type"; "required": false; }; "role": { "alias": "role"; "required": false; }; "severity": { "alias": "severity"; "required": false; }; "error": { "alias": "error"; "required": false; }; "valid": { "alias": "valid"; "required": false; }; "placeHolder": { "alias": "placeHolder"; "required": false; }; }, { "patternValueChange": "patternValueChange"; }, never, never, false, never>;
}