@thednp/shorty 2.0.0-alpha1 → 2.0.0-alpha11

package/dist/shorty.d.ts

@@ -0,0 +1,1502 @@
+/**
+ * A global namespace for aria-checked.
+ */
+export declare const ariaChecked = "aria-checked";
+/**
+ * A global namespace for aria-description.
+ */
+export declare const ariaDescription = "aria-description";
+/**
+ * A global namespace for aria-describedby.
+ */
+export declare const ariaDescribedBy = "aria-describedby";
+/**
+ * A global namespace for aria-expanded.
+ */
+export declare const ariaExpanded = "aria-expanded";
+/**
+ * A global namespace for aria-haspopup.
+ */
+export declare const ariaHasPopup = "aria-haspopup";
+/**
+ * A global namespace for aria-hidden.
+ */
+export declare const ariaHidden = "aria-hidden";
+/**
+ * A global namespace for aria-label.
+ */
+export declare const ariaLabel = "aria-label";
+/**
+ * A global namespace for aria-labelledby.
+ */
+export declare const ariaLabelledBy = "aria-labelledby";
+/**
+ * A global namespace for aria-modal.
+ */
+export declare const ariaModal = "aria-modal";
+/**
+ * A global namespace for aria-pressed.
+ */
+export declare const ariaPressed = "aria-pressed";
+/**
+ * A global namespace for aria-selected.
+ */
+export declare const ariaSelected = "aria-selected";
+/**
+ * A global namespace for aria-valuemin.
+ */
+export declare const ariaValueMin = "aria-valuemin";
+/**
+ * A global namespace for aria-valuemax.
+ */
+export declare const ariaValueMax = "aria-valuemax";
+/**
+ * A global namespace for aria-valuenow.
+ */
+export declare const ariaValueNow = "aria-valuenow";
+/**
+ * A global namespace for aria-valuetext.
+ */
+export declare const ariaValueText = "aria-valuetext";
+/**
+ * A global namespace for all browser native events.
+ */
+export declare const nativeEvents: {
+	DOMContentLoaded: string;
+	DOMMouseScroll: string;
+	abort: string;
+	beforeunload: string;
+	blur: string;
+	change: string;
+	click: string;
+	contextmenu: string;
+	dblclick: string;
+	error: string;
+	focus: string;
+	focusin: string;
+	focusout: string;
+	gesturechange: string;
+	gestureend: string;
+	gesturestart: string;
+	hover: string;
+	keydown: string;
+	keypress: string;
+	keyup: string;
+	load: string;
+	mousedown: string;
+	mousemove: string;
+	mousein: string;
+	mouseout: string;
+	mouseenter: string;
+	mouseleave: string;
+	mouseover: string;
+	mouseup: string;
+	mousewheel: string;
+	move: string;
+	orientationchange: string;
+	pointercancel: string;
+	pointerdown: string;
+	pointerleave: string;
+	pointermove: string;
+	pointerup: string;
+	readystatechange: string;
+	reset: string;
+	resize: string;
+	scroll: string;
+	select: string;
+	selectend: string;
+	selectstart: string;
+	submit: string;
+	touchcancel: string;
+	touchend: string;
+	touchmove: string;
+	touchstart: string;
+	unload: string;
+};
+/**
+ * A global namespace for `abort` event.
+ */
+export declare const abortEvent = "abort";
+/**
+ * A global namespace for `blur` event.
+ */
+export declare const blurEvent = "blur";
+/**
+ * A global namespace for `move` event.
+ */
+export declare const moveEvent = "move";
+/**
+ * A global namespace for `change` event.
+ */
+export declare const changeEvent = "change";
+/**
+ * A global namespace for `drag` event.
+ */
+export declare const dragEvent = "drag";
+/**
+ * A global namespace for `dragstart` event.
+ */
+export declare const dragstartEvent = "dragstart";
+/**
+ * A global namespace for `dragenter` event.
+ */
+export declare const dragenterEvent = "dragenter";
+/**
+ * A global namespace for `dragleave` event.
+ */
+export declare const dragleaveEvent = "dragleave";
+/**
+ * A global namespace for `dragover` event.
+ */
+export declare const dragoverEvent = "dragover";
+/**
+ * A global namespace for `dragend` event.
+ */
+export declare const dragendEvent = "dragend";
+/**
+ * A global namespace for `error` event.
+ */
+export declare const errorEvent = "error";
+/**
+ * A global namespace for `reset` event.
+ */
+export declare const resetEvent = "reset";
+/**
+ * A global namespace for `resize` event.
+ */
+export declare const resizeEvent = "resize";
+/**
+ * A global namespace for `scroll` event.
+ */
+export declare const scrollEvent = "scroll";
+/**
+ * A global namespace for `submit` event.
+ */
+export declare const submitEvent = "submit";
+/**
+ * A global namespace for `load` event.
+ */
+export declare const loadEvent = "load";
+/**
+ * A global namespace for `loadstart` event.
+ */
+export declare const loadstartEvent = "loadstart";
+/**
+ * A global namespace for `unload` event.
+ */
+export declare const unloadEvent = "unload";
+/**
+ * A global namespace for `readystatechange` event.
+ */
+export declare const readystatechangeEvent = "readystatechange";
+/**
+ * A global namespace for `beforeunload` event.
+ */
+export declare const beforeunloadEvent = "beforeunload";
+/**
+ * A global namespace for `orientationchange` event.
+ */
+export declare const orientationchangeEvent = "orientationchange";
+/**
+ * A global namespace for `contextmenu` event.
+ */
+export declare const contextmenuEvent = "contextmenu";
+/**
+ * A global namespace for `DOMContentLoaded` event.
+ */
+export declare const DOMContentLoadedEvent = "DOMContentLoaded";
+/**
+ * A global namespace for `DOMMouseScroll` event.
+ */
+export declare const DOMMouseScrollEvent = "DOMMouseScroll";
+/**
+ * A global namespace for `select` event.
+ */
+export declare const selectEvent = "select";
+/**
+ * A global namespace for the `selectend` event.
+ */
+export declare const selectendEvent = "selectend";
+/**
+ * A global namespace for the `selectstart` event.
+ */
+export declare const selectstartEvent = "selectstart";
+/**
+ * A global namespace for mouse events equivalent to touch events.
+ */
+export declare const mouseSwipeEvents: {
+	start: string;
+	end: string;
+	move: string;
+	cancel: string;
+};
+/**
+ * A global namespace for mouse click events.
+ */
+export declare const mouseClickEvents: {
+	down: string;
+	up: string;
+};
+/**
+ * A global namespace for `click` event.
+ */
+export declare const mouseclickEvent = "click";
+/**
+ * A global namespace for `dblclick` event.
+ */
+export declare const mousedblclickEvent = "dblclick";
+/**
+ * A global namespace for `mousedown` event.
+ */
+export declare const mousedownEvent = "mousedown";
+/**
+ * A global namespace for `mouseup` event.
+ */
+export declare const mouseupEvent = "mouseup";
+/**
+ * A global namespace for `hover` event.
+ */
+export declare const mousehoverEvent = "hover";
+/**
+ * A global namespace for mouse hover events.
+ */
+export declare const mouseHoverEvents: string[];
+/**
+ * A global namespace for `mouseenter` event.
+ */
+export declare const mouseenterEvent = "mouseenter";
+/**
+ * A global namespace for `mouseleave` event.
+ */
+export declare const mouseleaveEvent = "mouseleave";
+/**
+ * A global namespace for `mousein` event.
+ */
+export declare const mouseinEvent = "mousein";
+/**
+ * A global namespace for `mouseout` event.
+ */
+export declare const mouseoutEvent = "mouseout";
+/**
+ * A global namespace for `mouseover` event.
+ */
+export declare const mouseoverEvent = "mouseover";
+/**
+ * A global namespace for `mousemove` event.
+ */
+export declare const mousemoveEvent = "mousemove";
+/**
+ * A global namespace for `mousewheel` event.
+ */
+export declare const mousewheelEvent = "mousewheel";
+/**
+ * A global namespace for touch events.
+ */
+export declare const touchEvents: {
+	start: string;
+	end: string;
+	move: string;
+	cancel: string;
+};
+/**
+ * A global namespace for `touchstart` event.
+ */
+export declare const touchstartEvent = "touchstart";
+/**
+ * A global namespace for `touchmove` event.
+ */
+export declare const touchmoveEvent = "touchmove";
+/**
+ * A global namespace for `touchcancel` event.
+ */
+export declare const touchcancelEvent = "touchcancel";
+/**
+ * A global namespace for `touchend` event.
+ */
+export declare const touchendEvent = "touchend";
+/**
+ * A global namespace for `pointercancel` event.
+ */
+export declare const pointercancelEvent = "pointercancel";
+/**
+ * A global namespace for `pointerdown` event.
+ */
+export declare const pointerdownEvent = "pointerdown";
+/**
+ * A global namespace for `pointerleave` event.
+ */
+export declare const pointerleaveEvent = "pointerleave";
+/**
+ * A global namespace for `pointermove` event.
+ */
+export declare const pointermoveEvent = "pointermove";
+/**
+ * A global namespace for `pointerup` event.
+ */
+export declare const pointerupEvent = "pointerup";
+/**
+ * A global namespace for focus event names.
+ */
+export declare const focusEvents: {
+	in: string;
+	out: string;
+};
+/**
+ * A global namespace for `focus` event.
+ */
+export declare const focusEvent = "focus";
+/**
+ * A global namespace for `focusin` event.
+ */
+export declare const focusinEvent = "focusin";
+/**
+ * A global namespace for `focusout` event.
+ */
+export declare const focusoutEvent = "focusout";
+/**
+ * A global namespace for `gesturechange` event.
+ */
+export declare const gesturechangeEvent = "gesturechange";
+/**
+ * A global namespace for `gestureend` event.
+ */
+export declare const gestureendEvent = "gestureend";
+/**
+ * A global namespace for `gesturestart` event.
+ */
+export declare const gesturestartEvent = "gesturestart";
+/**
+ * A global namespace for keyboard event keys.
+ */
+export declare const keyboardEventKeys: {
+	Backspace: string;
+	Tab: string;
+	Enter: string;
+	Shift: string;
+	Control: string;
+	Alt: string;
+	Pause: string;
+	CapsLock: string;
+	Escape: string;
+	Scape: string;
+	ArrowLeft: string;
+	ArrowUp: string;
+	ArrowRight: string;
+	ArrowDown: string;
+	Insert: string;
+	Delete: string;
+	Meta: string;
+	ContextMenu: string;
+	ScrollLock: string;
+};
+/**
+ * A global namespace for `keydown` event.
+ */
+export declare const keydownEvent = "keydown";
+/**
+ * A global namespace for `keyup` event.
+ */
+export declare const keyupEvent = "keyup";
+/**
+ * A global namespace for `keypress` event.
+ */
+export declare const keypressEvent = "keypress";
+/**
+ * A global namespace for `Alt` key.
+ * e.which = 18
+ */
+export declare const keyAlt = "Alt";
+/**
+ * A global namespace for `ArrowDown` key.
+ * e.which = 40 equivalent
+ */
+export declare const keyArrowDown = "ArrowDown";
+/**
+ * A global namespace for `ArrowUp` key.
+ * e.which = 38 equivalent
+ */
+export declare const keyArrowUp = "ArrowUp";
+/**
+ * A global namespace for `ArrowLeft` key.
+ * e.which = 37 equivalent
+ */
+export declare const keyArrowLeft = "ArrowLeft";
+/**
+ * A global namespace for `ArrowRight` key.
+ * e.which = 39 equivalent
+ */
+export declare const keyArrowRight = "ArrowRight";
+/**
+ * A global namespace for `Backspace` key.
+ * e.which === 8 equivalent
+ */
+export declare const keyBackspace = "Backspace";
+/**
+ * A global namespace for `CapsLock` key.
+ * e.which = 20 equivalent
+ */
+export declare const keyCapsLock = "CapsLock";
+/**
+ * A global namespace for `Control` key.
+ * e.which = 17
+ */
+export declare const keyControl = "Control";
+/**
+ * A global namespace for `Delete` key.
+ * e.which = 46 equivalent
+ */
+export declare const keyDelete = "Delete";
+/**
+ * A global namespace for `Enter` key.
+ * e.which = 13 equivalent
+ */
+export declare const keyEnter = "Enter";
+/**
+ * A global namespace for `Escape` key.
+ * e.which = 27 equivalent
+ */
+export declare const keyEscape = "Escape";
+/**
+ * A global namespace for `Insert` key.
+ * e.which = 45 equivalent
+ */
+export declare const keyInsert = "Insert";
+/**
+ * A global namespace for `Meta` key.
+ * e.which = 93 equivalent
+ */
+export declare const keyMeta = "Meta";
+/**
+ * A global namespace for `Pause` key.
+ * e.which = 19
+ */
+export declare const keyPause = "Pause";
+/**
+ * A global namespace for `ScrollLock` key.
+ * e.which = 145 equivalent
+ */
+export declare const keyScrollLock = "ScrollLock";
+/**
+ * A global namespace for `Shift` key.
+ * e.which = 16
+ */
+export declare const keyShift = "Shift";
+/**
+ * A global namespace for `Space` key.
+ * e.which = 32 equivalent
+ */
+export declare const keySpace = "Space";
+/**
+ * A global namespace for `Tab` key.
+ * e.which = 9 equivalent
+ */
+export declare const keyTab = "Tab";
+/**
+ * A global namespace for 'animationDuration' string.
+ */
+export declare const animationDuration = "animationDuration";
+/**
+ * A global namespace for 'animationDelay' string.
+ */
+export declare const animationDelay = "animationDelay";
+/**
+ * A global namespace for 'animationName' string.
+ */
+export declare const animationName = "animationName";
+/**
+ * A global namespace for 'animationend' string.
+ */
+export declare const animationEndEvent = "animationend";
+/**
+ * A global namespace for 'transitionDuration' string.
+ */
+export declare const transitionDuration = "transitionDuration";
+/**
+ * A global namespace for 'transitionDelay' string.
+ */
+export declare const transitionDelay = "transitionDelay";
+/**
+ * A global namespace for 'transitionend' string.
+ */
+export declare const transitionEndEvent = "transitionend";
+/**
+ * A global namespace for `transitionProperty` string for modern browsers.
+ */
+export declare const transitionProperty = "transitionProperty";
+/**
+ * A global namespace for 'addEventListener' string.
+ */
+export declare const addEventListener = "addEventListener";
+/**
+ * A global namespace for 'removeEventListener' string.
+ */
+export declare const removeEventListener = "removeEventListener";
+/**
+ * A global namespace for predefined
+ * CSS3 'cubic-bezier()' easing functions.
+ */
+export declare const bezierEasings: {
+	linear: string;
+	easingSinusoidalIn: string;
+	easingSinusoidalOut: string;
+	easingSinusoidalInOut: string;
+	easingQuadraticIn: string;
+	easingQuadraticOut: string;
+	easingQuadraticInOut: string;
+	easingCubicIn: string;
+	easingCubicOut: string;
+	easingCubicInOut: string;
+	easingQuarticIn: string;
+	easingQuarticOut: string;
+	easingQuarticInOut: string;
+	easingQuinticIn: string;
+	easingQuinticOut: string;
+	easingQuinticInOut: string;
+	easingExponentialIn: string;
+	easingExponentialOut: string;
+	easingExponentialInOut: string;
+	easingCircularIn: string;
+	easingCircularOut: string;
+	easingCircularInOut: string;
+	easingBackIn: string;
+	easingBackOut: string;
+	easingBackInOut: string;
+};
+/**
+ * A global namespace for `offsetHeight` property.
+ */
+export declare const offsetHeight = "offsetHeight";
+/**
+ * A global namespace for `offsetWidth` property.
+ */
+export declare const offsetWidth = "offsetWidth";
+/**
+ * A global namespace for `scrollHeight` property.
+ */
+export declare const scrollHeight = "scrollHeight";
+/**
+ * A global namespace for `scrollWidth` property.
+ */
+export declare const scrollWidth = "scrollWidth";
+/**
+ * A global namespace for `touchcancel` event.
+ */
+export declare const tabindex = "tabindex";
+// https://github.com/lukewarlow/user-agent-data-types/blob/master/index.d.ts
+export declare interface NavigatorUABrand {
+	readonly brand: string;
+	readonly version: string;
+}
+export declare interface NavigatorUAData {
+	readonly brands: NavigatorUABrand[];
+	readonly mobile: boolean;
+	readonly platform: string;
+}
+export declare interface NavigatorUA extends Navigator {
+	readonly userAgentData: NavigatorUAData;
+}
+/**
+ * A global namespace for `userAgentData` object.
+ */
+export declare const userAgentData: NavigatorUA["userAgentData"];
+/**
+ * A global namespace for `navigator.userAgent` string.
+ */
+export declare const userAgent: string;
+/**
+ * A global `boolean` for mobile detection.
+ */
+export declare const isMobile: boolean;
+/**
+ * A global `boolean` for Apple browsers.
+ */
+export declare const isApple: boolean;
+/**
+ * A global boolean for Gecko browsers. When writing this file,
+ * Gecko was not supporting `userAgentData`.
+ */
+export declare const isFirefox: boolean;
+/**
+ * A global `boolean` for CSS3 3D transform support.
+ */
+export declare const support3DTransform: boolean;
+/**
+ * A global `boolean` for passive events support,
+ * in general event options are not suited for scroll prevention.
+ *
+ * @see https://github.com/WICG/EventListenerOptions/blob/gh-pages/explainer.md#feature-detection
+ */
+export declare const supportPassive: boolean;
+/**
+ * A global `boolean` for CSS3 transform support.
+ */
+export declare const supportTransform: boolean;
+/**
+ * A global `boolean` for touch events support.
+ */
+export declare const supportTouch: boolean;
+/**
+ * A global `boolean` for CSS3 animation support.
+ */
+export declare const supportAnimation: boolean;
+/**
+ * A global `boolean` for CSS3 transition support.
+ */
+export declare const supportTransition: boolean;
+/**
+ * Shortcut for `HTMLElement.getAttribute()` method.
+ *
+ * @param element target element
+ * @param att attribute name
+ * @returns attribute value
+ */
+export declare const getAttribute: (element: HTMLElement, att: string) => string | null;
+/**
+ * Shortcut for `HTMLElement.getAttributeNS()` method.
+ *
+ * @param ns attribute namespace
+ * @param element target element
+ * @param att attribute name
+ * @returns attribute value
+ */
+export declare const getAttributeNS: (ns: string, element: HTMLElement, att: string) => string | null;
+/**
+ * Shortcut for `HTMLElement.hasAttribute()` method.
+ *
+ * @param element target element
+ * @param att attribute name
+ * @returns the query result
+ */
+export declare const hasAttribute: (element: HTMLElement, att: string) => boolean;
+/**
+ * Shortcut for `HTMLElement.hasAttributeNS()` method.
+ *
+ * @param ns attribute namespace
+ * @param element target element
+ * @param att attribute name
+ * @returns the query result
+ */
+export declare const hasAttributeNS: (ns: string, element: HTMLElement, att: string) => boolean;
+/**
+ * Shortcut for `HTMLElement.setAttribute()` method.
+ *
+ * @param element target element
+ * @param att attribute name
+ * @param value attribute value
+ */
+export declare const setAttribute: (element: HTMLElement, att: string, value: string) => void;
+/**
+ * Shortcut for `SVGElement.setAttributeNS()` method.
+ *
+ * @param ns attribute namespace
+ * @param element target element
+ * @param att attribute name
+ * @param value attribute value
+ */
+export declare const setAttributeNS: (ns: string, element: HTMLElement, att: string, value: string) => void;
+/**
+ * Shortcut for `HTMLElement.removeAttribute()` method.
+ *
+ * @param element target element
+ * @param att attribute name
+ */
+export declare const removeAttribute: (element: HTMLElement, att: string) => void;
+/**
+ * Shortcut for `HTMLElement.removeAttributeNS()` method.
+ *
+ * @param ns attribute namespace
+ * @param  element target element
+ * @param att attribute name
+ */
+export declare const removeAttributeNS: (ns: string, element: HTMLElement, att: string) => void;
+/**
+ * Add one or more CSS classes to `HTMLElement.classList`.
+ *
+ * @param element target
+ * @param classNAME to add
+ */
+export declare const addClass: (element: HTMLElement, ...classNAME: string[]) => void;
+/**
+ * Remove one or more classes from `HTMLElement.classList`.
+ *
+ * @param element target
+ * @param classNAME to remove
+ */
+export declare const removeClass: (element: HTMLElement, ...classNAME: string[]) => void;
+/**
+ * Check class in `HTMLElement.classList`.
+ *
+ * @param element target
+ * @param classNAME to check
+ */
+export declare const hasClass: (element: HTMLElement, classNAME: string) => boolean;
+/**
+ * Add eventListener to an `EventTarget` object.
+ */
+export declare const on: (element: EventTarget, eventName: string, listener: EventListener, options?: AddEventListenerOptions) => void;
+/**
+ * Remove eventListener from an `EventTarget` object.
+ */
+export declare const off: (element: EventTarget, eventName: string, listener: EventListener, options?: AddEventListenerOptions) => void;
+/**
+ * Add an `eventListener` to an `EventTarget`
+ * element and remove it once callback is called.
+ */
+export declare const one: (element: EventTarget, eventName: string, listener: EventListener, options?: AddEventListenerOptions) => void;
+/**
+ * A global namespace for `document.body`.
+ */
+export declare const documentBody: HTMLElement;
+/**
+ * A global namespace for `document.documentElement` or the `<HTML>`.
+ */
+export declare const documentElement: HTMLElement;
+/**
+ * A global namespace for `document.head`.
+ */
+export declare const documentHead: HTMLHeadElement;
+/**
+ * Shortie for `Array.from()` static method.
+ * The utility should also work with any typed arrays
+ * like Float64Array or Int32Array.
+ *
+ * @param arr array-like iterable object
+ * @returns a new array from iterable object
+ */
+export declare const ArrayFrom: <T>(arr: ArrayLike<T> | Iterable<T>) => T[];
+/**
+ * An interface for web components background data.
+ *
+ * @see https://github.com/thednp/bootstrap.native/blob/master/src/components/base-component.js
+ */
+export declare const Data: {
+	/**
+	 * Sets web components data.
+	 *
+	 * @param element target element
+	 * @param component the component's name or a unique key
+	 * @param instance the component instance
+	 */
+	set: <T>(element: HTMLElement, component: string, instance: T) => void;
+	/**
+	 * Returns all instances for specified component.
+	 *
+	 * @param component the component's name or a unique key
+	 * @returns all the component instances
+	 */
+	getAllFor: <T_1>(component: string) => Map<HTMLElement, T_1> | null;
+	/**
+	 * Returns the instance associated with the target.
+	 *
+	 * @param element target element
+	 * @param component the component's name or a unique key
+	 * @returns the instance
+	 */
+	get: <T_2>(element: HTMLElement, component: string) => T_2 | null;
+	/**
+	 * Removes web components data.
+	 *
+	 * @param element target element
+	 * @param component the component's name or a unique key
+	 */
+	remove: <T_3>(element: HTMLElement, component: string) => void;
+};
+/**
+ * An alias for `Data.get()`.
+ */
+export declare const getInstance: <T>(target: HTMLElement, component: string) => T | null;
+/**
+ * Shortie for `document.createElement` method
+ * which allows you to create a new `HTMLElement` for a given `tagName`
+ * or based on an object with specific non-readonly attributes with string values:
+ * `id`, `className`, `textContent`, `style`, etc.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElement
+ *
+ * @param param `tagName` or object
+ * @return a new `HTMLElement`
+ */
+export declare const createElement: (param?: string | Partial<HTMLElement>) => HTMLElement | undefined;
+/**
+ * Shortie for `document.createElementNS` method
+ * which allows you to create a new `HTMLElement` for a given `tagName`
+ * or based on an object with specific non-readonly attributes with string values:
+ * `id`, `className`, `textContent`, `style`, etc.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/Document/createElementNS
+ *
+ * @param ns `namespaceURI` to associate with the new `HTMLElement`
+ * @param param `tagName` or object
+ * @return a new `HTMLElement`
+ */
+export declare const createElementNS: (ns: string, param?: string | Partial<HTMLElement>) => HTMLElement | undefined;
+/**
+ * Shortcut for the `Element.dispatchEvent(Event)` method.
+ *
+ * @param element is the target
+ * @param event is the `Event` object
+ */
+export declare const dispatchEvent: (element: EventTarget, event: Event) => boolean;
+/**
+ * JavaScript `Array` distinct.
+ *
+ * @see https://codeburst.io/javascript-array-distinct-5edc93501dc4
+ *
+ * @example
+ * ```
+ * [0,1,1,2].filter(distinct)
+ * // => [0,1,2]
+ * ```
+ * @param value array item value
+ * @param index array item index
+ * @param arr a clone of the target array
+ * @returns the query result
+ */
+export declare const distinct: <T>(value: T, index: number, arr: T[]) => boolean;
+/**
+ * Utility to make sure callbacks are consistently
+ * called when animation ends.
+ *
+ * @param element target
+ * @param handler `animationend` callback
+ */
+export declare const emulateAnimationEnd: (element: HTMLElement, handler: EventListener) => void;
+/**
+ * Utility to make sure callbacks are consistently
+ * called when transition ends.
+ *
+ * @param element event target
+ * @param handler `transitionend` callback
+ */
+export declare const emulateTransitionEnd: (element: HTMLElement, handler: EventListener) => void;
+/**
+ * Shortcut for `Float32Array.from()` static method.
+ *
+ * @param arr array-like iterable object
+ * @returns a new Float32Array
+ */
+export declare const Float32ArrayFrom: (arr: ArrayLike<number> | Iterable<number>) => Float32Array;
+/**
+ * Shortcut for `Float64Array.from()` static method.
+ *
+ * @param arr array-like iterable object
+ * @returns a new Float64Array
+ */
+export declare const Float64ArrayFrom: (arr: ArrayLike<number> | Iterable<number>) => Float64Array;
+/**
+ * Shortie for `HTMLElement.focus()` method.
+ *
+ * @param element is the target
+ * @param options allows to pass additional options such as `preventScroll: boolean`
+ */
+export declare const focus: (element: HTMLOrSVGElement, options?: FocusOptions) => void;
+/** A generic function with empty body. */
+export declare const noop: () => void;
+/**
+ * Utility to normalize component options.
+ *
+ * @param element target
+ * @param defaultOps component default options
+ * @param inputOps component instance options
+ * @param ns component namespace
+ * @return normalized component options object
+ */
+export declare const normalizeOptions: <T extends {
+	[key: string]: any;
+}>(element: HTMLElement, defaultOps: T, inputOps: Partial<T>, ns?: string) => T;
+export type NormalValue = boolean | number | string | ((...args: any[]) => any) | null;
+/**
+ * Utility to normalize component options
+ *
+ * @param value the input value
+ * @return the normalized value
+ */
+export declare const normalizeValue: (value?: boolean | number | string) => NormalValue;
+declare function ObjectAssignTyped<T, U>(target: T, source: U): T & U;
+declare function ObjectAssignTyped<T, U, V>(target: T, source1: U, source2: V): T & U & V;
+declare function ObjectAssignTyped<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W;
+declare function ObjectAssignTyped<T, U, V, W, Q>(target: T, source1: U, source2: V, source3: W, source4: Q): T & U & V & W & Q;
+declare function ObjectAssignTyped<T, U, V, W, Q, R>(target: T, source1: U, source2: V, source3: W, source4: Q, source5: R): T & U & V & W & Q & R;
+declare function ObjectAssignTyped(target: any, ...sources: any[]): any;
+/**
+ * Shortcut for `Object.assign()` static method.
+ *
+ * @param obj a target object
+ * @param source source object(s)
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
+ */
+export declare const ObjectAssign: typeof ObjectAssignTyped;
+/**
+ * Shortcut for `Object.entries()` static method.
+ *
+ * @param obj a target object
+ * @returns the entries of an object in an array format [key, value][]
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
+ */
+export declare const ObjectEntries: <O extends Record<string, any>>(obj: O) => [
+	keyof O,
+	O[keyof O]
+][];
+/**
+ * A shortcut to `Object.hasOwn()` static method to work
+ * with regular `Object` elements.
+ *
+ * @see https://fettblog.eu/typescript-hasownproperty/
+ * @param obj the target object
+ * @param prop the property to check
+ * @returns the query result
+ */
+export declare const ObjectHasOwn: <T extends object, K extends PropertyKey>(obj: T, prop: K) => obj is T & Record<K, unknown>;
+/**
+ * Shortcut for `Object.keys()` static method.
+ *
+ * @param obj a target object
+ * @returns an array with object keys
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
+ */
+export declare const ObjectKeys: <O extends Record<string, any>>(obj: O) => (keyof O)[];
+/**
+ * Shortcut for `Object.values()` static method.
+ *
+ * @param obj a target object
+ * @returns an array with the object values
+ * @see https://github.com/devinrhode2/ObjectTyped/blob/master/src/index.ts
+ */
+export declare const ObjectValues: <O extends Record<string, unknown>>(obj: O) => O[keyof O][];
+export declare interface OriginalEvent extends CustomEvent<any> {
+	readonly type: string;
+	relatedTarget?: EventTarget;
+}
+/**
+ * Returns a namespaced `CustomEvent` specific to each component.
+ *
+ * @param eventType Event.type
+ * @param config Event.options | Event.properties
+ * @returns a new namespaced event
+ */
+export declare const createCustomEvent: <T extends OriginalEvent>(eventType: string, config?: CustomEventInit<any>) => T;
+/**
+ * A global namespace for most scroll event listeners.
+ */
+export declare const passiveHandler: Partial<AddEventListenerOptions>;
+/**
+ * Utility to force re-paint of an `HTMLElement` target.
+ *
+ * @param element is the target
+ * @return the `Element.offsetHeight` value
+ */
+export declare const reflow: (element: HTMLElement) => number;
+export declare interface CSS4Declaration extends Exclude<() => string | symbol, CSSStyleDeclaration> {
+	[key: string]: string;
+}
+/**
+ * Shortcut for multiple uses of `HTMLElement.style.propertyName` method.
+ *
+ * @param element target element
+ * @param styles attribute value
+ */
+export declare const setElementStyle: (element: HTMLElement, styles: Partial<CSS4Declaration>) => void;
+/**
+ * An interface for one or more `TimerHandler`s per `Element`.
+ *
+ * @see https://github.com/thednp/navbar/
+ */
+export declare const Timer: {
+	/**
+	 * Sets a new timeout timer for an element, or element -> key association.
+	 *
+	 * @param element target element
+	 * @param callback the callback
+	 * @param delay the execution delay
+	 * @param key a unique key
+	 */
+	set: (element: HTMLElement, callback: TimerHandler, delay: number, key?: string) => void;
+	/**
+	 * Returns the timer associated with the target.
+	 *
+	 * @param element target element
+	 * @param key a unique
+	 * @returns the timer
+	 */
+	get: (element: HTMLElement, key?: string) => number | null;
+	/**
+	 * Clears the element's timer.
+	 *
+	 * @param element target element
+	 * @param key a unique key
+	 */
+	clear: (element: HTMLElement, key?: string) => void;
+};
+/**
+ * Shortcut for `String.toLowerCase()`.
+ *
+ * @param source input string
+ * @returns lowercase output string
+ */
+export declare const toLowerCase: (source: string) => string;
+/**
+ * Shortcut for `String.toUpperCase()`.
+ *
+ * @param source input string
+ * @returns uppercase output string
+ */
+export declare const toUpperCase: (source: string) => string;
+export declare interface BoundingClientRect {
+	width: number;
+	height: number;
+	top: number;
+	left: number;
+	right: number;
+	bottom: number;
+	x: number;
+	y: number;
+}
+/**
+ * Returns the bounding client rect of a target `HTMLElement`.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param element event.target
+ * @param includeScale when *true*, the target scale is also computed
+ * @returns the bounding client rect object
+ */
+export declare const getBoundingClientRect: (element: HTMLElement, includeScale?: boolean) => BoundingClientRect;
+/**
+ * Returns the `document` or the `#document` element.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param node the reference node
+ * @returns the parent document of the given node
+ */
+export declare const getDocument: (node?: Node | Document | Window) => Document;
+/**
+ * Returns the `document.body` or the `<body>` element.
+ *
+ * @param node the reference node
+ * @returns the parent `<body>` of the specified node
+ */
+export declare const getDocumentBody: (node?: Node | Document | Window) => HTMLElement;
+/**
+ * Returns the `document.documentElement` or the `<HTML>` element.
+ *
+ * @param node the reference node
+ * @returns the parent `<HTML>` of the node's parent document
+ */
+export declare const getDocumentElement: (node?: Node | Document | Window) => HTMLElement;
+/**
+ * Returns the `document.head` or the `<head>` element.
+ *
+ * @param node the reference node
+ * @returns the `<head>` of the node's parent document
+ */
+export declare const getDocumentHead: (node?: Node | Document | Window) => HTMLElement & HTMLHeadElement;
+/**
+ * Utility to get the computed `animationDuration`
+ * from `HTMLElement` in miliseconds.
+ *
+ * @param element target
+ * @return the `animationDuration` value in miliseconds
+ */
+export declare const getElementAnimationDuration: (element: HTMLElement) => number;
+/**
+ * Utility to get the computed `animationDelay`
+ * from Element in miliseconds.
+ *
+ * @param element target
+ * @return the `animationDelay` value in miliseconds
+ */
+export declare const getElementAnimationDelay: (element: HTMLElement) => number;
+/**
+ * Shortcut for `window.getComputedStyle(element).propertyName`
+ * static method.
+ *
+ * * If `element` parameter is not an `HTMLElement`, `getComputedStyle`
+ * throws a `ReferenceError`.
+ *
+ * @param element target
+ * @param property the css property
+ * @return the css property value
+ */
+export declare const getElementStyle: (element: HTMLElement, property: string) => string;
+/**
+ * Utility to get the computed `transitionDuration`
+ * from Element in miliseconds.
+ *
+ * @param element target
+ * @return the `transitionDuration` value in miliseconds
+ */
+export declare const getElementTransitionDuration: (element: HTMLElement) => number;
+/**
+ * Utility to get the computed `transitionDelay`
+ * from Element in miliseconds.
+ *
+ * @param element target
+ * @return the `transitionDelay` value in miliseconds
+ */
+export declare const getElementTransitionDelay: (element: HTMLElement) => number;
+/**
+ * Returns an `{x,y}` object with the target
+ * `HTMLElement` / `Node` scroll position.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param element target node / element
+ * @returns the scroll tuple
+ */
+export declare const getNodeScroll: (element: HTMLElement | Window) => {
+	x: number;
+	y: number;
+};
+/**
+ * Returns the `parentNode` also going through `ShadowRoot`.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param {Node} node the target node
+ * @returns {Node} the apropriate parent node
+ */
+export declare const getParentNode: (node: Node) => Node | ParentNode;
+export declare interface OffsetRect {
+	width: number;
+	height: number;
+	x: number;
+	y: number;
+}
+/**
+ * Returns the rect relative to a given offset parent and its scroll position.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param element target
+ * @param offsetParent the container / offset parent
+ * @param scroll the offsetParent scroll position
+ * @returns a DOMRect like object
+ */
+export declare const getRectRelativeToOffsetParent: (element: HTMLElement, offsetParent: HTMLElement, scroll: {
+	x: number;
+	y: number;
+}) => OffsetRect;
+/**
+ * Returns a unique identifier for popover, tooltip, scrollspy.
+ *
+ * @param element target element
+ * @param key optional identifier key
+ * @returns an existing or new unique ID
+ */
+export declare const getUID: (element: HTMLElement, key?: string) => number;
+/**
+ * Returns the `Window` object of a target node.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param node target node
+ * @returns the `Window` object
+ */
+export declare const getWindow: (node?: Node) => Window;
+/**
+ * Shortie for the `Array.isArray()` static method.
+ *
+ * @param obj array-like iterable object
+ * @returns the query result
+ */
+export declare const isArray: (obj?: unknown) => obj is any[];
+/**
+ * Checks if an element is an `HTMLCanvasElement` or `<canvas>`.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+export declare const isCanvas: (element?: unknown) => element is HTMLCanvasElement;
+/**
+ * Checks if an object is a `Document`.
+ *
+ * @see https://dom.spec.whatwg.org/#node
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isDocument: (obj?: unknown) => obj is Document;
+export declare interface CustomElement extends HTMLElement {
+	shadowRoot: ShadowRoot;
+	connectedCallback?: () => void;
+	disconnectedCallback?: () => void;
+	adoptedCallback?: () => void;
+	attributeChangedCallback?: () => void;
+}
+/**
+ * Checks if an object is a `CustomElement`.
+ *
+ * @param element the target object
+ * @returns the query result
+ */
+export declare const isCustomElement: <T extends CustomElement>(element?: unknown) => element is T;
+/**
+ * Checks if an object is an `Element`.
+ *
+ * @see https://dom.spec.whatwg.org/#node
+ *
+ * ```
+ * ELEMENT_NODE = 1;
+ * ATTRIBUTE_NODE = 2;
+ * TEXT_NODE = 3;
+ * CDATA_SECTION_NODE = 4;
+ * ENTITY_REFERENCE_NODE = 5; // legacy
+ * ENTITY_NODE = 6; // legacy
+ * PROCESSING_INSTRUCTION_NODE = 7;
+ * COMMENT_NODE = 8;
+ * DOCUMENT_NODE = 9;
+ * DOCUMENT_TYPE_NODE = 10;
+ * DOCUMENT_FRAGMENT_NODE = 11;
+ * ```
+ * @param element the target object
+ * @returns the query result
+ */
+export declare const isElement: (element?: unknown) => element is Element;
+/**
+ * Utility to determine if an `HTMLElement`
+ * is partially visible in viewport.
+ *
+ * @param element target
+ * @return the query result
+ */
+export declare const isElementInScrollRange: (element?: HTMLElement) => boolean;
+/**
+ * Utility to determine if an `HTMLElement`
+ * is fully visible in the viewport.
+ *
+ * @param element target
+ * @return the query result
+ */
+export declare const isElementInViewport: (element?: HTMLElement) => boolean;
+/**
+ * Checks if an object is an `Array` in which all items are `Element`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isElementsArray: (obj?: unknown) => obj is HTMLElement[];
+/**
+ * Checks if an object is a `Function`.
+ *
+ * @param fn the target object
+ * @returns the query result
+ */
+export declare const isFunction: (fn?: unknown) => fn is (...arg0: any[]) => any;
+/**
+ * Checks if a value is an `Object`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isObject: (obj?: unknown) => obj is object;
+/**
+ * Checks if an object is an `HTMLCollection`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isHTMLCollection: (obj?: unknown) => obj is HTMLCollection;
+/**
+ * Checks if an element is an `HTMLElement`.
+ *
+ * @see https://dom.spec.whatwg.org/#node
+ *
+ * @param element the target object
+ * @returns the query result
+ */
+export declare const isHTMLElement: (element?: unknown) => element is HTMLElement;
+/**
+ * Check if a target element is an `<img>`.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+export declare const isHTMLImageElement: (element?: unknown) => element is HTMLImageElement;
+/**
+ * Checks if a string is a `JSON` string.
+ *
+ * @param str the target string
+ * @returns the query result
+ */
+export declare const isJSON: (str?: string) => boolean;
+/**
+ * Checks if an element is a `Map`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isMap: (obj?: unknown) => obj is Map<any, any>;
+/**
+ * Checks if an element is a `WeakMap`.
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isWeakMap: (obj?: unknown) => obj is WeakMap<any, any>;
+/**
+ * Checks if an element is an `<svg>` (or any type of SVG element),
+ * `<img>`, `<video>` or `<canvas>`.
+ *
+ * *Tooltip* / *Popover* works different with media elements.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+export declare const isMedia: (element?: unknown) => element is HTMLCanvasElement | HTMLImageElement | SVGElement | HTMLVideoElement;
+/**
+ * Checks if an object is a `Node`.
+ *
+ * @param node the target object
+ * @returns the query result
+ */
+export declare const isNode: (node?: unknown) => node is Node;
+/**
+ * Checks if an object is a `NodeList`.
+ * => equivalent to `object instanceof NodeList`
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isNodeList: (obj?: unknown) => obj is NodeList;
+/**
+ * Shortie for `typeof SOMETHING === "number"`.
+ *
+ * @param num input value
+ * @returns the query result
+ */
+export declare const isNumber: (num?: unknown) => num is number;
+/**
+ * Checks if a page is Right To Left.
+ *
+ * @param node the target
+ * @returns the query result
+ */
+export declare const isRTL: (node?: Node) => boolean;
+/**
+ * Checks if a target `HTMLElement` is affected by scale.
+ *
+ * @see https://github.com/floating-ui/floating-ui
+ *
+ * @param element target
+ * @returns the query result
+ */
+export declare const isScaledElement: (element?: HTMLElement) => boolean;
+/**
+ * Check if target is a `ShadowRoot`.
+ *
+ * @param element target
+ * @returns the query result
+ */
+export declare const isShadowRoot: (element?: unknown) => element is ShadowRoot;
+/**
+ * Shortie for `typeof SOMETHING === "string"`.
+ *
+ * @param str input value
+ * @returns the query result
+ */
+export declare const isString: (str?: unknown) => str is string;
+/**
+ * Check if an element is an `<svg>` or any other SVG element,
+ * an equivalent to `SOMETHING instanceof SVGElement`.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+export declare const isSVGElement: (element?: unknown) => element is SVGElement;
+/**
+ * Check if a target element is a `<table>`, `<td>` or `<th>`.
+ * This specific check is important for determining
+ * the `offsetParent` of a given element.
+ *
+ * @param element the target element
+ * @returns the query result
+ */
+export declare const isTableElement: (element?: unknown) => element is HTMLTableElement | HTMLTableCellElement;
+/**
+ * Check if a target object is `Window`.
+ * => equivalent to `object instanceof Window`
+ *
+ * @param obj the target object
+ * @returns the query result
+ */
+export declare const isWindow: (obj?: unknown) => obj is Window;
+/**
+ * Shortcut for `HTMLElement.closest` method which also works
+ * with children of `ShadowRoot`. The order of the parameters
+ * is intentional since they're both required.
+ *
+ * @see https://stackoverflow.com/q/54520554/803358
+ *
+ * @param element Element to look into
+ * @param selector the selector name
+ * @return the query result
+ */
+export declare const closest: (element: HTMLElement, selector: string) => HTMLElement | null;
+/**
+ * Utility to check if target is typeof `HTMLElement`, `Element`, `Node`
+ * or find one that matches a selector.
+ *
+ * @param selector the input selector or target element
+ * @param parent optional node to look into
+ * @return the `HTMLElement` or `querySelector` result
+ */
+export declare const querySelector: (selector: HTMLElement | string, parent?: ParentNode) => HTMLElement | null;
+/**
+ * Returns an `Array` of `Node` elements that are registered as
+ * `CustomElement`.
+ *
+ * @see https://stackoverflow.com/questions/27334365/how-to-get-list-of-registered-custom-elements
+ *
+ * @param parent parent to look into
+ * @returns the query result
+ */
+export declare const getCustomElements: (parent?: ParentNode) => CustomElement[];
+/**
+ * Returns an `HTMLElement` that matches the id in the document.
+ * Within multiple <iframe> elements, a `parent` parameter
+ * would decisively locate the correct element.
+ *
+ * @param id the ID selector
+ * @param context an element in it's document or document
+ * @returns the requested element
+ */
+export declare const getElementById: (id: string, context?: Node) => HTMLElement | null;
+/**
+ * A shortcut for `(document|Element).querySelectorAll`.
+ *
+ * @param selector the input selector
+ * @param parent optional node to look into
+ * @return the query result
+ */
+export declare const querySelectorAll: (selector: string, parent?: ParentNode) => NodeListOf<HTMLElement>;
+/**
+ * Shortcut for `HTMLElement.getElementsByTagName` method. Some `Node` elements
+ * like `ShadowRoot` do not support `getElementsByTagName`.
+ *
+ * @param selector the tag name
+ * @param parent optional Element to look into
+ * @return the 'HTMLCollection'
+ */
+export declare const getElementsByTagName: (selector: string, parent?: ParentNode) => HTMLCollectionOf<HTMLElement>;
+/**
+ * Shortcut for `HTMLElement.getElementsByClassName` method. Some `Node` elements
+ * like `ShadowRoot` do not support `getElementsByClassName`.
+ *
+ * @param selector the class name
+ * @param parent optional Element to look into
+ * @return the 'HTMLCollection'
+ */
+export declare const getElementsByClassName: (selector: string, parent?: ParentNode) => HTMLCollectionOf<HTMLElement>;
+/**
+ * Check if element matches a CSS selector.
+ *
+ * @param target the target element
+ * @param selector the selector to match
+ * @returns the query result
+ */
+export declare const matches: (target: Element, selector: string) => boolean;
+
+export as namespace SHORTY;
+
+export {};