@oscarpalmer/toretto 0.45.0 → 0.46.0

package/dist/index.d.mts

@@ -6,10 +6,14 @@ type SupporsTouch = {
   readonly value: boolean;
   /**
    * Are touch events supported?
+   *
+   * @returns `true` if touch events are supported, otherwise `false`
    */
   get(): boolean;
   /**
    * Re-evaluate if touch events are supported
+   *
+   * @returns `true` if touch events are supported, otherwise `false`
    */
   update(): boolean;
 };
@@ -30,13 +34,6 @@ type Attribute = {
  * Event listener for custom events
  */
 type CustomEventListener = (event: CustomEvent) => void;
-/**
- * The position of an event
- */
-type EventPosition = {
-  x: number;
-  y: number;
-};
 /**
  * Event listener that can be removed
  */
@@ -68,6 +65,7 @@ type DataPrefixedName = `data-${string}`;
 declare function getAttribute(element: Element, name: DataPrefixedName, parse?: boolean): unknown;
 /**
  * Get the value of a specific attribute from an element
+ *
  * @param element Element to get attribute from
  * @param name Attribute name
  * @returns Attribute value _(or `undefined`)_
@@ -75,6 +73,7 @@ declare function getAttribute(element: Element, name: DataPrefixedName, parse?:
 declare function getAttribute(element: Element, name: string): unknown;
 /**
  * Get specific attributes from an element
+ *
  * @param element Element to get attributes from
  * @param names Attribute names
  * @param parseData Parse data values? _(defaults to `true`)_
@@ -88,6 +87,7 @@ type DispatchedAttributeName = 'checked' | 'open' | 'value';
  * Set an attribute on an element
  *
  * _(Or remove it, if value is `null` or `undefined`)_
+ *
  * @param element Element for attribute
  * @param name Attribute name
  * @param value Attribute value
@@ -98,6 +98,7 @@ declare function setAttribute(element: Element, name: DispatchedAttributeName, v
  * Set an attribute on an element
  *
  * _(Or remove it, if value is `null` or `undefined`)_
+ *
  * @param element Element for attribute
  * @param name Attribute name
  * @param value Attribute value
@@ -107,6 +108,7 @@ declare function setAttribute(element: Element, name: string, value?: unknown):
  * Set an attribute on an element
  *
  * _(Or remove it, if value is `null` or `undefined`)_
+ *
  * @param element Element for attribute
  * @param attribute Attribute to set
  * @param dispatch Dispatch event for attribute? _(defaults to `true`)_
@@ -116,6 +118,7 @@ declare function setAttribute(element: Element, attribute: Attr | Attribute, dis
  * Set one or more attributes on an element
  *
  * _(Or remove them, if their value is `null` or `undefined`)_
+ *
  * @param element Element for attributes
  * @param attributes Attributes to set
  * @param dispatch Dispatch events for relevant attributes? _(defaults to `true`)_
@@ -125,6 +128,7 @@ declare function setAttributes(element: Element, attributes: Array<Attr | Attrib
  * Set one or more attributes on an element
  *
  * _(Or remove them, if their value is `null` or `undefined`)_
+ *
  * @param element Element for attributes
  * @param attributes Attributes to set
  * @param dispatch Dispatch events for relevant attributes? _(defaults to `true`)_
@@ -134,12 +138,14 @@ declare function setAttributes(element: Element, attributes: Record<string, unkn
 //#region src/attribute/index.d.ts
 /**
  * Is the attribute considered bad and potentially harmful?
+ *
  * @param attribute Attribute to check
  * @returns `true` if attribute is considered bad
  */
 declare function isBadAttribute(attribute: Attr | Attribute): boolean;
 /**
  * Is the attribute considered bad and potentially harmful?
+ *
  * @param name Attribute name
  * @param value Attribute value
  * @returns `true` if attribute is considered bad
@@ -147,12 +153,14 @@ declare function isBadAttribute(attribute: Attr | Attribute): boolean;
 declare function isBadAttribute(name: string, value: string): boolean;
 /**
  * Is the attribute a boolean attribute?
+ *
  * @param name Attribute to check
  * @returns `true` if attribute is a boolean attribute
  */
 declare function isBooleanAttribute(attribute: Attr | Attribute): boolean;
 /**
  * Is the attribute a boolean attribute?
+ *
  * @param name Attribute name
  * @returns `true` if attribute is a boolean attribute
  */
@@ -161,6 +169,7 @@ declare function isBooleanAttribute(name: string): boolean;
  * Is the attribute an invalid boolean attribute?
  *
  * _(I.e., its value is not empty or the same as its name)_
+ *
  * @param attribute Attribute to check
  * @returns `true` if attribute is an invalid boolean attribute
  */
@@ -169,6 +178,7 @@ declare function isInvalidBooleanAttribute(attribute: Attr | Attribute): boolean
  * Is the attribute an invalid boolean attribute?
  *
  * _(I.e., its value is not empty or the same as its name)_
+ *
  * @param name Attribute name
  * @param value Attribute value
  * @returns `true` if attribute is an invalid boolean attribute
@@ -176,6 +186,16 @@ declare function isInvalidBooleanAttribute(attribute: Attr | Attribute): boolean
 declare function isInvalidBooleanAttribute(name: string, value: string): boolean;
 //#endregion
 //#region node_modules/@oscarpalmer/atoms/dist/models.d.mts
+/**
+ * Position of an event
+ */
+type EventPosition = {
+  x: number;
+  y: number;
+};
+/**
+ * A generic async callback function
+ */
 /**
  * A generic object
  */
@@ -195,6 +215,7 @@ type Properties<Target extends Element> = { [Property in keyof Target]?: Target[
 type Styles$1 = Partial<Record<keyof CSSStyleDeclaration, unknown>>;
 /**
  * Creates an HTML element with the specified tag name together with optional properties, attributes, and styles
+ *
  * @param tag Tag name
  * @param properties Element properties
  * @param attributes Element attributes
@@ -204,6 +225,7 @@ type Styles$1 = Partial<Record<keyof CSSStyleDeclaration, unknown>>;
 declare function createElement<TagName extends keyof HTMLElementTagNameMap>(tag: TagName, properties?: Properties<HTMLElementTagNameMap[TagName]>, attributes?: Record<string, unknown>, styles?: Styles$1): HTMLElementTagNameMap[TagName];
 /**
  * Creates an HTML element with the specified tag name together with optional properties, attributes, and styles
+ *
  * @param tag Tag name
  * @param properties Element properties
  * @param attributes Element attributes
@@ -215,6 +237,7 @@ declare function createElement(tag: string, properties?: Properties<HTMLElement>
 //#region src/data.d.ts
 /**
  * Get a keyed data value from an element
+ *
  * @param element Element to get data from
  * @param key Data key
  * @param parse Parse values? _(defaults to `true`)_
@@ -223,6 +246,7 @@ declare function createElement(tag: string, properties?: Properties<HTMLElement>
 declare function getData(element: Element, key: string, parse?: boolean): unknown;
 /**
  * Get keyed data values from an element
+ *
  * @param element Element to get data from
  * @param keys Keys of the data values to get
  * @param parse Parse values? _(defaults to `true`)_
@@ -231,12 +255,14 @@ declare function getData(element: Element, key: string, parse?: boolean): unknow
 declare function getData<Key extends string>(element: Element, keys: Key[], parse?: boolean): Record<Key, unknown>;
 /**
  * Set data values on an element
+ *
  * @param element Element to set data on
  * @param data Data to set
  */
 declare function setData(element: Element, data: PlainObject): void;
 /**
  * Set a data value on an element
+ *
  * @param element Element to set data on
  * @param key Data key
  * @param value Data value
@@ -246,6 +272,7 @@ declare function setData(element: Element, key: string, value: unknown): void;
 //#region src/event/index.d.ts
 /**
  * Dispatch an event for a target
+ *
  * @param target Event target
  * @param type Type of event
  * @param options Options for event _(bubbles and is cancelable by default)_
@@ -253,6 +280,7 @@ declare function setData(element: Element, key: string, value: unknown): void;
 declare function dispatch<Type extends keyof HTMLElementEventMap>(target: EventTarget, type: Type, options?: CustomEventInit): void;
 /**
  * Dispatch an event for a target
+ *
  * @param target Event target
  * @param type Type of event
  * @param options Options for event _(bubbles and is cancelable by default)_
@@ -260,12 +288,14 @@ declare function dispatch<Type extends keyof HTMLElementEventMap>(target: EventT
 declare function dispatch(target: EventTarget, type: string, options?: CustomEventInit): void;
 /**
  * Get the X- and Y-coordinates from a pointer event
+ *
  * @param event Pointer event
  * @returns X- and Y-coordinates
  */
 declare function getPosition(event: MouseEvent | TouchEvent): EventPosition | undefined;
 /**
  * Remove an event listener
+ *
  * @param target Event target
  * @param type Type of event
  * @param listener Event listener
@@ -274,6 +304,7 @@ declare function getPosition(event: MouseEvent | TouchEvent): EventPosition | un
 declare function off(target: EventTarget, type: keyof HTMLElementEventMap, listener: EventListener | CustomEventListener, options?: EventListenerOptions): void;
 /**
  * Remove an event listener
+ *
  * @param target Event target
  * @param type Type of event
  * @param listener Event listener
@@ -282,6 +313,7 @@ declare function off(target: EventTarget, type: keyof HTMLElementEventMap, liste
 declare function off(target: EventTarget, type: string, listener: EventListener | CustomEventListener, options?: EventListenerOptions): void;
 /**
  * Add an event listener
+ *
  * @param target Event target
  * @param type Type of event
  * @param listener Event listener
@@ -290,6 +322,7 @@ declare function off(target: EventTarget, type: string, listener: EventListener
 declare function on<Type extends keyof HTMLElementEventMap>(target: EventTarget, type: Type, listener: (event: HTMLElementEventMap[Type]) => void, options?: AddEventListenerOptions): RemovableEventListener;
 /**
  * Add an event listener
+ *
  * @param target Event target
  * @param type Type of event
  * @param listener Event listener
@@ -303,6 +336,7 @@ declare function on(target: EventTarget, type: string, listener: EventListener |
  *
  * - If no match is found, `null` is returned
  * - _(If you want to search upwards, downwards, and sideways, use {@link findRelatives})_
+ *
  * @param origin Origin to start from
  * @param tagName Tag name to match
  * @returns Found ancestor or `null`
@@ -313,6 +347,7 @@ declare function findAncestor<TagName extends keyof HTMLElementTagNameMap>(origi
  *
  * - If no match is found, `null` is returned
  * - _(If you want to search upwards, downwards, and sideways, use {@link findRelatives})_
+ *
  * @param origin Origin to start from
  * @param selector Selector to match
  * @returns Found ancestor or `null`
@@ -322,6 +357,7 @@ declare function findAncestor(origin: Element | Event | EventTarget, selector: s
  * Finds the closest elements to the origin element that matches the tag name
  *
  * Traverses up, down, and sideways in the _DOM_-tree. _(If you only want to traverse up, use {@link findAncestor})_
+ *
  * @param origin Element to start from
  * @param tagName Tag name to match
  * @param context Context to search within
@@ -332,6 +368,7 @@ declare function findRelatives<TagName extends keyof HTMLElementTagNameMap>(orig
  * Finds the closest elements to the origin element that matches the selector
  *
  * Traverses up, down, and sideways in the _DOM_-tree. _(If you only want to traverse up, use {@link findAncestor})_
+ *
  * @param origin Element to start from
  * @param selector Selector to match
  * @param context Context to search within
@@ -340,6 +377,7 @@ declare function findRelatives<TagName extends keyof HTMLElementTagNameMap>(orig
 declare function findRelatives(origin: Element, selector: string, context?: Document | Element): Element[];
 /**
  * Get the distance between two elements _(i.e., the amount of nodes of between them)_
+ *
  * @param origin Origin element
  * @param target Target element
  * @returns Distance between elements, or `-1` if distance cannot be calculated
@@ -349,6 +387,7 @@ declare function getDistance(origin: Element, target: Element): number;
 //#region src/find/index.d.ts
 /**
  * Find the first element that matches the tag name
+ *
  * @param tagName Tag name of element to find
  * @param context Context to search within _(defaults to `document`)_
  * @returns Found element or `null`
@@ -356,6 +395,7 @@ declare function getDistance(origin: Element, target: Element): number;
 declare function findElement<TagName extends keyof HTMLElementTagNameMap>(tagName: TagName, context?: Selector | null): HTMLElementTagNameMap[TagName] | null;
 /**
  * Find the first element that matches the selector
+ *
  * @param selector Selector to find element for
  * @param context Context to search within _(defaults to `document`)_
  * @returns Found element or `null`
@@ -363,6 +403,7 @@ declare function findElement<TagName extends keyof HTMLElementTagNameMap>(tagNam
 declare function findElement(selector: string, context?: Selector | null): Element | null;
 /**
  * Find elements that match the selector
+ *
  * @param tagName tagName to find elements for
  * @param context Context to search within _(defaults to `document`)_
  * @returns Found elements
@@ -370,16 +411,25 @@ declare function findElement(selector: string, context?: Selector | null): Eleme
 declare function findElements(tagName: keyof HTMLElementTagNameMap, context?: Selector | null): HTMLElementTagNameMap[typeof tagName][];
 /**
  * Find elements that match the selector
+ *
  * @param selector Selector to find elements for
  * @param context Context to search within _(defaults to `document`)_
  * @returns Found elements
  */
 declare function findElements(selector: Selector, context?: Selector | null): Element[];
+/**
+ * Get elements from an event position
+ *
+ * @param position Event position
+ * @returns Elements at the event position
+ */
+declare function getElementFromPosition(position: EventPosition): Element[];
 /**
  * Get the most specific element under the pointer
  *
  * - Ignores elements with `pointer-events: none` and `visibility: hidden`
  * - _(If `skipIgnore` is `true`, no elements are ignored)_
+ *
  * @param skipIgnore Skip ignored elements?
  * @returns Found element or `null`
  */
@@ -388,24 +438,28 @@ declare function getElementUnderPointer(skipIgnore?: boolean): Element | null;
 //#region src/focusable.d.ts
 /**
  * Get a list of focusable elements within a parent element
+ *
  * @param parent Parent element
  * @returns Focusable elements
  */
 declare function getFocusable(parent: Element): Element[];
 /**
  * Get a list of tabbable elements within a parent element
+ *
  * @param parent Parent element
  * @returns Tabbable elements
  */
 declare function getTabbable(parent: Element): Element[];
 /**
  * Is the element focusable?
+ *
  * @param element Element to check
  * @returns `true` if focusable, otherwise `false`
  */
 declare function isFocusable(element: Element): boolean;
 /**
  * Is the element tabbable?
+ *
  * @param element Element to check
  * @returns `true` if tabbable, otherwise `false`
  */
@@ -420,11 +474,13 @@ type HtmlOptions = {
 };
 /**
  * Create nodes from a template string
+ *
  * @returns Created nodes
  */
 declare function html(strings: TemplateStringsArray, ...values: unknown[]): Node[];
 /**
  * Create nodes from an HTML string or a template element
+ *
  * @param value HTML string or id for a template element
  * @param options Options for creating nodes
  * @returns Created nodes
@@ -432,6 +488,7 @@ declare function html(strings: TemplateStringsArray, ...values: unknown[]): Node
 declare function html(value: string, options?: HtmlOptions): Node[];
 /**
  * Create nodes from a template element
+ *
  * @param template Template element
  * @param options Options for creating nodes
  * @returns Created nodes
@@ -450,20 +507,30 @@ declare namespace html {
 declare function sanitize(value: Node | Node[]): Node[];
 //#endregion
 //#region src/internal/is.d.ts
+/**
+ * Is the value an event position?
+ *
+ * @param value Value to check
+ * @returns `true` if it's an event position, otherwise `false`
+ */
+declare function isEventPosition(value: unknown): value is EventPosition;
 /**
  * Is the value an event target?
+ *
  * @param value Value to check
  * @returns `true` if it's an event target, otherwise `false`
  */
 declare function isEventTarget(value: unknown): value is EventTarget;
 /**
  * Is the value an HTML or SVG element?
+ *
  * @param value Value to check
  * @returns `true` if it's an HTML or SVG element, otherwise `false`
  */
 declare function isHTMLOrSVGElement(value: unknown): value is HTMLElement | SVGElement;
 /**
  * Is the value an input element? _(`<input>`, `<select>`, or `<textarea>`)_
+ *
  * @param value Value to check
  * @returns `true` if it's an input element, otherwise `false`
  */
@@ -472,18 +539,21 @@ declare function isInputElement(value: unknown): value is HTMLInputElement | HTM
 //#region src/is.d.ts
 /**
  * Is the value a child node?
+ *
  * @param value Value to check
  * @returns `true` if it's a child node, otherwise `false`
  */
 declare function isChildNode(value: unknown): value is ChildNode;
 /**
  * Is the node inside a document?
+ *
  * @param node Node to check
  * @returns `true` if it's inside a document, otherwise `false`
  */
 declare function isInDocument(node: Node): boolean;
 /**
  * Is the node inside a specific document?
+ *
  * @param node Node to check
  * @param document Document to check within
  * @returns `true` if it's inside the document, otherwise `false`
@@ -494,6 +564,7 @@ declare function isInDocument(node: Node, document: Document): boolean;
 type GetProperties<Target extends Element> = { [Property in keyof Target as Target[Property] extends Primitive ? Property : never]?: Target[Property] };
 /**
  * Get the values of one or more properties on an element
+ *
  * @param target Target element
  * @param properties Properties to get
  * @returns Property values
@@ -501,6 +572,7 @@ type GetProperties<Target extends Element> = { [Property in keyof Target as Targ
 declare function getProperties<Target extends Element, Property extends keyof GetProperties<Target>>(target: Target, properties: Property[]): Pick<GetProperties<Target>, Property>;
 /**
  * Get the value of a property on an element
+ *
  * @param target Target element
  * @param property Property to get
  * @returns Property value
@@ -514,6 +586,7 @@ type SetProperties<Target extends Element> = { [Property in keyof Target as Targ
  * Set the values of one or more properties on an element
  *
  * Also updates attributes for boolean/dispatchable properties, and if `dispatch` is `true`, will dispatch events for dispatchable properties
+ *
  * @param target Target element
  * @param properties Properties to set
  * @param dispatch Dispatch events for properties? _(defaults to `true`)_
@@ -521,6 +594,7 @@ type SetProperties<Target extends Element> = { [Property in keyof Target as Targ
 declare function setProperties<Target extends Element>(target: Target, properties: SetProperties<Target>, dispatch?: boolean): void;
 /**
  * Set the value for a dispatchable property on an element
+ *
  * @param target Target element
  * @param property Property to set
  * @param value Value to set
@@ -529,6 +603,7 @@ declare function setProperties<Target extends Element>(target: Target, propertie
 declare function setProperty<Target extends Element, Property extends DispatchedAttributeName>(target: Target, property: Property, value: DispatchedPropertyValue<Target, Property>, dispatch?: boolean): void;
 /**
  * Set the value for a property on an element
+ *
  * @param target Target element
  * @param property Property to set
  * @param value Value to set
@@ -551,6 +626,7 @@ type Styles = Partial<Record<keyof CSSStyleValues, unknown>>;
 type Variables<Value extends Record<string, string | undefined> = Record<string, string | undefined>> = { [property in keyof Value as `--${string & property}`]?: string | undefined };
 /**
  * Get a style from an element
+ *
  * @param element Element to get the style from
  * @param property Style name
  * @param computed Get the computed style? _(defaults to `false`)_
@@ -559,6 +635,7 @@ type Variables<Value extends Record<string, string | undefined> = Record<string,
 declare function getStyle(element: Element, property: keyof CSSStyleValues, computed?: boolean): string | undefined;
 /**
  * Get styles from an element
+ *
  * @param element Element to get the styles from
  * @param properties Styles to get
  * @param computed Get the computed styles? _(defaults to `false`)_
@@ -567,17 +644,20 @@ declare function getStyle(element: Element, property: keyof CSSStyleValues, comp
 declare function getStyles<Property extends keyof CSSStyleValues>(element: Element, properties: Property[], computed?: boolean): Record<Property, string | undefined>;
 /**
  * Get the text direction of a node or element _(or document, if element is invalid)_
+ *
  * @param node Node or element to get the text direction from
  * @returns Text direction
  */
 declare function getTextDirection(node: Element | Node): TextDirection;
 /**
  * Get the text direction of the document
+ *
  * @returns Text direction
  */
 declare function getTextDirection(): TextDirection;
 /**
  * Set a style on an element
+ *
  * @param element Element to set the style on
  * @param property Style name
  * @param value Style value
@@ -585,16 +665,18 @@ declare function getTextDirection(): TextDirection;
 declare function setStyle(element: Element, property: keyof CSSStyleValues, value?: unknown): void;
 /**
  * Set styles on an element
+ *
  * @param element Element to set the styles on
  * @param styles Styles to set
  */
 declare function setStyles(element: Element, styles: Styles): void;
 /**
  * Toggle styles for an element
+ *
  * @param element Element to style
  * @param styles Styles to be set or removed
  * @returns Style toggler
  */
 declare function toggleStyles(element: Element, styles: Styles): StyleToggler;
 //#endregion
-export { findElement as $, findElement, findElements as $$, findElements, Attribute, CustomEventListener, EventPosition, RemovableEventListener, Selector, StyleToggler, TextDirection, booleanAttributes, createElement, dispatch, findAncestor, findRelatives, getAttribute, getAttributes, getData, getDistance, getElementUnderPointer, getFocusable, getPosition, getProperties, getProperty, getStyle, getStyles, getTabbable, getTextDirection, html, isBadAttribute, isBooleanAttribute, isChildNode, isEventTarget, isFocusable, isHTMLOrSVGElement, isInDocument, isInputElement, isInvalidBooleanAttribute, isTabbable, off, on, sanitize, setAttribute, setAttributes, setData, setProperties, setProperty, setStyle, setStyles, supportsTouch, toggleStyles };
+export { findElement as $, findElement, findElements as $$, findElements, Attribute, CustomEventListener, RemovableEventListener, Selector, StyleToggler, TextDirection, booleanAttributes, createElement, dispatch, findAncestor, findRelatives, getAttribute, getAttributes, getData, getDistance, getElementFromPosition, getElementUnderPointer, getFocusable, getPosition, getProperties, getProperty, getStyle, getStyles, getTabbable, getTextDirection, html, isBadAttribute, isBooleanAttribute, isChildNode, isEventPosition, isEventTarget, isFocusable, isHTMLOrSVGElement, isInDocument, isInputElement, isInvalidBooleanAttribute, isTabbable, off, on, sanitize, setAttribute, setAttributes, setData, setProperties, setProperty, setStyle, setStyles, supportsTouch, toggleStyles };