All files / coral-base-fieldgroup/src/scripts BaseFieldGroup.js

96.55% Statements 28/29
81.82% Branches 9/11
90.91% Functions 10/11
96.55% Lines 28/29

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                                          2x                       2x                 2x 6x 6x   6x     66x   66x     6x         54x   54x   54x   54x 32x                         24x 8x           24x                         8x     60x 60x   60x   60x 60x 60x                         2x              
/**
 * Copyright 2020 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 {SelectableCollection} from '../../../coral-collection';
import {transform, validate} from '../../../coral-utils';
 
// @compat
const CLASSNAME = 'coral-RadioGroup';
 
/**
 Enumeration for {@link BaseFieldGroup} orientations.
 
 @typedef {Object} BaseFieldGroupOrientationEnum
 
 @property {String} HORIZONTAL
 Horizontal default orientation.
 @property {String} VERTICAL
 Vertical orientation.
 */
const orientation = {
  HORIZONTAL: 'horizontal',
  VERTICAL: 'vertical'
};
 
/**
 @base BaseFieldGroup
 @classdesc The base element for FieldGroup components
 */
const BaseFieldGroup = (superClass) => class extends superClass {
  /**
   The Collection Interface that allows interacting with the items that the component contains.
 
   @type {SelectableCollection}
   @readonly
   */
  get items() {
    // Construct the collection on first request:
    if (!this._items) {
      this._items = new SelectableCollection({
        itemTagName: this._itemTagName,
        host: this
      });
    }
 
    return this._items;
  }
 
  /**
   Orientation of the field group. See {@link BaseFieldGroupOrientationEnum}.
 
   @type {String}
   @default BaseFieldGroupOrientationEnum.HORIZONTAL
   @htmlattribute orientation
   @htmlattributereflected
   */
  get orientation() {
    return this._orientation || orientation.HORIZONTAL;
  }
 
  set orientation(value) {
    value = transform.string(value).toLowerCase();
    value = validate.enumeration(this.constructor.orientation)(value) && value || orientation.HORIZONTAL;
    
    this._reflectAttribute('orientation', value);
    
    if(validate.valueMustChange(this._orientation, value)) {
      this._orientation = value;
 
      this.classList.toggle(`${CLASSNAME}--vertical`, value === orientation.VERTICAL);
    }
  }
 
  /**
   Returns the first selected field group item in the Field Group. The value <code>null</code> is returned if no item is
   selected.
 
   @type {HTMLElement}
   @readonly
   */
  get selectedItem() {
    return this.items._getFirstSelected('checked');
  }
 
  /** @private */
  get _itemTagName() {
    // Used for Collection
    return 'coral-fieldgroup-item';
  }
 
  /**
   Returns {@link BaseFieldGroup} orientation options.
 
   @return {BaseFieldGroupEnum}
   */
  static get orientation() {
    return orientation;
  }
 
  /** @iEgnore */
  static get observedAttributes() {
    return super.observedAttributes.concat(['orientation']);
  }
 
  /** @ignore */
  render() {
    super.render();
 
    this.classList.add(CLASSNAME);
 
    // a11y
    this.setAttribute('role', 'group');
 
    // Default reflected attributes
    if (!this._orientation) {
      this.orientation = orientation.HORIZONTAL;
    }
  }
};
 
export default BaseFieldGroup;