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.
440 lines (370 loc) • 25.3 kB
JavaScript
let _ = t => t,
_t;
function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
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 settings from 'carbon-components/es/globals/js/settings';
import findLast from 'lodash-es/findLast';
import { classMap } from 'lit-html/directives/class-map';
import { html, property, query, customElement, LitElement } from 'lit-element';
import HostListener from '../../globals/decorators/host-listener';
import HostListenerMixin from '../../globals/mixins/host-listener';
import styles from "./modal.css.js";
import { selectorTabbable as _selectorTabbable } from '../../globals/settings';
import { find } from '../../globals/internal/collection-helpers';
const {
prefix
} = settings; // eslint-disable-next-line no-bitwise
const PRECEDING = Node.DOCUMENT_POSITION_PRECEDING | Node.DOCUMENT_POSITION_CONTAINS; // eslint-disable-next-line no-bitwise
const FOLLOWING = Node.DOCUMENT_POSITION_FOLLOWING | Node.DOCUMENT_POSITION_CONTAINED_BY;
/**
* Modal size.
*/
export let MODAL_SIZE;
/**
* Modal.
* @element bx-modal
* @fires bx-modal-beingclosed
* The custom event fired before this modal is being closed upon a user gesture.
* Cancellation of this event stops the user-initiated action of closing this modal.
* @fires bx-modal-closed - The custom event fired after this modal is closed upon a user gesture.
*/
(function (MODAL_SIZE) {
MODAL_SIZE["EXTRA_SMALL"] = "xs";
MODAL_SIZE["SMALL"] = "sm";
MODAL_SIZE["REGULAR"] = "";
MODAL_SIZE["LARGE"] = "lg";
})(MODAL_SIZE || (MODAL_SIZE = {}));
let BXModal = _decorate([customElement(`${prefix}-modal`)], function (_initialize, _HostListenerMixin) {
class BXModal extends _HostListenerMixin {
constructor(...args) {
super(...args);
_initialize(this);
}
}
return {
F: BXModal,
d: [{
kind: "field",
key: "_launcher",
value() {
return null;
}
}, {
kind: "field",
decorators: [query('#start-sentinel')],
key: "_startSentinelNode",
value: void 0
}, {
kind: "field",
decorators: [query('#end-sentinel')],
key: "_endSentinelNode",
value: void 0
}, {
kind: "field",
decorators: [HostListener('click')],
key: "_handleClick",
value() {
return event => {
if (event.composedPath().indexOf(this.shadowRoot) < 0) {
this._handleUserInitiatedClose(event.target);
}
};
}
}, {
kind: "field",
decorators: [HostListener('shadowRoot:focusout')],
key: "_handleBlur",
value() {
return ({
target,
relatedTarget
}) => {
const oldContains = target !== this && this.contains(target);
const currentContains = relatedTarget !== this && this.contains(relatedTarget); // Performs focus wrapping if _all_ of the following is met:
// * This modal is open
// * The viewport still has focus
// * Modal body used to have focus but no longer has focus
const {
open,
_startSentinelNode: startSentinelNode,
_endSentinelNode: endSentinelNode
} = this;
const {
selectorTabbable: selectorTabbableForModal
} = this.constructor;
if (open && relatedTarget && oldContains && !currentContains) {
const comparisonResult = target.compareDocumentPosition(relatedTarget); // eslint-disable-next-line no-bitwise
if (relatedTarget === startSentinelNode || comparisonResult & PRECEDING) {
const tabbable = findLast(this.querySelectorAll(selectorTabbableForModal), elem => Boolean(elem.offsetParent));
if (tabbable) {
tabbable.focus();
} else if (relatedTarget !== this) {
this.focus();
}
} // eslint-disable-next-line no-bitwise
else if (relatedTarget === endSentinelNode || comparisonResult & FOLLOWING) {
const tabbable = find(this.querySelectorAll(selectorTabbableForModal), elem => Boolean(elem.offsetParent));
if (tabbable) {
tabbable.focus();
} else {
this.focus();
}
}
}
};
}
}, {
kind: "field",
decorators: [HostListener('document:keydown')],
key: "_handleKeydown",
value() {
return ({
key,
target
}) => {
if (key === 'Esc' || key === 'Escape') {
this._handleUserInitiatedClose(target);
}
};
}
}, {
kind: "method",
key: "_handleClickContainer",
value:
/**
* The element that had focus before this modal gets open.
*/
/**
* Node to track focus going outside of modal content.
*/
/**
* Node to track focus going outside of modal content.
*/
/**
* Handles `click` event on this element.
* @param event The event.
*/
/**
* Handles `blur` event on this element.
* @param event The event.
*/
/**
* Handles `click` event on the modal container.
* @param event The event.
*/
function _handleClickContainer(event) {
if (event.target.matches(this.constructor.selectorCloseButton)) {
this._handleUserInitiatedClose(event.target);
}
}
/**
* Handles user-initiated close request of this modal.
* @param triggeredBy The element that triggered this close request.
*/
}, {
kind: "method",
key: "_handleUserInitiatedClose",
value: function _handleUserInitiatedClose(triggeredBy) {
if (this.open) {
const init = {
bubbles: true,
cancelable: true,
composed: true,
detail: {
triggeredBy
}
};
if (this.dispatchEvent(new CustomEvent(this.constructor.eventBeforeClose, init))) {
this.open = false;
this.dispatchEvent(new CustomEvent(this.constructor.eventClose, init));
}
}
}
/**
* The additional CSS class names for the container <div> of the element.
*/
}, {
kind: "field",
decorators: [property({
attribute: 'container-class'
})],
key: "containerClass",
value() {
return '';
}
}, {
kind: "field",
decorators: [property({
type: Boolean,
reflect: true
})],
key: "open",
value() {
return false;
}
}, {
kind: "field",
decorators: [property({
reflect: true
})],
key: "size",
value() {
return MODAL_SIZE.REGULAR;
}
}, {
kind: "method",
key: "render",
value:
/**
* `true` if the modal should be open.
*/
/**
* Modal size.
*/
function render() {
const {
size
} = this;
const containerClass = this.containerClass.split(' ').filter(Boolean).reduce((acc, item) => _objectSpread({}, acc, {
[item]: true
}), {});
const containerClasses = classMap(_objectSpread({
[`${prefix}--modal-container`]: true,
[`${prefix}--modal-container--${size}`]: size
}, containerClass));
return html(_t || (_t = _`
<a id="start-sentinel" class="${0}--visually-hidden" href="javascript:void 0" role="navigation"></a>
<div class=${0} role="dialog" tabidnex="-1" =${0}>
<slot></slot>
</div>
<a id="end-sentinel" class="${0}--visually-hidden" href="javascript:void 0" role="navigation"></a>
`), prefix, containerClasses, this._handleClickContainer, prefix);
}
}, {
kind: "method",
key: "connectedCallback",
value: function connectedCallback() {
if (!this.hasAttribute('tabindex')) {
this.setAttribute('tabindex', '0');
}
_get(_getPrototypeOf(BXModal.prototype), "connectedCallback", this).call(this);
}
}, {
kind: "method",
key: "updated",
value: async function updated(changedProperties) {
if (changedProperties.has('open')) {
if (this.open) {
this._launcher = this.ownerDocument.activeElement;
const primaryFocusNode = this.querySelector(this.constructor.selectorPrimaryFocus);
if (primaryFocusNode) {
// For cases where a `carbon-custom-elements` component (e.g. `<bx-btn>`) being `primaryFocusNode`,
// where its first update/render cycle that makes it focusable happens after `<bx-modal>`'s first update/render cycle
await 0;
primaryFocusNode.focus();
} else {
const tabbable = find(this.querySelectorAll(this.constructor.selectorTabbable), elem => Boolean(elem.offsetParent));
if (tabbable) {
// For cases where a `carbon-custom-elements` component (e.g. `<bx-btn>`) being `tabbable`,
// where its first update/render cycle that makes it focusable happens after `<bx-modal>`'s first update/render cycle
await 0;
tabbable.focus();
} else {
this.focus();
}
}
} else if (this._launcher && typeof this._launcher.focus === 'function') {
this._launcher.focus();
this._launcher = null;
}
}
}
/**
* A selector selecting buttons that should close this modal.
*/
}, {
kind: "get",
static: true,
key: "selectorCloseButton",
value: function selectorCloseButton() {
return `[data-modal-close],${prefix}-modal-close-button`;
}
/**
* A selector selecting tabbable nodes.
*/
}, {
kind: "get",
static: true,
key: "selectorTabbable",
value: function selectorTabbable() {
return _selectorTabbable;
}
/**
* A selector selecting the nodes that should be focused when modal gets open.
*/
}, {
kind: "get",
static: true,
key: "selectorPrimaryFocus",
value: function selectorPrimaryFocus() {
return `[data-modal-primary-focus],${prefix}-modal-footer ${prefix}-btn[kind="primary"]`;
}
/**
* The name of the custom event fired before this modal is being closed upon a user gesture.
* Cancellation of this event stops the user-initiated action of closing this modal.
*/
}, {
kind: "get",
static: true,
key: "eventBeforeClose",
value: function eventBeforeClose() {
return `${prefix}-modal-beingclosed`;
}
/**
* The name of the custom event fired after this modal is closed upon a user gesture.
*/
}, {
kind: "get",
static: true,
key: "eventClose",
value: function eventClose() {
return `${prefix}-modal-closed`;
}
}, {
kind: "field",
static: true,
key: "styles",
value() {
return styles;
}
}]
};
}, HostListenerMixin(LitElement));
export default BXModal;
//# sourceMappingURL=modal.js.map