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 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 | 2x 2x 2x 349722x 349722x 349722x 349722x 349722x 349722x 2x 55168x 349722x 349722x 349722x 349722x 349722x 146380x 349722x 349722x 349722x 349722x 349722x 56682x 349722x 349722x 64274x 349722x 349722x 122390x 122390x 349722x 349722x 684x 349722x 56682x 7202x 7202x 49480x 49480x 293040x 115188x 115188x 177852x 177852x 2x 88812x 19565x 44925x 44925x 88812x 5818x 6642x 6642x 88812x 13218x 2x 88963x 19565x 44925x 44925x 88963x 5818x 6642x 6642x 88963x 13218x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 4x 2x 2x 2x 2x 2x 2x 2942x 2942x 2838x 2838x 520x 2318x 2x 262x 262x 262x 108210x 108210x 108210x 108210x 108210x 42984x 43796x 329961x 304341x 304341x 541741x 541741x 2394x 42984x 108210x 262x 554x 55168x 55168x 55168x 122079x 69422x 52657x 49916x 49916x 49916x 49916x 49916x 49910x 49910x 49910x 49910x 49910x 49910x 9946x 49910x 6x 6x 2x 49916x 49916x 6760x 221446x 36283x 4850x 4850x 4850x 31433x 1257x 1257x 1257x 185163x 94610x 94610x 94610x 1575x 1221x 1575x 2x 2752x 2752x 1788x 1788x 70450x 70450x 70450x 70450x 8515x 61935x 61935x 61935x 61935x 61935x 10349x 10349x 40839x 10349x 8221x 8219x 8315x 2x 10349x 40839x 8221x 32618x 32618x 32618x 10349x 588x 588x 588x 9761x 9761x 9761x 40251x 40251x 10349x 2x 130x 128x 2x 2x 146x 22x 124x 124x 5422x 5422x 5422x 5422x 228384x 228384x 127883x 88812x 88812x 88812x 83530x 77268x 88963x 88963x 2361x 17654x 17654x 176x 230x 200x | /**
* 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 Vent from '@adobe/vent';
import {commons, Keys, keys, events, transform, validate, tracking as trackingUtil} from '../../../coral-utils';
// Used to split events by type/target
const delegateEventSplitter = /^(\S+)\s*(.*)$/;
/**
Enumeration representing the tracking options.
@typedef {Object} TrackingEnum
@property {String} ON
Enables tracking of the component interactions.
@property {String} OFF
Disables tracking of the component interactions.
*/
const tracking = {
ON: 'on',
OFF: 'off'
};
/**
Return the method corresponding to the method name or the function, if passed.
@ignore
*/
const getListenerFromMethodNameOrFunction = function (obj, eventName, methodNameOrFunction) {
// Try to get the method
if (typeof methodNameOrFunction === 'function') {
return methodNameOrFunction;
} else if (typeof methodNameOrFunction === 'string') {
if (!obj[methodNameOrFunction]) {
throw new Error(`Coral.Component: Unable to add ${eventName} listener for ${obj.toString()}, method
I ${methodNameOrFunction} not found`);
}
E
Iconst listener = obj[methodNameOrFunction];
if (typeof listener !== 'function') {
throw new Error(`Coral.Component: Unable to add ${eventName} listener for ${obj.toString()}, listener is a
${(typeof listener)} but should be a function`);
}
I
return listener;
} else if (methodNameOrFunction) {
// If we're passed something that's truthy (like an object), but it's not a valid method name or a function, get
// angry
throw new Error(`Coral.Component: Unable to add ${eventName} listener for ${obj.toString()}, ${methodNameOrFunction}
is neither a method name or a function`);
}
return null;
};
/**
Add local event and key combo listeners for this component, store global event/key combo listeners for later.
@ignore
*/
const delegateEvents = function () {
/*
Add listeners to new event
- Include in hash
Add listeners to existing event
- Override method and use super
Remove existing event
- Pass null
*/
let match;
let eventName;
let eventInfo;
let listener;
let selector;
let elements;
let isGlobal;
let isKey;
let isResize;
let isCapture;
for (eventInfo in this._events) {
listener = this._events[eventInfo];
// Extract the event name and the selector
match = eventInfo.match(delegateEventSplitter);
eventName = `${match[1]}.CoralComponent`;
selector = match[2];
if (selector === '') {
// instead of null because the key module checks for undefined
selector = undefined;
}
// Try to get the method corresponding to the value in the map
listener = getListenerFromMethodNameOrFunction(this, eventName, listener);
if (listener) {
// Always execute in the context of the object
E // @todo is this necessary? this should be correct anyway
listener = listener.bind(this);
// Check if the listener is on the window
isGlobal = eventName.indexOf('global:') === 0;
if (isGlobal) {
eventName = eventName.substr(7);
}
// Check if the listener is a capture listener
isCapture = eventName.indexOf('capture:') === 0;
if (isCapture) {
// @todo Limitation: It should be possible to do capture:global:, but it isn't
eventName = eventName.substr(8);
}
// Check if the listener is a key listener
isKey = eventName.indexOf('key:') === 0;
if (isKey) {
if (isCapture) {
throw new Error('Coral.Keys does not currently support listening to key events with capture');
}
eventName = eventName.substr(4);
}I
// Check if the listener is a resize listener
isResize = eventName.indexOf('resize') === 0;
if (isResize) {
if (isCapture) {
throw new Error('Coral.commons.addResizeListener does not currently support listening to resize event with capture');
}
}
if (isGlobal) {
I// Store for adding/removal
if (isKey) {
this._globalKeys = this._globalKeys || [];
this._globalKeys.push({
keyCombo: eventName,
selector: selector,
listener: listener
});
} else {
this._globalEvents = this._globalEvents || [];
this._globalEvents.push({eventName, selector, listener, isCapture});
}
}
// Events on the element itself
else if (isKey) {
// Create the keys instance only if its needed
this._keys = this._keys || new Keys(this, {
// The filter function for keyboard events.
filter: this._filterKeys,
// Execute key listeners in the context of the element
context: this
});
// Add listener locally
this._keys.on(eventName, selector, listener);
} else if (isResize) {
if (selector) {
elements = document.querySelectorAll(selector);
for (let i = 0 ; i < elements.length ; ++i) {
commons.addResizeListener(elements[i], listener);
}
} else {
commons.addResizeListener(this, listener);
}
} else {
this._vent.on(eventName, selector, listener, isCapture);
}I
}
}
};
/**
Attach global event listeners for this component.
@ignore
*/
const delegateGlobalEvents = function () {
let i;
if (this._globalEvents) {
// Remove global event listeners
for (i = 0 ; i < this._globalEvents.length ; i++) {
const event = this._globalEvents[i];
events.on(event.eventName, event.selector, event.listener, event.isCapture);
}
}
if (this._globalKeys) {
// Remove global key listeners
for (i = 0 ; i < this._globalKeys.length ; i++) {
const key = this._globalKeys[i];
keys.on(key.keyCombo, key.selector, key.listener);
}
}
if (this._keys) {
this._keys.init(true);
}
};
/**
Remove global event listeners for this component.
@ignore
*/
const undelegateGlobalEvents = function () {
let i;
if (this._globalEvents) {
// Remove global event listeners
for (i = 0 ; i < this._globalEvents.length ; i++) {
const event = this._globalEvents[i];
events.off(event.eventName, event.selector, event.listener, event.isCapture);
}
}
if (this._globalKeys) {
// Remove global key listeners
for (i = 0 ; i < this._globalKeys.length ; i++) {
const key = this._globalKeys[i];
keys.off(key.keyCombo, key.selector, key.listener);
}
}
if (this._keys) {
this._keys.destroy(true);
}
};
// Used to find upper case characters
const REG_EXP_UPPERCASE = /[A-Z]/g;
/**
Returns the constructor namespace
@ignore
*/
const getConstructorName = function (constructor) {
// Will contain the namespace of the constructor in reversed order
const constructorName = [];
// Keep a reference on the passed constructor
const originalConstructor = constructor;
// Traverses Coral constructors if not already done to set the namespace
if (!constructor._namespace) {
// Set namespace on Coral constructors until 'constructor' is found
const find = (obj, constructorToFind) => {
let found = false;
const type = typeof obj;
if (obj && type === 'object' || type === 'function') {
const subObj = Object.keys(obj);
for (let i = 0 ; i < subObj.length ; i++) {
const key = subObj[i];
// Components are capitalized
if (key[0].match(REG_EXP_UPPERCASE) !== null) {
// Keep a reference of the constructor name and its parent
E obj[key]._namespace = {
parent: obj,
value: key
};
found = obj[key] === constructorToFind;
E if (found) {
break;
} else {
found = find(obj[key], constructorToFind);
}
}
}E
}
return found;
};
// Look for the constructor in the Coral namespace
find(window.Coral, constructor);
}E
// Climb up the constructor namespace
while (constructor) {
if (constructor._namespace) {
constructorName.push(constructor._namespace.value);
constructor = constructor._namespace.parent;
} else {
constructor = false;
}
}
// Build the full namespace string and save it for reuse
originalConstructor._componentName = constructorName.reverse().join('.');
return originalConstructor._componentName;
};
/**
* recursively update the _ignoreConnectedCallback value
* for children coral-component, if parent has ignored the callback
* its child should also ignore the callback hooks
* @private
*/
const _recursiveIgnoreConnectedCallback = function(el, value) {
let children = Array.from(el.children);
for (let i = 0; i < children.length; i++) {
let child = children[i];
// todo better check for coral-component
if(typeof child._ignoreConnectedCallback === 'boolean') {
child._ignoreConnectedCallback = value;
} else {
_recursiveIgnoreConnectedCallback(child, value);
}
}
};
/**
@base BaseComponent
@classdesc The base element for all Coral components
*/
const BaseComponent = (superClass) => class extends superClass {
/** @ignore */
constructor() {
super();
// Attach Vent
this._vent = new Vent(this);
this._events = {};
// Content zone MO for virtual DOM support
if (this._contentZones) {
this._contentZoneObserver = new MutationObserver((mutations) => {
mutations.forEach((mutation) => {
for (let i = 0 ; i < mutation.addedNodes.length ; i++) {
const addedNode = mutation.addedNodes[i];
for (const name in this._contentZones) {
const contentZone = this._contentZones[name];
if (addedNode.nodeName.toLowerCase() === name && !addedNode._contentZoned) {
// Insert the content zone at the right position
/** @ignore */
this[contentZone] = addedNode;
}
}
}
});
});
this._contentZoneObserver.observe(this, {
childList: true,
subtree: true
});
}
}
/**
Tracking of events. This provides insight on the usage of the components. It accepts "ON" and "OFF". In order to
successfully track the events, {Tracking} needs to be configured.
@type {String}
@default TrackingEnum.ON
@htmlattribute tracking
*/
get tracking() {
return this._tracking || this.getAttribute('tracking') || tracking.ON;
}
set tracking(value) {
value = transform.string(value).toLowerCase();
this._tracking = validate.enumeration(tracking)(value) && value || tracking.ON;
}
/**
The string representing the feature being tracked. This provides additional context to the analytics trackers
about the feature that the element enables.
@type {String}
@default ""
@htmlattribute trackingfeature
*/
get trackingFeature() {
return this._trackingFeature || this.getAttribute('trackingFeature') || '';
}
set trackingFeature(value) {
this._trackingFeature = transform.string(value);
}
/**
The string representing the element name being tracked. This providex additional context to the trackers about the
element that was interacted with.
@type {String}
@default ""
@htmlattribute trackingelement
*/
get trackingElement() {
return this._trackingElement || this.getAttribute('trackingElement') || '';
}
set trackingElement(value) {
this._trackingElement = transform.string(value);
}
// Constructs and returns the component name based on the constructor
get _componentName() {
return this.constructor._componentName || getConstructorName(this.constructor);
}
// The filter function for keyboard events. By default, any child element can trigger keyboard events.
// You can pass {@link Keys.filterInputs} to avoid listening to key events triggered from within
// inputs.
_filterKeys() {
return true;
}
// Attach event listeners including global ones
_delegateEvents(eventMap) {
this._events = commons.extend(this._events, eventMap);
delegateEvents.call(this);
// Once events are attached, we dispose them
this._events = {};
}
// Returns the content zone if the component is connected and contains the content zone else null
// Ideally content zones will be replaced by shadow dom and <slot> elements
_getContentZone(contentZone) {
if (document.documentElement.contains(this)) {
return this.contains(contentZone) && contentZone || null;
}
// RetIurn the content zone by default
return contentZone;
}
// Sets Ithe value as content zone for the property given the specified options
// Ideally content zones will be replaced by shadow dom and <slot> elements
_setContentZone(property, value, options) {
const handle = options.handle;
const expectedTagName = options.tagName;
const additionalSetter = options.set;
const insert = options.insert;
let olEdNode;
if (value) {
if (!(value instanceof HTMLElement)) {
throw new Error(`DOMException: Failed to set the "${property}" property on "${this.toString()}":
The provided value is not of type "HTMLElement".`);
}
if (expectedTagName && value.tagName.toLowerCase() !== expectedTagName) {
throw new Error(`DOMException: Failed to set the "${property}" property on "${this.toString()}": The new
${property} element is of type "${value.tagName}". It must be a "${expectedTagName.toUpperCase()}" element.`);
}
oldNode = this._elements[handle];
// Flag it for the content zone MO
value._contentZoned = true;
// Replace the existing element
if (insert) {
// Remove old node
if (oldNode && oldNode.parentNode) {
oldNode.parentNode.removeChild(oldNode);
}
// Insert new node
insert.call(this, value);
} else if (oldNode && oldNode.parentNode) {
commons._log('warn', `${this._componentName} does not define an insert method for content zone ${handle}, falling back to replace.`);
// Old way -- assume we have an old node
this._elements[handle].parentNode.replaceChild(value, this._elements[handle]);
} else {
commons._log('error', `${this._componentName} does not define an insert method for content zone ${handle}, falling back to append.`);
// Just append, which may introduce bugs, but at least doesn't crazy
this.appendChild(value);
}
} else {
// we need to remove the content zone if it exists
oldNode = this._elements[handle];
if (oldNode && oldNode.parentNode) {
oldNode.parentNode.removeChild(oldNode);
}
}
// Re-assign the handle to the new element
this._elements[handle] = value;
// Invoke the setter
if (typeof additionalSetter === 'function') {
additionalSetter.call(this, value);
}
}
// Handles the reflection of properties by using a flag to prevent setting the property by changing the attribute
_reflectAttribute(attributeName, value) {
if (typeof value === 'boolean') {
if (value && !this.hasAttribute(attributeName)) {
this._reflectedAttribute = true;
this.setAttribute(attributeName, '');
this._reflectedAttribute = false;
} else if (!value && this.hasAttribute(attributeName)) {
this._reflectedAttribute = true;
this.removeAttribute(attributeName);
this._reflectedAttribute = false;
}
} else if (this.getAttribute(attributeName) !== String(value)) {
this._reflectedAttribute = true;
this.setAttribute(attributeName, value);
this._reflectedAttribute = false;
}
}
/**
Notifies external listeners about an internal interaction. This method is used internally in every
component's method that we want to track.
@param {String} eventType The event type. Eg. click, select, etc.
@param {String} targetType The element type being used. Eg. cyclebutton, cyclebuttonitem, etc.
@param {CustomEvent} event
@param {BaseComponent} childComponent - Optional, in case the event occurred on a child component.
@returns {BaseComponent}
*/
_trackEvent(eventType, targetType, event, childComponent) {
if (this.tracking === this.constructor.tracking.ON) {
trackingUtil.track(eventType, targetType, event, this, childComponent);
}
return this;
}
/**
Returns the component name.
@return {String}
*/
toString() {
return `Coral.${this._componentName}`;
}
/**
Add an event listener.
@param {String} eventName
The event name to listen for.
@param {String} [selector]
The selector to use for event delegation.
@param {Function} func
The function that will be called when the event is triggered.
@param {Boolean} [useCapture=false]
Whether or not to listen during the capturing or bubbling phase.
@returns {BaseComponent} this, chainable.
*/
on(eventName, selector, func, useCapture) {
this._vent.on(eventName, selector, func, useCapture);
return this;
}
/**
Remove an event listener.
@param {String} eventName
The event name to stop listening for.
@param {String} [selector]
The selector that was used for event delegation.
@param {Function} func
The function that was passed to <code>on()</code>.
@param {Boolean} [useCapture]
Only remove listeners with <code>useCapture</code> set to the value passed in.
@returns {BaseComponent} this, chainable.
*/
off(eventName, selector, func, useCapture) {
this._vent.off(eventName, selector, func, useCapture);
return this;
}
/**
Trigger an event.
@param {String} eventName
The event name to trigger.
@param {Object} [props]
Additional properties to make available to handlers as <code>event.detail</code>.
@param {Boolean} [bubbles=true]
Set to <code>false</code> to prevent the event from bubbling.
@param {Boolean} [cancelable=true]
Set to <code>false</code> to prevent the event from being cancelable.
@returns {CustomEvent} CustomEvent object
*/
trigger(eventName, props, bubbles, cancelable) {
// When 'bubbles' is not set, then default to true:
bubbles = bubbles || bubbles === undefined;
// When 'cancelable' is not set, then default to true:
cancelable = cancelable || cancelable === undefined;
const event = new CustomEvent(eventName, {
bubbles: bubbles,
cancelable: cancelable,
detail: props
});
// Don't trigger the event if silenced
if (this._silenced) {
return event;
}
// dIefault value in case the dispatching fails
let defaultPrevented = false;
try {
// leads to NS_ERROR_UNEXPECTED in Firefox
// https://bugzilla.mozilla.org/show_bug.cgi?id=329509
defaultPrevented = !this.dispatchEvent(event);
}
// eslint-disable-next-line no-empty
catch (e) {
}
// Check if the defaultPrevented status was correctly stored back to the event object
if (defaultPrevented !== event.defaultPrevented) {
// dispatchEvent() doesn't correctly set event.defaultPrevented in IE 9
// However, it does return false if preventDefault() was called
// Unfortunately, the returned event's defaultPrevented property is read-only
// We need to work around this such that (patchedEvent instanceof Event) === true
// First, we'll create an object that uses the event as its prototype
// This gives us an object we can modify that is still technically an instanceof Event
const patchedEvent = Object.create(event);
// Next, we set the correct value for defaultPrevented on the new object
// We cannot simply assign defaultPrevented, it causes a "Invalid Calling Object" error in IE 9
// For some reason, defineProperty doesn't cause this
Object.defineProperty(patchedEvent, 'defaultPrevented', {
value: defaultPrevented
});
return patchedEvent;
}
return event;
}
/**
Set multiple properties.
@param {Object.<String, *>} properties
An object of property/value pairs to set.
@param {Boolean} silent
If true, events should not be triggered as a result of this set.
@returns {BaseComponent} this, chainable.
*/
set(propertyOrProperties, valueOrSilent, silent) {
let property;
let properties;
let value;
const isContentZone = (prop) => this._contentZones && commons.swapKeysAndValues(this._contentZones)[prop];
const updateContentZone = (prop, val) => {
// If content zone exists and we only want to update properties on the content zone
if (this[prop] instanceof HTMLElement && !(val instanceof HTMLElement)) {
for (const contentZoneProperty in val) {
/** @ignore */
this[prop][contentZoneProperty] = val[contentZoneProperty];
}
}
// Else assign the new value to the content zone
else {
/** @ignore */
this[prop] = val;
}
};
const setProperty = (prop, val) => {
if (isContentZone(prop)) {
updateContentZone(prop, val);
} else {
this._silenced = silent;
/** @ignore */
this[prop] = val;
this._silenced = false;
}
};
if (typeof propertyOrProperties === 'string') {
// Set a single property
property = propertyOrProperties;
value = valueOrSilent;
setProperty(property, value);
} else {
properties = propertyOrProperties;
silent = valueOrSilent;
// Set a map of properties
for (property in properties) {
value = properties[property];
setProperty(property, value);
}
}
return this;
}
/**
Get the value of a property.
@param {String} property
The name of the property to fetch the value of.
@returns {*} Property value.
*/
get(property) {
return this[property];
}
/**
Show this component.
@returns {BaseComponent} this, chainable
*/
show() {
if (!this.hidden) {
return this;
}
/** @ignore */
this.hidden = false;
return this;
}
/**
Hide this component.
@returns {BaseComponent} this, chainable
*/
hide() {
if (this.hidden) {
return this;
}
/** @ignore */
this.hidden = true;
return this;
}
/**
This should be executed when messenger is connect event is connected.
It will add the parent as a listener in child messenger.
@ignEore
*/
_onMessengerConnected(event) {
event.stopImmediatePropagation();
let handler = event.detail.handler;
if(typeof handler === 'function') {
handler(this);
} else {
throw new Error("Messenger handler should be a function");
}
}
/**
specify whether the connected and disconnected hooks are ignore for component
@returns true when ignored
@private
*/
get _ignoreConnectedCallback() {
return this.__ignoreConnectedCallback || false;
}
set _ignoreConnectedCallback(value) {
value = transform.booleanAttr(value);
if(value !== this.__ignoreConnectedCallback) {
this.__ignoreConnectedCallback = value;
_recursiveIgnoreConnectedCallback(this, value);
}
}
/**
Returns {@link BaseComponent} tracking options.
@return {TrackingEnum}
*/
static get tracking() {
return tracking;
}
static get _attributePropertyMap() {
return {
trackingelement: 'trackingElement',
trackingfeature: 'trackingFeature'
};
}
/** @ignore */
static get observedAttributes() {
return [
'tracking',
'trackingelement',
'trackingfeature',
'trackingFeature'
];
}
/** @ignore */
// eslint-disable-next-line no-unused-vars
attributeChangedCallback(name, oldValue, value) {
const self = this;
if (!self._reflectedAttribute) {
// Use the attribute/property mapping
self[self.constructor._attributePropertyMap[name] || name] = value;
}
}
/**
called when we need to suspend state and properties, when
disconnected callback are skipped.
@private
*/
_suspendCallback() {
// do nothing
}
/**
called when we need to re-initialise state and properties, when
connected callback are skipped.
@private
*/
_resumeCallback() {
// do nothing
}
/** @ignore */
connectedCallback() {
// A component that is reattached should respond to global events again
// Attach global listener when component is connected to DOM
// this would avoid memory leak when element is created but never connected.
delegateGlobalEvents.call(this);
this._disconnected = false;
if (!this._rendered) {
this.render();
}
}
/** @ignore */
render() {
this._rendered = true;
}
/** @ignore */
disconnectedCallback() {
// A component that isn't in the DOM should not be responding to global events
this._disconnected = true;
undelegateGlobalEvents.call(this);
}
};
export default BaseComponent;
|