@eui/ecl 19.3.1 → 19.3.2-snapshot-1752652198707

package/fesm2022/eui-ecl-components-ecl-site-footer.mjs

@@ -13,13 +13,22 @@ import { Subject } from 'rxjs';
 import { takeUntil } from 'rxjs/operators';
 import * as i1$1 from '@eui/core';
 
+/**
+ * Directive, that applies specific classes to the section element in site footer.
+ */
 class EclSiteFooterSectionDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
         this.cmpClass = true;
+        /**
+         * @deprecated - not used anymore. Will be removed in v20
+         */
         this.isCondensed = false;
         this.isSiteInfo = false;
         this.isSplitList = false;
+        /**
+         * If there should be a <hr> as separator with the next section.
+         */
         this.hasSeparator = false;
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: EclSiteFooterSectionDirective, deps: null, target: i0.ɵɵFactoryTarget.Directive }); }
@@ -60,6 +69,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 args: [{ transform: booleanAttribute }]
             }] } });
 
+/**
+ * Directive, that applies specific classes to the list element in site footer.
+ */
 class EclSiteFooterListDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -90,6 +102,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__list--columns']
             }] } });
+/**
+ * Directive, that applies specific classes to the list item element in site footer.
+ */
 class EclSiteFooterListItemDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -108,6 +123,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__list-item']
             }] } });
+/**
+ * @deprecated - this directive is deprecated and will be removed in v20. Not used anymore.
+ */
 class EclSiteFooterLogoListDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -126,6 +144,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__logo-list']
             }] } });
+/**
+ * @deprecated - this directive is deprecated and will be removed in v20. Not used anymore.
+ */
 class EclSiteFooterLogoItemDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -144,6 +165,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__logo-item']
             }] } });
+/**
+ * @deprecated - this directive is deprecated and will be removed in v20. Not used anymore.
+ */
 class EclSiteFooterLogoDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -163,6 +187,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 args: ['class.ecl-site-footer__logo']
             }] } });
 
+/**
+ * Directive, that applies a specific class to a <a> element in site footer.
+ */
 class EclSiteFooterLinkDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -181,6 +208,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__link']
             }] } });
+/**
+ * Directive, that applies a specific class to the <a> element for the logo in site footer.
+ */
 class EclSiteFooterLogoLinkDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -199,6 +229,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__logo-link']
             }] } });
+/**
+ * Directive, that applies a specific class to the <a> element for the logo in site footer.
+ */
 class EclSiteFooterLogoImageDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -217,6 +250,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__logo-image']
             }] } });
+/**
+ * Directive, that applies a specific class to the <img> element for the logo in site footer.
+ */
 class EclSiteFooterPictureDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -236,6 +272,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 args: ['class']
             }] } });
 
+/**
+ * Directive, that applies a specific class to a footer column.
+ */
 class EclSiteFooterColumnDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -254,6 +293,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__column']
             }] } });
+/**
+ * Directive, that applies a specific class to a footer row.
+ */
 class EclSiteFooterRowDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -272,13 +314,17 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__row']
             }] } });
+/**
+ * Directive, that applies a specific class to footer content.
+ * @deprecated - use 'eclSiteFooterTitle' instead.
+ */
 class EclSiteFooterContentDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
         this.cmpClass = true;
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: EclSiteFooterContentDirective, deps: null, target: i0.ɵɵFactoryTarget.Directive }); }
-    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "19.2.14", type: EclSiteFooterContentDirective, isStandalone: false, selector: "[eclSiteFooterContent]", host: { properties: { "class.ecl-site-footer__content": "this.cmpClass" } }, usesInheritance: true, ngImport: i0 }); }
+    static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "19.2.14", type: EclSiteFooterContentDirective, isStandalone: false, selector: "[eclSiteFooterContent]", host: { properties: { "class.ecl-site-footer__title": "this.cmpClass" } }, usesInheritance: true, ngImport: i0 }); }
 }
 i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: EclSiteFooterContentDirective, decorators: [{
             type: Directive,
@@ -288,12 +334,19 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 }]
         }], propDecorators: { cmpClass: [{
                 type: HostBinding,
-                args: ['class.ecl-site-footer__content']
+                args: ['class.ecl-site-footer__title']
             }] } });
 
+/**
+ * There is some fixed content in the site footer, that cannot be changed by the user and is mandatory.
+ * This component represents this fixed content.
+ */
 class EclSiteFooterFixedContentECComponent extends ECLBaseDirective {
     constructor() {
         super(...arguments);
+        /**
+         * The component is showing different content, depending if it's core site footer or not.
+         */
         this.isCore = false;
     }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "19.2.14", ngImport: i0, type: EclSiteFooterFixedContentECComponent, deps: null, target: i0.ɵɵFactoryTarget.Component }); }
@@ -313,6 +366,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: Input
             }] } });
 
+/**
+ * Directive, that applies a specific class for a title in ecl-site-footer component.
+ */
 class EclSiteFooterTitleDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -338,6 +394,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: HostBinding,
                 args: ['class.ecl-site-footer__title--separator']
             }] } });
+/**
+ * Directive, that applies a specific class for the <a> element in a title in ecl-site-footer component.
+ */
 class EclSiteFooterTitleLinkDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -357,9 +416,16 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 args: ['class.ecl-site-footer__title-link']
             }] } });
 
+/**
+ * There is some fixed content in the site footer, that cannot be changed by the user and is mandatory.
+ * This component represents this fixed content.
+ */
 class EclSiteFooterFixedContentEUComponent extends ECLBaseDirective {
     constructor() {
         super(...arguments);
+        /**
+         * The component is showing different content, depending if it's core site footer or not.
+         */
         this.isCore = false;
         this.availableLanguagesForLinkEib = ['fr', 'de', 'en'];
         this.defaultLanguage = 'en';
@@ -389,6 +455,9 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 type: Input
             }] } });
 
+/**
+ * Directive, that applies a specific class to footer description.
+ */
 class EclSiteFooterDescriptionDirective extends ECLBaseDirective {
     constructor() {
         super(...arguments);
@@ -408,6 +477,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "19.2.14", ngImpo
                 args: ['class.ecl-site-footer__description']
             }] } });
 
+/**
+ * The site footer component content provides supplementary information such as a sitemap, copyright and legal notices,
+ *  privacy and accessibility statements, social media and contact information as well as various links to other
+ *  important sections within the EC ecosystem.
+ */
 class EclSiteFooterComponent extends ECLBaseDirective {
     get cssClasses() {
         return [super.getCssClasses('ecl-site-footer'), this.isCore ? 'ecl-site-footer--split-columns' : ''].join(' ').trim();
@@ -416,8 +490,17 @@ class EclSiteFooterComponent extends ECLBaseDirective {
         super();
         this.i18nService = i18nService;
         this.eclThemeService = eclThemeService;
+        /**
+         * The current language of the page.
+         */
         this.languageCode = 'en';
+        /**
+         * If it's a core site footer. The content of the footer for the Core configuration is specific and all items mandatory.
+         */
         this.isCore = false;
+        /**
+         * The role of the component is 'contentinfo' and should not be changed.
+         */
         this.role = 'contentinfo';
         this.destroy$ = new Subject();
     }