All files / coral-component-switch/src/scripts Switch.js

88.16% Statements 67/76
90.32% Branches 28/31
86.21% Functions 25/29
88.16% Lines 67/76

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 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324                                                  2x                   2x 2x   2x           148x   148x   148x           148x       148x         148x   148x   148x                 148x                       2x               264x   264x   264x 264x                                     2x                 6x                 128x   128x   128x 128x   128x 128x 128x 128x   128x 30x       128x 92x   92x   2x     90x         128x   128x   128x     128x         162x     56x   56x   56x                     10x     128x       128x                             16x     12x   12x                       20x     16x                         24x     26x   26x   26x 26x 26x                         2x                                       2x                                 256x     4x   4x            
/**
 * 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 {BaseFormField} from '../../../coral-base-formfield';
import base from '../templates/base';
import {transform, commons, i18n} from '../../../coral-utils';
import {Decorator} from '../../../coral-decorator';
 
const CLASSNAME = '_coral-ToggleSwitch';
 
/**
 @class Coral.Switch
 @classdesc A Switch component is a toggle form field similar to a Checkbox component.
 @htmltag coral-switch
 @extends {HTMLElement}
 @extends {BaseComponent}
 @extends {BaseFormField}
 */
const Switch = Decorator(class extends BaseFormField(BaseComponent(HTMLElement)) {
  /** @ignore */
  constructor() {
    super();
 
    // Make sure the events from the FormField are attached
    this._delegateEvents(commons.extend(this._events, {
      'capture:focus ._coral-ToggleSwitch-input': '_onFocus',
      'capture:blur ._coral-ToggleSwitch-input': '_onBlur'
    }));
 
    // Prepare templates
    this._elements = {
      // Try to find the label content zone
      label: this.querySelector('coral-switch-label') || document.createElement('coral-switch-label')
    };
    base.call(this._elements, {commons, i18n});
 
    // Pre-define labellable element
    this._labellableElement = this._elements.input;
 
    // Check if the label is empty whenever we get a mutation
    this._observer = new MutationObserver(this._hideLabelIfEmpty.bind(this));
 
    // Watch for changes to the label element's children
    this._observer.observe(this._elements.labelWrapper, {
      // Catch changes to childList
      childList: true,
      // Catch changes to textContent
      characterData: true,
      // Monitor any child node
      subtree: true
    });
  }
 
  /**
   Whether the switch is on or off.
 
   @type {Boolean}
   @default false
   @htmlattribute checked
   @htmlattributereflected
   @emits {change}
   */
  get checked() {
    return this._checked || false;
  }
 
  set checked(value) {
    this._checked = transform.booleanAttr(value);
    this._reflectAttribute('checked', this._checked);
 
    this._elements.input.checked = this._checked;
  }
 
  /**
   The switch's label element.
 
   @type {SwitchLabel}
   @contentzone
   */
  get label() {
    return this._getContentZone(this._elements.label);
  }
 
  set label(value) {
    this._setContentZone('label', value, {
      handle: 'label',
      tagName: 'coral-switch-label',
      insert: function (label) {
        this._elements.labelWrapper.appendChild(label);
      }
    });
  }
 
  /**
   Name used to submit the data in a form.
   @type {String}
   @default ""
   @htmlattribute name
   @htmlattributereflected
   */
  get name() {
    return this._elements.input.name;
  }
 
  set name(value) {
    this._reflectAttribute('name', value);
 
    this._elements.input.name = value;
  }
 
  /**
   The value that will be submitted when the checkbox is checked. Changing this value will not trigger an event.
 
   @type {String}
   @default "on"
   @htmlattribute value
   */
  get value() {
    return this._elements.input.value || 'on';
  }
 
  set value(value) {
    this._elements.input.value = value;
  }
 
  /**
   Whether this field is disabled or not.
   @type {Boolean}
   @default false
   @htmlattribute disabled
   @htmlattributereflected
   */
  get disabled() {
    return this._disabled || false;
  }
 
  set disabled(value) {
    this._disabled = transform.booleanAttr(value);
    this._reflectAttribute('disabled', this._disabled);
 
    this[this._disabled ? 'setAttribute' : 'removeAttribute']('aria-disabled', this._disabled);
    this.classList.toggle('is-disabled', this._disabled);
    this._elements.input.disabled = this._disabled;
  }
 
  /**
   Whether this field is required or not.
   @type {Boolean}
   @default false
   @htmlattribute required
   @htmlattributereflected
   */
  get required() {
    return this._required || false;
  }
 
  set required(value) {
    this._required = transform.booleanAttr(value);
    this._reflectAttribute('required', this._required);
 
    this._elements.input.required = this._required;
  }
 
  /**
   Whether this field is readOnly or not. Indicating that the user cannot modify the value of the control.
   @type {Boolean}
   @default false
   @htmlattribute readonly
   @htmlattributereflected
   */
  get readOnly() {
    return this._readOnly || false;
  }
 
  set readOnly(value) {
    this._readOnly = transform.booleanAttr(value);
    this._reflectAttribute('readonly', this._readOnly);
 
    this.classList.toggle('is-readOnly', this._readOnly);
    this._elements.input.tabIndex = this._readOnly ? -1 : 0;
  }
 
  /**
   Inherited from {@link BaseFormField#labelled}.
   */
  get labelled() {
    return super.labelled;
  }
 
  set labelled(value) {
    super.labelled = value;
 
    this._hideLabelIfEmpty();
  }
 
  /*
   Indicates to the formField that the 'checked' property needs to be set in this component.
 
   @protected
   */
  get _componentTargetProperty() {
    return 'checked';
  }
 
  /*
   Indicates to the formField that the 'checked' property has to be extracted from the event.
 
   @protected
   */
  get _eventTargetProperty() {
    return 'checked';
  }
 
  /**
   Hide the label if it's empty.
 
   @ignore
   */
  _hideLabelIfEmpty() {
    const label = this._elements.label;
 
    // If it's empty and has no non-textnode children, hide the label
    const hiddenValue = !(label.children.length === 0 && label.textContent.replace(/\s*/g, '') === '');
 
    // Toggle the screen reader text
    this._elements.labelWrapper.style.margin = !hiddenValue ? '0' : '';
    this._elements.screenReaderOnly.hidden = hiddenValue || this.labelled;
  }
 
  _onFocus() {
    this._elements.input.classList.add('focus-ring');
  }
 
  _onBlur() {
    this._elements.input.classList.remove('focus-ring');
  }
 
  get _contentZones() {
    return {'coral-switch-label': 'label'};
  }
 
  /**
   Inherited from {@link BaseFormField#clear}.
   */
  clear() {
    this.checked = false;
  }
 
  /**
   Inherited from {@link BaseFormField#reset}.
   */
  reset() {
    this.checked = this._initialCheckedState;
  }
 
  /** @ignore */
  static get observedAttributes() {
    return super.observedAttributes.concat(['checked']);
  }
 
  /** @ignore */
  render() {
    super.render();
 
    this.classList.add(CLASSNAME);
 
    // Create a fragment
    const frag = document.createDocumentFragment();

    const templateHandleNames = ['input', 'switch', 'labelWrapper'];

    // Render the template
    frag.appendChild(this._elements.input);
    frag.appendChild(this._elements.switch);
    frag.appendChild(this._elements.labelWrapper);
 
    const label = this._elements.label;
 
    // Remove it so we can process children
    if (label && label.parentNode) {
      label.parentNode.removeChild(label);
    }
 
    // Clean up
    while (this.firstChild) {
      const child = this.firstChild;
      // Only works if all root template elements have a handle attribute
      if (child.nodeType === Node.TEXT_NODE ||
        child.nodeType === Node.ELEMENT_NODE && templateHandleNames.indexOf(child.getAttribute('handle')) === -1) {
        // Add non-template elements to the content
        label.appendChild(child);
      } else {
        // Remove anything else
        this.removeChild(child);
      }
    }
 
    // Append the fragment to the component
    this.appendChild(frag);
 
    // Assign the content zones, moving them into place in the process
    this.label = label;
 
    // Cache the initial checked state of the switch (in order to implement reset)
    this._initialCheckedState = this.checked;
 
    // Check if we need to hide the label
    // We must do this because IE does not catch mutations when nodes are not in the DOM
    this._hideLabelIfEmpty();
  }
});
 
export default Switch;