@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).
70 lines (69 loc) • 3.34 kB
TypeScript
/**
* Définit les types des inputs supportés par le DSFR.
*/
export declare enum DsfrInputTypeConst {
DATE = "date",
DATE_TIME_LOCAL = "datetime-local",
EMAIL = "email",
NUMBER = "number",
PASSWORD = "password",
SEARCH = "search",
TEL = "tel",
TEXT = "text",
TEXTAREA = "textarea",
TIME = "time"
}
/**
* Type union correspondant aux valeurs de l'enum {@link DsfrInputTypeConst}.
*/
export type DsfrInputType = `${DsfrInputTypeConst}`;
/**
* L'attribut universel 'inputmode' est un attribut à valeur contrainte qui fournit une indication au navigateur quant
* au type de donnée qui peut être saisi par l'utilisateur lors de l'édition de l'élément ou de son contenu.
* Lorsque cet attribut n'est pas explicitement défini, sa valeur par défaut est "text", ce qui indique que c'est du
* texte qui sera saisi et qu'un clavier standard devrait être utilisé.
* Cf. https://developer.mozilla.org/fr/docs/Web/HTML/Global_attributes/inputmode
*/
export declare enum DsfrInputModeConst {
/** Aucun clavier virtuel ne doit être affiché. Cette valeur s'avère utile lorsque l'application ou le site web implémente son propre outil de saisie. */
NONE = "none",
/** C'est du texte qui sera saisi et un clavier dans la locale de l'utilisateur pourra être affiché. */
TEXT = "text",
/**
* C'est un nombre décimal qui sera saisi. Le clavier affiché peut contenir des chiffres et le séparateur décimal
* de la locale de l'utilisateur. Attention, selon les appareils, le signe moins (-) peut ne pas être présent.
*/
DECIMAL = "decimal",
/**
* C'est un nombre entier qui sera saisi. Le clavier affiché peut contenir les chiffres de 0 à 9. Attention, selon
* les appareils, le signe moins (-) peut ne pas être présent.
*/
NUMERIC = "numeric",
/**
* C'est un numéro de téléphone qui sera saisi. Le clavier affiché pourra être celui d'un téléphone avec les chiffres
* allant de 0 à 9, l'astérisque et le dièse. Pour les champs de formulaire où il faut saisir un numéro de téléphone,
* on utilisera plutôt <input type="tel">.
*/
TEL = "tel",
/**
* L'élément éditable sert à la recherche. Le clavier affiché sera optimisé pour une recherche (par exemple, la
* touche Entrée pourra être indiquée avec le mot-clé « Rechercher »).
*/
SEARCH = "search",
/**
* C'est une adresse électronique qui sera saisie. Le clavier affiché pourra être optimisé pour la saisie d'adresses
* email (généralement, on aura le caractère @ et d'autres éléments). Pour les champs de formulaire où il faut saisir
* une adresse électronique, on utilisera plutôt <input type="email">.
*/
EMAIL = "email",
/**
* C'est une URL qui sera saisie. Le clavier affiché pourra être optimisé pour la saisie d'URL. Ainsi, la touche pour
* la barre oblique pourra être plus accessible, le clavier pourra proposer un accès à l'historique des URL utilisées,
* etc. Pour les champs de formulaire où il faut saisir une URL, on utilisera plutôt <input type="url">.
*/
URL = "url"
}
/**
* Type union correspondant aux valeurs de l'enum {@link DsfrInputModeConst}.
*/
export type DsfrInputMode = `${DsfrInputModeConst}`;