@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).
72 lines (71 loc) • 3.68 kB
TypeScript
import { DsfrFileSizeUnit, I18nService, LangService } from '../../shared';
import { DsfrDownloadVariant } from './download-variant';
import { DsfrDownload } from './download.model';
import * as i0 from "@angular/core";
export declare class DsfrDownloadComponent implements DsfrDownload {
private langService;
/** @internal */ i18n: I18nService;
/**
* Obligatoire si le document n'est pas du même langage que la page courante.
* Ex : langCode="en".
*/
langCode: string;
/**
* Equivalent à l'attribut html natif 'download'.
* Si == 'true', télécharge directement le fichier sans l'ouvrir, 'false' par défaut.
* Peut prendre le nom du fichier à télécharger si on souhaite renommer ce fichier.
*/
directDownload: boolean | string;
/**
* Lien de téléchargement du fichier.
* Si cette propriété n'est pas renseignée, un bouton remplace l'ancre et l'événement (click) du bouton doit être intercepté.
*/
link: string;
/** Format du fichier - obligatoire. Cf. DsfrMimeType */
mimeType: string;
/** Nom du ficher - obligatoire. */
fileName: string;
/** Poids du fichier en octets. Obligatoire dans le Dsfr mais peut être renseigné ultérieurement. */
sizeBytes: number | undefined;
/** Permet de basculer la présentation en card. */
variant: DsfrDownloadVariant;
/** Description du fichier (uniquement en mode bloc). */
description: string;
/**
* Indique que les métadonnées du fichier seront positionnées automatiquement par le script DSFR. Les propriétés
* fileMimeType, fileSizeBytes, hreflang sont alors ignorées. Si la propriété est positionnée à false alors ce sont
* les valeurs des propriétés fileMimeType, fileSizeBytes, hreflang qui seront utlisées.
*/
assessFile: boolean;
/** cf. accesseurs. */
private _sizeUnit;
constructor(langService: LangService,
/** @internal */ i18n: I18nService);
get currentLang(): string;
/**
* Retourne l'affichage des détails dans cas précis, sinon retourne '' et laisse calculer l'affichage par le script DSFR.
*/
get detail(): string;
get sizeUnit(): DsfrFileSizeUnit;
/**
* Permet d'afficher la taille soit en bytes (KB, MB, ...) soit en octets (Ko, Mo, ...). Par défaut, l'unité est
* en octets lorsque la langue courante est 'fr', 'bytes' dans les autres cas.
*/
set sizeUnit(value: DsfrFileSizeUnit);
/**
* Retourne vrai si on affiche un bouton à la place d'une ancre.
* @internal
*/
hasButtonMarkup(): boolean;
/**
* Si === 'true', télécharge directement le fichier sans l'ouvrir, 'false' par défaut.
* @internal
*/
isDirectDownload(): boolean;
/** @internal */
getNewFileName(): string;
/** @internal */
isBlockMode(): boolean;
static ɵfac: i0.ɵɵFactoryDeclaration<DsfrDownloadComponent, never>;
static ɵcmp: i0.ɵɵComponentDeclaration<DsfrDownloadComponent, "dsfr-download", never, { "langCode": { "alias": "langCode"; "required": false; }; "directDownload": { "alias": "directDownload"; "required": false; }; "link": { "alias": "link"; "required": false; }; "mimeType": { "alias": "mimeType"; "required": false; }; "fileName": { "alias": "fileName"; "required": false; }; "sizeBytes": { "alias": "sizeBytes"; "required": false; }; "variant": { "alias": "variant"; "required": false; }; "description": { "alias": "description"; "required": false; }; "assessFile": { "alias": "assessFile"; "required": false; }; "sizeUnit": { "alias": "sizeUnit"; "required": false; }; }, {}, never, never, false, never>;
}