UNPKG

carbon-custom-elements

Version:

A Carbon Design System variant that's as easy to use as native HTML elements, with no framework tax, no framework silo.

658 lines (560 loc) 29.7 kB
let _ = t => t, _t; function _decorate(decorators, factory, superClass, mixins) { var api = _getDecoratorsApi(); if (mixins) { for (var i = 0; i < mixins.length; i++) { api = mixins[i](api); } } var r = factory(function initialize(O) { api.initializeInstanceElements(O, decorated.elements); }, superClass); var decorated = api.decorateClass(_coalesceClassElements(r.d.map(_createElementDescriptor)), decorators); api.initializeClassElements(r.F, decorated.elements); return api.runClassFinishers(r.F, decorated.finishers); } function _getDecoratorsApi() { _getDecoratorsApi = function () { return api; }; var api = { elementsDefinitionOrder: [["method"], ["field"]], initializeInstanceElements: function (O, elements) { ["method", "field"].forEach(function (kind) { elements.forEach(function (element) { if (element.kind === kind && element.placement === "own") { this.defineClassElement(O, element); } }, this); }, this); }, initializeClassElements: function (F, elements) { var proto = F.prototype; ["method", "field"].forEach(function (kind) { elements.forEach(function (element) { var placement = element.placement; if (element.kind === kind && (placement === "static" || placement === "prototype")) { var receiver = placement === "static" ? F : proto; this.defineClassElement(receiver, element); } }, this); }, this); }, defineClassElement: function (receiver, element) { var descriptor = element.descriptor; if (element.kind === "field") { var initializer = element.initializer; descriptor = { enumerable: descriptor.enumerable, writable: descriptor.writable, configurable: descriptor.configurable, value: initializer === void 0 ? void 0 : initializer.call(receiver) }; } Object.defineProperty(receiver, element.key, descriptor); }, decorateClass: function (elements, decorators) { var newElements = []; var finishers = []; var placements = { static: [], prototype: [], own: [] }; elements.forEach(function (element) { this.addElementPlacement(element, placements); }, this); elements.forEach(function (element) { if (!_hasDecorators(element)) return newElements.push(element); var elementFinishersExtras = this.decorateElement(element, placements); newElements.push(elementFinishersExtras.element); newElements.push.apply(newElements, elementFinishersExtras.extras); finishers.push.apply(finishers, elementFinishersExtras.finishers); }, this); if (!decorators) { return { elements: newElements, finishers: finishers }; } var result = this.decorateConstructor(newElements, decorators); finishers.push.apply(finishers, result.finishers); result.finishers = finishers; return result; }, addElementPlacement: function (element, placements, silent) { var keys = placements[element.placement]; if (!silent && keys.indexOf(element.key) !== -1) { throw new TypeError("Duplicated element (" + element.key + ")"); } keys.push(element.key); }, decorateElement: function (element, placements) { var extras = []; var finishers = []; for (var decorators = element.decorators, i = decorators.length - 1; i >= 0; i--) { var keys = placements[element.placement]; keys.splice(keys.indexOf(element.key), 1); var elementObject = this.fromElementDescriptor(element); var elementFinisherExtras = this.toElementFinisherExtras((0, decorators[i])(elementObject) || elementObject); element = elementFinisherExtras.element; this.addElementPlacement(element, placements); if (elementFinisherExtras.finisher) { finishers.push(elementFinisherExtras.finisher); } var newExtras = elementFinisherExtras.extras; if (newExtras) { for (var j = 0; j < newExtras.length; j++) { this.addElementPlacement(newExtras[j], placements); } extras.push.apply(extras, newExtras); } } return { element: element, finishers: finishers, extras: extras }; }, decorateConstructor: function (elements, decorators) { var finishers = []; for (var i = decorators.length - 1; i >= 0; i--) { var obj = this.fromClassDescriptor(elements); var elementsAndFinisher = this.toClassDescriptor((0, decorators[i])(obj) || obj); if (elementsAndFinisher.finisher !== undefined) { finishers.push(elementsAndFinisher.finisher); } if (elementsAndFinisher.elements !== undefined) { elements = elementsAndFinisher.elements; for (var j = 0; j < elements.length - 1; j++) { for (var k = j + 1; k < elements.length; k++) { if (elements[j].key === elements[k].key && elements[j].placement === elements[k].placement) { throw new TypeError("Duplicated element (" + elements[j].key + ")"); } } } } } return { elements: elements, finishers: finishers }; }, fromElementDescriptor: function (element) { var obj = { kind: element.kind, key: element.key, placement: element.placement, descriptor: element.descriptor }; var desc = { value: "Descriptor", configurable: true }; Object.defineProperty(obj, Symbol.toStringTag, desc); if (element.kind === "field") obj.initializer = element.initializer; return obj; }, toElementDescriptors: function (elementObjects) { if (elementObjects === undefined) return; return _toArray(elementObjects).map(function (elementObject) { var element = this.toElementDescriptor(elementObject); this.disallowProperty(elementObject, "finisher", "An element descriptor"); this.disallowProperty(elementObject, "extras", "An element descriptor"); return element; }, this); }, toElementDescriptor: function (elementObject) { var kind = String(elementObject.kind); if (kind !== "method" && kind !== "field") { throw new TypeError('An element descriptor\'s .kind property must be either "method" or' + ' "field", but a decorator created an element descriptor with' + ' .kind "' + kind + '"'); } var key = _toPropertyKey(elementObject.key); var placement = String(elementObject.placement); if (placement !== "static" && placement !== "prototype" && placement !== "own") { throw new TypeError('An element descriptor\'s .placement property must be one of "static",' + ' "prototype" or "own", but a decorator created an element descriptor' + ' with .placement "' + placement + '"'); } var descriptor = elementObject.descriptor; this.disallowProperty(elementObject, "elements", "An element descriptor"); var element = { kind: kind, key: key, placement: placement, descriptor: Object.assign({}, descriptor) }; if (kind !== "field") { this.disallowProperty(elementObject, "initializer", "A method descriptor"); } else { this.disallowProperty(descriptor, "get", "The property descriptor of a field descriptor"); this.disallowProperty(descriptor, "set", "The property descriptor of a field descriptor"); this.disallowProperty(descriptor, "value", "The property descriptor of a field descriptor"); element.initializer = elementObject.initializer; } return element; }, toElementFinisherExtras: function (elementObject) { var element = this.toElementDescriptor(elementObject); var finisher = _optionalCallableProperty(elementObject, "finisher"); var extras = this.toElementDescriptors(elementObject.extras); return { element: element, finisher: finisher, extras: extras }; }, fromClassDescriptor: function (elements) { var obj = { kind: "class", elements: elements.map(this.fromElementDescriptor, this) }; var desc = { value: "Descriptor", configurable: true }; Object.defineProperty(obj, Symbol.toStringTag, desc); return obj; }, toClassDescriptor: function (obj) { var kind = String(obj.kind); if (kind !== "class") { throw new TypeError('A class descriptor\'s .kind property must be "class", but a decorator' + ' created a class descriptor with .kind "' + kind + '"'); } this.disallowProperty(obj, "key", "A class descriptor"); this.disallowProperty(obj, "placement", "A class descriptor"); this.disallowProperty(obj, "descriptor", "A class descriptor"); this.disallowProperty(obj, "initializer", "A class descriptor"); this.disallowProperty(obj, "extras", "A class descriptor"); var finisher = _optionalCallableProperty(obj, "finisher"); var elements = this.toElementDescriptors(obj.elements); return { elements: elements, finisher: finisher }; }, runClassFinishers: function (constructor, finishers) { for (var i = 0; i < finishers.length; i++) { var newConstructor = (0, finishers[i])(constructor); if (newConstructor !== undefined) { if (typeof newConstructor !== "function") { throw new TypeError("Finishers must return a constructor."); } constructor = newConstructor; } } return constructor; }, disallowProperty: function (obj, name, objectType) { if (obj[name] !== undefined) { throw new TypeError(objectType + " can't have a ." + name + " property."); } } }; return api; } function _createElementDescriptor(def) { var key = _toPropertyKey(def.key); var descriptor; if (def.kind === "method") { descriptor = { value: def.value, writable: true, configurable: true, enumerable: false }; } else if (def.kind === "get") { descriptor = { get: def.value, configurable: true, enumerable: false }; } else if (def.kind === "set") { descriptor = { set: def.value, configurable: true, enumerable: false }; } else if (def.kind === "field") { descriptor = { configurable: true, writable: true, enumerable: true }; } var element = { kind: def.kind === "field" ? "field" : "method", key: key, placement: def.static ? "static" : def.kind === "field" ? "own" : "prototype", descriptor: descriptor }; if (def.decorators) element.decorators = def.decorators; if (def.kind === "field") element.initializer = def.value; return element; } function _coalesceGetterSetter(element, other) { if (element.descriptor.get !== undefined) { other.descriptor.get = element.descriptor.get; } else { other.descriptor.set = element.descriptor.set; } } function _coalesceClassElements(elements) { var newElements = []; var isSameElement = function isSameElement(other) { return other.kind === "method" && other.key === element.key && other.placement === element.placement; }; for (var i = 0; i < elements.length; i++) { var element = elements[i]; var other; if (element.kind === "method" && (other = newElements.find(isSameElement))) { if (_isDataDescriptor(element.descriptor) || _isDataDescriptor(other.descriptor)) { if (_hasDecorators(element) || _hasDecorators(other)) { throw new ReferenceError("Duplicated methods (" + element.key + ") can't be decorated."); } other.descriptor = element.descriptor; } else { if (_hasDecorators(element)) { if (_hasDecorators(other)) { throw new ReferenceError("Decorators can't be placed on different accessors with for " + "the same property (" + element.key + ")."); } other.decorators = element.decorators; } _coalesceGetterSetter(element, other); } } else { newElements.push(element); } } return newElements; } function _hasDecorators(element) { return element.decorators && element.decorators.length; } function _isDataDescriptor(desc) { return desc !== undefined && !(desc.value === undefined && desc.writable === undefined); } function _optionalCallableProperty(obj, name) { var value = obj[name]; if (value !== undefined && typeof value !== "function") { throw new TypeError("Expected '" + name + "' to be a function"); } return value; } function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); } function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } function _toArray(arr) { return _arrayWithHoles(arr) || _iterableToArray(arr) || _nonIterableRest(); } function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance"); } function _iterableToArray(iter) { if (Symbol.iterator in Object(iter) || Object.prototype.toString.call(iter) === "[object Arguments]") return Array.from(iter); } function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } function _get(target, property, receiver) { if (typeof Reflect !== "undefined" && Reflect.get) { _get = Reflect.get; } else { _get = function _get(target, property, receiver) { var base = _superPropBase(target, property); if (!base) return; var desc = Object.getOwnPropertyDescriptor(base, property); if (desc.get) { return desc.get.call(receiver); } return desc.value; }; } return _get(target, property, receiver || target); } function _superPropBase(object, property) { while (!Object.prototype.hasOwnProperty.call(object, property)) { object = _getPrototypeOf(object); if (object === null) break; } return object; } function _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); } /** * @license * * Copyright IBM Corp. 2019, 2020 * * This source code is licensed under the Apache-2.0 license found in the * LICENSE file in the root directory of this source tree. */ import { classMap } from 'lit-html/directives/class-map'; import { html, property, query, customElement } from 'lit-element'; import ChevronDown16 from "../../icons/chevron--down/16"; import settings from 'carbon-components/es/globals/js/settings'; import HostListenerMixin from '../../globals/mixins/host-listener'; import HostListener from '../../globals/decorators/host-listener'; import { find, forEach } from '../../globals/internal/collection-helpers'; import BXContentSwitcher, { NAVIGATION_DIRECTION } from '../content-switcher/content-switcher'; import styles from "./tabs.css.js"; const { prefix } = settings; export { NAVIGATION_DIRECTION }; /** * Navigation direction for narrow mode, associated with key symbols. */ export const NAVIGATION_DIRECTION_NARROW = { Up: -1, ArrowUp: -1, Down: 1, ArrowDown: 1 }; /** * The keyboard action categories for dropdown. */ export let TABS_KEYBOARD_ACTION; /** * Tabs types. */ (function (TABS_KEYBOARD_ACTION) { TABS_KEYBOARD_ACTION["NONE"] = "none"; TABS_KEYBOARD_ACTION["CLOSING"] = "closing"; TABS_KEYBOARD_ACTION["NAVIGATING"] = "navigating"; TABS_KEYBOARD_ACTION["TRIGGERING"] = "triggering"; })(TABS_KEYBOARD_ACTION || (TABS_KEYBOARD_ACTION = {})); export let TABS_TYPE; /** * Tabs. * @element bx-tabs * @fires bx-tabs-beingselected * The custom event fired before a tab is selected upon a user gesture. * Cancellation of this event stops changing the user-initiated selection. * @fires bx-tabs-selected - The custom event fired after a a tab is selected upon a user gesture. */ (function (TABS_TYPE) { TABS_TYPE["REGULAR"] = ""; TABS_TYPE["CONTAINER"] = "container"; })(TABS_TYPE || (TABS_TYPE = {})); let BXTabs = _decorate([customElement(`${prefix}-tabs`)], function (_initialize, _HostListenerMixin) { class BXTabs extends _HostListenerMixin { constructor(...args) { super(...args); _initialize(this); } } return { F: BXTabs, d: [{ kind: "field", key: "_open", value() { return false; } }, { kind: "field", key: "_selectedItemContent", value() { return null; } }, { kind: "field", decorators: [query('#trigger')], key: "_triggerNode", value: void 0 }, { kind: "method", decorators: [HostListener('focusin')], key: "_handleFocusIn", value: /** * The latest status of this dropdown, for screen reader to accounce. */ /** * `true` if the narrow mode dropdown should be open. */ /** * The content of the selected item, used in the narrow mode. */ /** * The DOM element for the trigger button in narrow mode. */ /** * Handles `focus` event handler on this element. */ function _handleFocusIn() { const { selectorItem } = this.constructor; forEach(this.querySelectorAll(selectorItem), item => { item.inFocus = true; }); } /** * Handles `blur` event handler on this element. * @param event The event. */ }, { kind: "method", decorators: [HostListener('focusout')], key: "_handleFocusOut", value: function _handleFocusOut({ relatedTarget }) { if (!this.contains(relatedTarget)) { const { selectorItem } = this.constructor; forEach(this.querySelectorAll(selectorItem), item => { item.inFocus = false; }); this._handleUserInitiatedToggle(false); } } /** * Handles user-initiated toggling the open state. * @param [force] If specified, forces the open state to the given one. */ }, { kind: "method", key: "_handleUserInitiatedToggle", value: function _handleUserInitiatedToggle(force = !this._open) { this._open = force; if (this._open) { this._assistiveStatusText = this.selectingItemsAssistiveText; } else { const { selectedItemAssistiveText, triggerContent, _assistiveStatusText: assistiveStatusText, _selectedItemContent: selectedItemContent } = this; const selectedItemText = selectedItemContent && selectedItemContent.textContent || triggerContent; if (selectedItemText && assistiveStatusText !== selectedItemAssistiveText) { this._assistiveStatusText = selectedItemText; } } this.requestUpdate(); } /** * Clears the selection of tabs. */ }, { kind: "method", key: "_clearHighlight", value: function _clearHighlight() { forEach(this.querySelectorAll(this.constructor.selectorItem), item => { item.highlighted = false; }); } /** * Navigates through tabs. * @param direction `-1` to navigate backward, `1` to navigate forward. * @param [options] The options. * @param [options.immediate] * `true` to make it "immediate selection change" mode, which does: * * * Starts with the selected item * * Going prev/next item immediately changes the selection */ }, { kind: "method", key: "_navigate", value: function _navigate(direction, { immediate } = {}) { const { selectorItem, selectorItemHighlighted, selectorItemSelected } = this.constructor; const nextItem = this._getNextItem(this.querySelector(immediate ? selectorItemSelected : selectorItemHighlighted), direction); if (!nextItem) { return; } if (immediate) { this._handleUserInitiatedSelectItem(nextItem); } else { forEach(this.querySelectorAll(selectorItem), item => { item[immediate ? 'selected' : 'highlighted'] = nextItem === item; }); } // Using `{ block: 'nearest' }` to prevent scrolling unless scrolling is absolutely necessary. // `scrollIntoViewOptions` seems to work in latest Safari despite of MDN/caniuse table. // IE falls back to the old behavior. nextItem.scrollIntoView({ block: 'nearest' }); const nextItemText = nextItem.textContent; if (nextItemText) { this._assistiveStatusText = nextItemText; } this.requestUpdate(); } }, { kind: "method", decorators: [HostListener('click')], key: "_handleClick", value: function _handleClick(event) { const { target } = event; if (this === target) { this._handleUserInitiatedToggle(); } else if (target.value === this.value) { // Clicking on selected item, simply closes the narrow mode dropdown this._handleUserInitiatedToggle(false); } else { // Trying to select the item // If the custom event of the selection is canceled, we don't close the narrow mode dropdown _get(_getPrototypeOf(BXTabs.prototype), "_handleClick", this).call(this, event); } } }, { kind: "method", decorators: [HostListener('keydown')], key: "_handleKeydown", value: function _handleKeydown({ key }) { const { _open: open, _triggerNode: triggerNode } = this; const narrowMode = Boolean(triggerNode.offsetParent); const action = this.constructor.getAction(key, { narrowMode }); if (!open && narrowMode) { // Menu closed in narrow mode switch (action) { case TABS_KEYBOARD_ACTION.NAVIGATING: this._handleUserInitiatedToggle(true); // If this menu gets open with an arrow key, resets the highlight this._clearHighlight(); break; case TABS_KEYBOARD_ACTION.TRIGGERING: this._handleUserInitiatedToggle(true); break; default: break; } } else { switch (action) { case TABS_KEYBOARD_ACTION.CLOSING: this._handleUserInitiatedToggle(false); break; case TABS_KEYBOARD_ACTION.NAVIGATING: { const direction = narrowMode ? NAVIGATION_DIRECTION_NARROW[key] : NAVIGATION_DIRECTION[key]; if (direction) { this._navigate(direction, { immediate: !narrowMode }); } } break; case TABS_KEYBOARD_ACTION.TRIGGERING: { const { selectorItemHighlighted } = this.constructor; const highlightedItem = this.querySelector(selectorItemHighlighted); if (highlightedItem) { if (highlightedItem.value === this.value) { // Selecting an already-selected item, simply closes the narrow mode dropdown this._handleUserInitiatedToggle(false); } else { // Trying to select the item // If the custom event of the selection is canceled, we don't close the narrow mode dropdown this._handleUserInitiatedSelectItem(highlightedItem); } } else { this._handleUserInitiatedToggle(); } } break; default: break; } } } }, { kind: "method", key: "_selectionDidChange", value: function _selectionDidChange(itemToSelect) { _get(_getPrototypeOf(BXTabs.prototype), "_selectionDidChange", this).call(this, itemToSelect); this._assistiveStatusText = this.selectedItemAssistiveText; this._handleUserInitiatedToggle(false); } /** * An assistive text for screen reader to announce, telling the open state. */ }, { kind: "field", decorators: [property({ attribute: 'selecting-items-assistive-text' })], key: "selectingItemsAssistiveText", value() { return 'Selecting items. Use up and down arrow keys to navigate.'; } }, { kind: "field", decorators: [property({ attribute: 'selected-item-assistive-text' })], key: "selectedItemAssistiveText", value() { return 'Selected an item.'; } }, { kind: "field", decorators: [property({ attribute: 'trigger-content' })], key: "triggerContent", value() { return ''; } }, { kind: "field", decorators: [property({ reflect: true })], key: "type", value() { return TABS_TYPE.REGULAR; } }, { kind: "method", key: "connectedCallback", value: /** * An assistive text for screen reader to announce, telling that an item is selected. */ /** * The content of the trigger button for narrow mode. */ /** * Tabs type. */ function connectedCallback() { if (!this.hasAttribute('tabindex')) { this.tabIndex = 0; } _get(_getPrototypeOf(BXTabs.prototype), "connectedCallback", this).call(this); } }, { kind: "method", key: "shouldUpdate", value: function shouldUpdate(changedProperties) { _get(_getPrototypeOf(BXTabs.prototype), "shouldUpdate", this).call(this, changedProperties); const { selectorItem } = this.constructor; if (changedProperties.has('type')) { forEach(this.querySelectorAll(selectorItem), elem => { elem.type = this.type; }); } if (changedProperties.has('value')) { const item = find(this.querySelectorAll(selectorItem), elem => elem.value === this.value); if (item) { const range = this.ownerDocument.createRange(); range.selectNodeContents(item); this._selectedItemContent = range.cloneContents(); } else { this._selectedItemContent = null; } } return true; } }, { kind: "method", key: "render", value: function render() { const { triggerContent, _assistiveStatusText: assistiveStatusText, _open: open, _selectedItemContent: selectedItemContent } = this; const triggerClasses = classMap({ [`${prefix}--tabs-trigger`]: true, [`${prefix}--tabs-trigger--open`]: open }); const listClasses = classMap({ [`${prefix}--tabs__nav`]: true, [`${prefix}--tabs__nav--hidden`]: !open }); return html(_t || (_t = _` <div id="trigger" role="button" class="${0}" aria-labelledby="trigger-label" aria-expanded="${0}" aria-haspopup="listbox" aria-owns="tablist" aria-controls="tablist" > <span id="trigger-label" class="${0}--tabs-trigger-text"> ${0} </span> ${0} </div> <ul id="tablist" role="tablist" class="${0}"> <slot></slot> </ul> <div class="${0}--assistive-text" role="status" aria-live="assertive" aria-relevant="additions text"> ${0} </div> `), triggerClasses, String(open), prefix, selectedItemContent || triggerContent, ChevronDown16({ 'aria-hidden': 'true' }), listClasses, prefix, assistiveStatusText); } /** * Symbols of keys that triggers opening/closing menu and selecting/deselecting menu item. */ }, { kind: "field", static: true, key: "TRIGGER_KEYS", value() { return new Set([' ', 'Enter']); } }, { kind: "get", static: true, key: "selectorItem", value: /** * A selector that will return tabs. */ function selectorItem() { return `${prefix}-tab`; } /** * A selector that will return enabled tabs. */ }, { kind: "get", static: true, key: "selectorItemEnabled", value: function selectorItemEnabled() { return `${prefix}-tab:not([disabled])`; } /** * A selector that will return highlighted tabs. */ }, { kind: "get", static: true, key: "selectorItemHighlighted", value: function selectorItemHighlighted() { return `${prefix}-tab[highlighted]`; } /** * A selector that will return selected tabs. */ }, { kind: "get", static: true, key: "selectorItemSelected", value: function selectorItemSelected() { return `${prefix}-tab[selected]`; } /** * The name of the custom event fired before a tab is selected upon a user gesture. * Cancellation of this event stops changing the user-initiated selection. */ }, { kind: "get", static: true, key: "eventBeforeSelect", value: function eventBeforeSelect() { return `${prefix}-tabs-beingselected`; } /** * The name of the custom event fired after a a tab is selected upon a user gesture. */ }, { kind: "get", static: true, key: "eventSelect", value: function eventSelect() { return `${prefix}-tabs-selected`; } }, { kind: "field", static: true, key: "styles", value() { return styles; } }, { kind: "method", static: true, key: "getAction", value: /** * @param key The key symbol. * @param [options] The options. * @param [options.narrowMode] `true` to get the action for narrow mode. * @returns A action for dropdown for the given key symbol. */ function getAction(key, { narrowMode }) { if (key === 'Escape') { return TABS_KEYBOARD_ACTION.CLOSING; } if (key in (narrowMode ? NAVIGATION_DIRECTION_NARROW : NAVIGATION_DIRECTION)) { return TABS_KEYBOARD_ACTION.NAVIGATING; } if (narrowMode && this.TRIGGER_KEYS.has(key)) { return TABS_KEYBOARD_ACTION.TRIGGERING; } return TABS_KEYBOARD_ACTION.NONE; } }] }; }, HostListenerMixin(BXContentSwitcher)); export default BXTabs; //# sourceMappingURL=tabs.js.map