UNPKG

@ionic/core

Version:
387 lines (383 loc) • 13.2 kB
/*! * (C) Ionic http://ionicframework.com - MIT License */ import { c as printIonError } from './index-BpRUsN_W.js'; import { i as isRTL } from './dir-Dojwmvde.js'; const win = typeof window !== 'undefined' ? window : undefined; const doc = typeof document !== 'undefined' ? document : undefined; const transitionEndAsync = (el, expectedDuration = 0) => { return new Promise((resolve) => { transitionEnd(el, expectedDuration, resolve); }); }; /** * Allows developer to wait for a transition * to finish and fallback to a timer if the * transition is cancelled or otherwise * never finishes. Also see transitionEndAsync * which is an await-able version of this. */ const transitionEnd = (el, expectedDuration = 0, callback) => { let unRegTrans; let animationTimeout; const opts = { passive: true }; const ANIMATION_FALLBACK_TIMEOUT = 500; const unregister = () => { if (unRegTrans) { unRegTrans(); } }; const onTransitionEnd = (ev) => { if (ev === undefined || el === ev.target) { unregister(); callback(ev); } }; if (el) { el.addEventListener('webkitTransitionEnd', onTransitionEnd, opts); el.addEventListener('transitionend', onTransitionEnd, opts); animationTimeout = setTimeout(onTransitionEnd, expectedDuration + ANIMATION_FALLBACK_TIMEOUT); unRegTrans = () => { if (animationTimeout !== undefined) { clearTimeout(animationTimeout); animationTimeout = undefined; } el.removeEventListener('webkitTransitionEnd', onTransitionEnd, opts); el.removeEventListener('transitionend', onTransitionEnd, opts); }; } return unregister; }; /** * Waits for a component to be ready for * both custom element and non-custom element builds. * If non-custom element build, el.componentOnReady * will be used. * For custom element builds, we wait a frame * so that the inner contents of the component * have a chance to render. * * Use this utility rather than calling * el.componentOnReady yourself. */ const componentOnReady = (el, callback) => { if (el.componentOnReady) { // eslint-disable-next-line custom-rules/no-component-on-ready-method el.componentOnReady().then((resolvedEl) => callback(resolvedEl)); } else { raf(() => callback(el)); } }; /** * This functions checks if a Stencil component is using * the lazy loaded build of Stencil. Returns `true` if * the component is lazy loaded. Returns `false` otherwise. */ const hasLazyBuild = (stencilEl) => { return stencilEl.componentOnReady !== undefined; }; /** * Elements inside of web components sometimes need to inherit global attributes * set on the host. For example, the inner input in `ion-input` should inherit * the `title` attribute that developers set directly on `ion-input`. This * helper function should be called in componentWillLoad and assigned to a variable * that is later used in the render function. * * This copies once. Use `createAttributeController` instead when the attributes can * change after load, since a host attribute change does not trigger a re-render. */ const inheritAttributes = (el, attributes = []) => { const attributeObject = {}; attributes.forEach((attr) => { if (el.hasAttribute(attr)) { const value = el.getAttribute(attr); if (value !== null) { attributeObject[attr] = el.getAttribute(attr); } el.removeAttribute(attr); } }); return attributeObject; }; /** * List of available ARIA attributes + `role`. * Removed deprecated attributes. * https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Attributes * * @internal Exported for `attribute-controller.ts`, which needs the same set. */ const ariaAttributes = [ 'role', 'aria-activedescendant', 'aria-atomic', 'aria-autocomplete', 'aria-braillelabel', 'aria-brailleroledescription', 'aria-busy', 'aria-checked', 'aria-colcount', 'aria-colindex', 'aria-colindextext', 'aria-colspan', 'aria-controls', 'aria-current', 'aria-describedby', 'aria-description', 'aria-details', 'aria-disabled', 'aria-errormessage', 'aria-expanded', 'aria-flowto', 'aria-haspopup', 'aria-hidden', 'aria-invalid', 'aria-keyshortcuts', 'aria-label', 'aria-labelledby', 'aria-level', 'aria-live', 'aria-multiline', 'aria-multiselectable', 'aria-orientation', 'aria-owns', 'aria-placeholder', 'aria-posinset', 'aria-pressed', 'aria-readonly', 'aria-relevant', 'aria-required', 'aria-roledescription', 'aria-rowcount', 'aria-rowindex', 'aria-rowindextext', 'aria-rowspan', 'aria-selected', 'aria-setsize', 'aria-sort', 'aria-valuemax', 'aria-valuemin', 'aria-valuenow', 'aria-valuetext', ]; /** * Returns an array of aria attributes that should be copied from * the shadow host element to a target within the light DOM. * @param el The element that the attributes should be copied from. * @param ignoreList The list of aria-attributes to ignore reflecting and removing from the host. * Use this in instances where we manually specify aria attributes on the `<Host>` element. */ const inheritAriaAttributes = (el, ignoreList) => { let attributesToInherit = ariaAttributes; return inheritAttributes(el, attributesToInherit); }; const addEventListener = (el, eventName, callback, opts) => { return el.addEventListener(eventName, callback, opts); }; const removeEventListener = (el, eventName, callback, opts) => { return el.removeEventListener(eventName, callback, opts); }; /** * Calls back when a CSS custom property that resolves to a length changes, * which no event covers. The probe inherits the property from `hostEl` and * uses it as its height, turning a property change into a size change that * `ResizeObserver` can detect. * * The callback receives the probe's height. For length values, this matches * the resolved property value. For other values, such as `fit-content`, the * probe remains at zero, so the value only signals that the property changed. * Percentages resolve against the probe's containing block, not the element * where the property is ultimately used. * * Pass `initialValue` when the caller has already read the property so that * changes occurring before the observer's first delivery are not missed. * Without it, the first delivery establishes the baseline. */ const onCustomPropertyChange = (hostEl, property, callback, initialValue) => { const doc = win?.document; if (!doc || !hostEl || typeof ResizeObserver === 'undefined') { return () => undefined; } const probe = doc.createElement('div'); probe.style.cssText = `position:fixed;visibility:hidden;pointer-events:none;top:0;left:0;width:0;height:var(${property},0px);`; hostEl.appendChild(probe); let lastHeight = initialValue; const observer = new ResizeObserver((entries) => { const { height } = entries[0].contentRect; if (lastHeight !== undefined && height !== lastHeight) { callback(height); } lastHeight = height; }); observer.observe(probe); return () => { observer.disconnect(); probe.remove(); }; }; /** * Gets the root context of a shadow dom element * On newer browsers this will be the shadowRoot, * but for older browser this may just be the * element itself. * * Useful for whenever you need to explicitly * do "myElement.shadowRoot!.querySelector(...)". */ const getElementRoot = (el, fallback = el) => { return el.shadowRoot || fallback; }; /** * Patched version of requestAnimationFrame that avoids ngzone * Use only when you know ngzone should not run */ const raf = (h) => { if (typeof __zone_symbol__requestAnimationFrame === 'function') { return __zone_symbol__requestAnimationFrame(h); } if (typeof requestAnimationFrame === 'function') { return requestAnimationFrame(h); } return setTimeout(h); }; const hasShadowDom = (el) => { return !!el.shadowRoot && !!el.attachShadow; }; const focusVisibleElement = (el) => { el.focus(); /** * When programmatically focusing an element, * the focus-visible utility will not run because * it is expecting a keyboard event to have triggered this; * however, there are times when we need to manually control * this behavior so we call the `setFocus` method on ion-app * which will let us explicitly set the elements to focus. */ if (el.classList.contains('ion-focusable')) { const app = el.closest('ion-app'); if (app) { app.setFocus([el]); } } }; /** * This method is used to add a hidden input to a host element that contains * a Shadow DOM. It does not add the input inside of the Shadow root which * allows it to be picked up inside of forms. It should contain the same * values as the host element. * * @param always Add a hidden input even if the container does not use Shadow * @param container The element where the input will be added * @param name The name of the input * @param value The value of the input * @param disabled If true, the input is disabled */ const renderHiddenInput = (always, container, name, value, disabled) => { { let input = container.querySelector('input.aux-input'); if (!input) { input = container.ownerDocument.createElement('input'); input.type = 'hidden'; input.classList.add('aux-input'); container.appendChild(input); } input.disabled = disabled; input.name = name; input.value = value || ''; } }; const clamp = (min, n, max) => { return Math.max(min, Math.min(n, max)); }; const assert = (actual, reason) => { if (!actual) { const message = 'ASSERT: ' + reason; printIonError(message); debugger; // eslint-disable-line throw new Error(message); } }; const pointerCoord = (ev) => { // get X coordinates for either a mouse click // or a touch depending on the given event if (ev) { const changedTouches = ev.changedTouches; if (changedTouches && changedTouches.length > 0) { const touch = changedTouches[0]; return { x: touch.clientX, y: touch.clientY }; } if (ev.pageX !== undefined) { return { x: ev.pageX, y: ev.pageY }; } } return { x: 0, y: 0 }; }; /** * @hidden * Given a side, returns whether it resolves to the end side for the current * direction. In RTL `start` is the end side, and in LTR `end` is. * * @param side The current side before being redefined based on the direction. * @param hostEl The component's host element. The direction is resolved from * it or its nearest ancestor that declares one. When omitted, the direction * is resolved from the document. */ const isEndSide = (side, hostEl) => { const rtl = isRTL(hostEl); switch (side) { case 'start': return rtl; case 'end': return !rtl; default: throw new Error(`"${side}" is not a valid value for [side]. Use "start" or "end" instead.`); } }; const debounceEvent = (event, wait) => { const original = event._original || event; return { _original: event, emit: debounce(original.emit.bind(original), wait), }; }; const debounce = (func, wait = 0) => { let timer; return (...args) => { clearTimeout(timer); timer = setTimeout(func, wait, ...args); }; }; /** * Check whether the two string maps are shallow equal. * * undefined is treated as an empty map. * * @returns whether the keys are the same and the values are shallow equal. */ const shallowEqualStringMap = (map1, map2) => { map1 ??= {}; map2 ??= {}; if (map1 === map2) { return true; } const keys1 = Object.keys(map1); if (keys1.length !== Object.keys(map2).length) { return false; } for (const k1 of keys1) { if (!(k1 in map2)) { return false; } if (map1[k1] !== map2[k1]) { return false; } } return true; }; /** * Checks input for usable number. Not NaN and not Infinite. */ const isSafeNumber = (input) => { return typeof input === 'number' && !isNaN(input) && isFinite(input); }; export { renderHiddenInput as a, inheritAttributes as b, componentOnReady as c, debounceEvent as d, clamp as e, addEventListener as f, getElementRoot as g, hasLazyBuild as h, inheritAriaAttributes as i, isSafeNumber as j, hasShadowDom as k, assert as l, removeEventListener as m, doc as n, onCustomPropertyChange as o, focusVisibleElement as p, ariaAttributes as q, raf as r, isEndSide as s, transitionEndAsync as t, debounce as u, shallowEqualStringMap as v, win as w, pointerCoord as x };