@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).
98 lines (97 loc) • 4.73 kB
TypeScript
import { OnChanges, SimpleChanges } from '@angular/core';
import { DefaultControlComponent, DsfrI18nService, DsfrPosition, DsfrSeverity } from '../../shared';
import * as i0 from "@angular/core";
export declare class DsfrFormToggleComponent extends DefaultControlComponent<boolean> implements OnChanges {
private i18n;
/** Position du libellé, à droite par défaut. */
labelPosition: DsfrPosition;
/**
* Cache le label visuellement en le laissant disponible aux lecteurs d'écran.
*/
labelSrOnly: boolean;
/**
* Ajouter l'attribut 'aria-invalid' sur le champ de formulaire.
*/
ariaInvalid: string;
/**
* Permet d'afficher le libellé, court, décrivant l'état de l’interrupteur (activé / désactivé), placé en dessous du
* switch. Il est affiché par défaut, il est conseillé de le mettre afin de faciliter la compréhension de
* l’utilisateur - Optionnel.
*/
showStatusLabel: boolean;
/**
* Propriété permettant de surcharger le libellé, court, dénotant l'état checked du toggle, sans avoir à passer
* par le fichier d'internationalisation.
*/
checkedStatusLabel: string;
/**
* Propriété permettant de surcharger le libellé court dénotant l'état checked du toggle, sans avoir à passer
* par le fichier d'internationalisation.
*/
uncheckedStatusLabel: string;
/**
* Affiche un séparateur horizontal sous le composant.
* Ne devrait être utilisé que dans le cadre d'un toggles-group.
*/
showSeparator: boolean;
/**
* Symbolise l'erreur du toggle
* @deprecated since 1.12 use `message` and `severity` instead
*/
error: boolean;
/**
* Symbolise le succès du toggle
* @deprecated since 1.12 use `message` and `severity` instead
*/
valid: boolean;
/**
* Message d'information lié au composant @since 1.12
*/
message: string | undefined;
/**
* Représente la sévérité du message, `warning` n'est pas supporté
*/
messageSeverity: DsfrSeverity;
/**
* Id de la div affichant les messages d'erreur ou de validation.
* @internal
*/
messagesGroupId: string;
protected ariaDescribedbyValue: string | undefined;
constructor(i18n: DsfrI18nService);
get hintId(): string;
/** @deprecated since 1.12 use showStatus instead */
get showCheckedHint(): boolean;
/** @deprecated since 1.12 use checkedLabel instead */
get checkedHintLabel(): string;
/** @deprecated since 1.12 use uncheckedLabel instead */
get uncheckedHintLabel(): string;
/** @deprecated since 1.12 use showStatus instead */
set showCheckedHint(value: boolean);
/** @deprecated since 1.12 use checkedLabel instead */
set checkedHintLabel(value: string);
/** @deprecated since 1.12 use uncheckedLabel instead */
set uncheckedHintLabel(value: string);
ngOnChanges({ message, hint }: SimpleChanges): void;
/**
* Permet d'initialiser de forcer la valeur initiale à une valeur booléenne
* @internal
*/
writeValue(value: boolean | undefined): void;
/**
* @ignore
*/
getDataLabelChecked(): string | null;
/**
* @ignore
*/
getDataLabelUnchecked(): string | null;
/** @internal */
protected hasError(): boolean;
/** @internal */
protected hasSuccess(): boolean;
/** @internal */
protected hasMessage(severity: DsfrSeverity): boolean;
static ɵfac: i0.ɵɵFactoryDeclaration<DsfrFormToggleComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DsfrFormToggleComponent, "dsfr-form-toggle", never, { "labelPosition": { "alias": "labelPosition"; "required": false; }; "labelSrOnly": { "alias": "labelSrOnly"; "required": false; }; "ariaInvalid": { "alias": "ariaInvalid"; "required": false; }; "showStatusLabel": { "alias": "showStatusLabel"; "required": false; }; "checkedStatusLabel": { "alias": "checkedStatusLabel"; "required": false; }; "uncheckedStatusLabel": { "alias": "uncheckedStatusLabel"; "required": false; }; "showSeparator": { "alias": "showSeparator"; "required": false; }; "error": { "alias": "error"; "required": false; }; "valid": { "alias": "valid"; "required": false; }; "message": { "alias": "message"; "required": false; }; "messageSeverity": { "alias": "messageSeverity"; "required": false; }; "messagesGroupId": { "alias": "messagesGroupId"; "required": false; }; "showCheckedHint": { "alias": "showCheckedHint"; "required": false; }; "checkedHintLabel": { "alias": "checkedHintLabel"; "required": false; }; "uncheckedHintLabel": { "alias": "uncheckedHintLabel"; "required": false; }; }, {}, never, ["*"], true, never>;
}