@edugouvfr/ngx-dsfr/lib/components/header/header.model.d.ts

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

import { DsfrLink } from '../../shared';
import { DsfrLang } from '../translate';
import { DsfrMegaMenu } from './component/mega-menu.model';
/**
 * Entrée du menu dans le header. Peut contenir un sous-menu (déroulant), un méga-menu ou être un lien direct.
 */
export interface DsfrHeaderMenuItem extends DsfrLink {
    /**
     * Est étendu (dans le cas ou il contient un menu déroulant ou méga-menu).
     */
    expanded?: boolean;
    /**
     * Méga-menu (optionnel).
     */
    megaMenu?: DsfrMegaMenu;
    /**
     * Sous-menu affiché en tant que ménu déroulant (optionnel).
     */
    subItems?: DsfrLink[];
}
/**
 * Permet de configurer le sélecteur de langues à afficher dans le header.
 */
export interface DsfrHeaderTranslate {
    /**
     * Liste des langues proposées à l'utilisateur.
     * @see {@link DsfrLang}
     *
     */
    languages: DsfrLang[];
    /**
     * Code de la langue courante.
     *
     * @deprecated (since 1.7.0) Il est conseillé de plus imposer une langue à ce niveau, la langue du site défini par l'utilisateur est rerouver soit dans le localStorage soit à défaut dans la balise html du site.
     */
    currentLangCode?: string;
}
/**
 * Définit les icônes supportées par les liens rapides du header (non utilisé).
 */
export type DsfrBtnIcon = [
    'fr-btn--account',
    'fr-btn--briefcase',
    'fr-btn--close',
    'fr-btn--display',
    'fr-btn--fullscreen',
    'fr-btn--team',
    'fr-btn--tooltip'
];