All files / coral-component-banner/src/scripts Banner.js

97.78% Statements 44/45
86.67% Branches 13/15
100% Functions 14/14
97.78% Lines 44/45

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184                                          2x                           2x           2x   2x 6x                     2x 2x   2x           84x   84x   84x       84x                     2x         72x   72x   72x 12x     72x 72x   72x 14x 10x   10x     10x           72x 72x         4x         80x 80x   80x     80x     80x                     4x     74x       74x 74x                         4x     74x       74x 74x             532x        
/**
 * Copyright 2019 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
 
import {BaseComponent} from '../../../coral-base-component';
import {transform, validate} from '../../../coral-utils';
import {Decorator} from '../../../coral-decorator';
 
const CLASSNAME = '_coral-Banner';
 
/**
 Enumeration for {@link Banner} variants.
 
 @typedef {Object} BannerVariantEnum
 
 @property {String} ERROR
 A banner to indicate that an error has occurred.
 @property {String} WARNING
 A banner to warn the user of something important.
 @property {String} INFO
 A banner to inform the user of non-critical information.
 */
const variant = {
  ERROR: 'error',
  WARNING: 'warning',
  INFO: 'info'
};
 
// An array of all possible variant classnames
const ALL_VARIANT_CLASSES = [];
for (const variantValue in variant) {
  ALL_VARIANT_CLASSES.push(`${CLASSNAME}--${variant[variantValue]}`);
}
 
/**
 @class Coral.Banner
 @classdesc A Banner component
 @htmltag coral-banner
 @extends {HTMLElement}
 @extends {BaseComponent}
 */
const Banner = Decorator(class extends BaseComponent(HTMLElement) {
  /** @ignore */
  constructor() {
    super();
 
    // Fetch content zones
    this._elements = {
      header: this.querySelector('coral-banner-header') || document.createElement('coral-banner-header'),
      content: this.querySelector('coral-banner-content') || document.createElement('coral-banner-content')
    };
  }
 
  /**
   The banner variant style to use. See {@link BannerVariantEnum}.
 
   @type {String}
   @default BannerVariantEnum.INFO
   @htmlattribute variant
   @htmlattributereflected
   */
  get variant() {
    return this._variant || variant.INFO;
  }
 
  set variant(value) {
    value = transform.string(value).toLowerCase();
    this._variant = validate.enumeration(variant)(value) && value || variant.INFO;
    this._reflectAttribute('variant', this._variant);
 
    // Remove all variant classes
    this.classList.remove(...ALL_VARIANT_CLASSES);
 
    // Set new variant class
    this.classList.add(`${CLASSNAME}--${this._variant}`);
  }
 
  /**
   The banner's header.
 
   @type {BannerHeader}
   @contentzone
   */
  get header() {
    return this._getContentZone(this._elements.header);
  }
 
  set header(value) {
    this._setContentZone('header', value, {
      handle: 'header',
      tagName: 'coral-banner-header',
      insert: function (header) {
        header.classList.add(`${CLASSNAME}-header`);
        this.insertBefore(header, this.firstChild);
      }
    });I
  }
 
  /**
   The banner's content.
 
   @type {BannerContent}
   @contentzone
   */
  get content() {
    return this._getContentZone(this._elements.content);
  }
 
  set content(value) {
    this._setContentZone('content', value, {
      handle: 'content',
      tagName: 'coral-banner-content',
      insert: function (content) {
        content.classList.add(`${CLASSNAME}-content`);
        this.appendChild(content);
      }
    });
  }
 
  get _contentZones() {
    return {
      'coral-banner-header': 'header',
      'coral-banner-content': 'content'
    };
  }
 
  /**
   Returns {@link Banner} variants.
 
   @return {BannerVariantEnum}
   */
  static get variant() {
    return variant;
  }
 
  /** @ignore */
  static get observedAttributes() {
    return ['variant'];
  }
 
  /** @ignore */
  render() {
    super.render();
 
    this.classList.add(CLASSNAME);
 
    // Default reflected attributes
    if (!this._variant) {
      this.variant = variant.INFO;
    }
 
    const header = this._elements.header;
    const content = this._elements.content;
 
    // When the content zone was not created, we need to make sure that everything is added inside it as a content.
    if (!content.parentNode) {
      while (this.firstChild) {
        const child = this.firstChild;
 
        // Don't move header into content
        if (child === header) {
          child.remove();
        } else {
          content.appendChild(this.firstChild);
        }
      }
    }
 
    // Assign content zones
    this.header = this._elements.header;
    this.content = this._elements.content;
  }
});
 
export default Banner;