panacea-browser

Index

Functions BOM

Functions Crypto

hashBrowser

Functions Random

UUIDGeneratorBrowser

Functions String

BOM Functions

copyToClipboardAsync

copyToClipboardAsync(str: string): Promise<void>

- Defined in browser/src/bom/copyToClipboardAsync.ts:14
Copies a string to the clipboard, returning a promise that resolves when the clipboard's contents have been updated.
example
```
copyToClipboardAsync('Lorem ipsum'); // 'Lorem ipsum' copied to clipboard.
```
since
0.1.5
Parameters
- str: string
  
  The string to copy.
Returns Promise<void>
A promise that resolves when the clipboard has been updated.

currentURL

currentURL(): string

- Defined in browser/src/bom/currentURL.ts:12
Returns the current URL.
example
```
currentURL(); // http://localhost:8080/
```
since
0.1.1
Returns string
The current URL.

detectDeviceType

detectDeviceType(): "Mobile" | "Desktop"

- Defined in browser/src/bom/detectDeviceType.ts:12
Detects whether the page is being viewed on a mobile device or a desktop.
example
```
detectDeviceType(); // 'Mobile' or 'Desktop'
```
since
0.1.1
Returns "Mobile" | "Desktop"
'Mobile' or 'Desktop'

detectLanguage

detectLanguage(defaultLang?: string): string

- Defined in browser/src/bom/detectLanguage.ts:13
Detects the preferred language of the current user.
example
```
detectLanguage(); // 'nl-NL'
```
since
0.1.2
Parameters
- defaultLang: string = "US"
  
  The default language to use if none is found.
Returns string
The language preferred by the user or the default language if none is found.

getProtocol

getProtocol(): string

- Defined in browser/src/bom/getProtocol.ts:11
Gets the protocol being used on the current page.
example
```
getProtocol(); // 'https:'
```
since
0.1.0
Returns string

getSelectedText

getSelectedText(): undefined | string

- Defined in browser/src/bom/getSelectedText.ts:12
Gets the currently selected text.
example
```
getSelectedText(); // 'Lorem ipsum'
```
since
0.1.1
Returns undefined | string
The currently selected text.

getURLParameters

getURLParameters(url: string): {}

- Defined in browser/src/bom/getURLParameters.ts:16
Creates an object containing the parameters of the current URL.
example
```
getURLParameters('google.com'); // {}
getURLParameters('http://url.com/page?name=Adam&surname=Smith');
// {name: 'Adam', surname: 'Smith'}
```
since
0.1.6

deprecated
since 0.1.8 - Use import { getURLParameters } from panacea-core.
Parameters
- url: string
  
  The URL to parse.
Returns {}
An object containing the parameters of the current URL.
- [key: string]: string

httpDelete

httpDelete(url: string | URL, callback: (request: XMLHttpRequest) => void, err?: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void): void

- Defined in browser/src/bom/httpDelete.ts:16
Makes a DELETE request to the passed URL.
example
```
httpDelete('https://jsonplaceholder.typicode.com/posts/1', request => {
  console.log(request.responseText);
}); // Logs: {}
```
since
0.1.2
Parameters
- url: string | URL
  
  URL to send the DELETE request to.
- callback: (request: XMLHttpRequest) => void
  
  Callback to handle the response.
  - - (request: XMLHttpRequest): void
    - Parameters
      - request: XMLHttpRequest
      Returns void
- err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error
  
  Callback to handle an error.
  - - (request: XMLHttpRequest, event: ProgressEvent<EventTarget>): void
    - Parameters
      - request: XMLHttpRequest
      - event: ProgressEvent<EventTarget>
      Returns void
Returns void

httpGet

httpGet(url: string | URL, callback: (responseText: string) => void, err?: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void): void

- Defined in browser/src/bom/httpGet.ts:17
Makes a GET request to the passed URL.
example
```
httpGet(
  'https://jsonplaceholder.typicode.com/posts/1',
  console.log
);
```
since
0.1.3
Parameters
- url: string | URL
  
  The URL to make the request to.
- callback: (responseText: string) => void
  
  The callback to invoke when the request completes
  - - (responseText: string): void
    - Parameters
      - responseText: string
      Returns void
- err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error
  
  The callback to invoke if the request fails
  - - (request: XMLHttpRequest, event: ProgressEvent<EventTarget>): void
    - Parameters
      - request: XMLHttpRequest
      - event: ProgressEvent<EventTarget>
      Returns void
Returns void

httpPost

httpPost(url: string | URL, data: string, callback: (responseText: string) => void, err?: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void): void

- Defined in browser/src/bom/httpPost.ts:26
Makes a POST request to the passed URL.
example
```
const newPost = {
  userId: 1,
  id: 1337,
  title: 'Foo',
  body: 'bar bar bar'
};
const data = JSON.stringify(newPost);
httpPost(
  'https://jsonplaceholder.typicode.com/posts',
  data,
  console.log
);
```
since
0.1.3
Parameters
- url: string | URL
  
  URL to send the request to.
- data: string
  
  Data to send.
- callback: (responseText: string) => void
  
  Callback to invoke when the request completes.
  - - (responseText: string): void
    - Parameters
      - responseText: string
      Returns void
- err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error
  
  Callback to invoke when an error occurs.
  - - (request: XMLHttpRequest, event: ProgressEvent<EventTarget>): void
    - Parameters
      - request: XMLHttpRequest
      - event: ProgressEvent<EventTarget>
      Returns void
Returns void

httpPut

httpPut(url: string | URL, data: string, callback: (request: XMLHttpRequest) => void, err?: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void): void

- Defined in browser/src/bom/httpPut.ts:24
Makes a PUT request to the passed URL.
example
```
const password = 'fooBaz';
const data = JSON.stringify({
  id: 1,
  title: 'foo',
  body: 'bar',
  userId: 1
});
httpPut('https://jsonplaceholder.typicode.com/posts/1', data, request => {
  console.log(request.responseText);
});
```
since
0.1.3
Parameters
- url: string | URL
  
  The URL to make the request to.
- data: string
  
  The data to send as the request body.
- callback: (request: XMLHttpRequest) => void
  
  The callback to invoke when the request completes.
  - - (request: XMLHttpRequest): void
    - Parameters
      - request: XMLHttpRequest
      Returns void
- err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error
  
  The callback to invoke when an error occurs.
  - - (request: XMLHttpRequest, event: ProgressEvent<EventTarget>): void
    - Parameters
      - request: XMLHttpRequest
      - event: ProgressEvent<EventTarget>
      Returns void
Returns void

httpsRedirect

httpsRedirect(): void

- Defined in browser/src/bom/httpsRedirect.ts:12
Redirects the page to HTTPS if it's currently in HTTP.
example
```
httpsRedirect();
// If you are on http://mydomain.com, you are redirected to https://mydomain.
```
since
0.1.3
Returns void

isLocalStorageEnabled

isLocalStorageEnabled(): boolean

- Defined in browser/src/bom/isLocalStorageEnabled.ts:11
Checks if localStorage is enabled.
example
```
isLocalStorageEnabled(); // true, if localStorage is accessible
```
since
0.1.0
Returns boolean

isSessionStorageEnabled

isSessionStorageEnabled(): boolean

- Defined in browser/src/bom/isSessionStorageEnabled.ts:11
Checks if sessionStorage is enabled.
example
```
isSessionStorageEnabled(); // true, if sessionStorage is accessible
```
since
0.1.0
Returns boolean

prefersDarkColorScheme

prefersDarkColorScheme(): boolean

- Defined in browser/src/bom/prefersDarkColorScheme.ts:12
Checks if the user color scheme preference is dark.
example
```
prefersDarkColorScheme(); // true
```
since
0.1.1
Returns boolean
true if the user color scheme preference is dark.

prefersLightColorScheme

prefersLightColorScheme(): boolean

- Defined in browser/src/bom/prefersLightColorScheme.ts:12
Checks if the user color scheme preference is light.
example
```
prefersLightColorScheme(); // true
```
since
0.1.1
Returns boolean
true if the user color scheme preference is light.

redirect

redirect(url: string, asLink?: boolean): void

- Defined in browser/src/bom/redirect.ts:13
Redirects to a specified URL.
example
```
redirect('https://google.com');
```
since
0.1.1
Parameters
- url: string
  
  The URL to redirect to.
- asLink: boolean = true
  
  Whether to attempt to create a link to the URL.
Returns void

runAsync

runAsync(fn: (args?: any) => any): Promise<unknown>

Runs a function in a separate thread by using a Web Worker, allowing long running functions to not block the UI.

example

const longRunningFunction = () => {
  let result = 0;
  for (let i = 0; i < 1000; i++)
    for (let j = 0; j < 700; j++)
      for (let k = 0; k < 300; k++) result = result + i + j + k;

  return result;
};
runAsync(longRunningFunction).then(console.log); // 209685000000
runAsync(() => 10 ** 3).then(console.log); // 1000
let outsideVariable = 50;
runAsync(() => typeof outsideVariable).then(console.log); // 'undefined'

since

0.1.6

Parameters

fn: (args?: any) => any

The function to run.
- - (args?: any): any
  - Parameters
    - Optional args: any
    Returns any

Returns Promise<unknown>

A promise which resolves to the return value of the function.

supportsTouchEvents

supportsTouchEvents(): boolean

- Defined in browser/src/bom/supportsTouchEvents.ts:12
Device supports touch events
example
```
supportsTouchEvents(); // true
```
since
0.1.0
Returns boolean
boolean

Crypto Functions

hashBrowser

hashBrowser(value: string): Promise<string>

- Defined in browser/src/crypto/hashBrowser.ts:16
Creates a hash for a value using the SHA-256 algorithm. Returns a promise.
example
```
hashBrowser(
  JSON.stringify({ a: 'a', b: [1, 2, 3, 4], foo: { c: 'bar' } })
).then(console.log);
// '04aa106279f5977f59f9067fa9712afc4aedc6f5862a8defc34552d8c7206393'
```
since
0.1.0
Parameters
- value: string
  
  The value to hash.
Returns Promise<string>
A promise that resolves to the hash of the value.

DOM Functions

addClass

addClass(el: HTMLElement, className: string): void

- Defined in browser/src/dom/addClass.ts:15
Adds a class to an HTML element.
example
```
addClass(document.querySelector('p'), 'special');
// The paragraph will now have the 'special' class
```
since
0.1.2
Parameters
- el: HTMLElement
  
  The element to add the class to.
- className: string
  
  The class to add.
Returns void
The element with the class added.

addEventListenerAll

addEventListenerAll(targets: EventTarget[], type: string, listener: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

- Defined in browser/src/dom/addEventListenerAll.ts:18
Attaches an event listener to all the provided targets.
example
```
addEventListenerAll(document.querySelectorAll('a'), 'click', () =>
  console.log('Clicked a link')
);
// Logs 'Clicked a link' whenever any anchor element is clicked
```
since
0.1.5
Parameters
- targets: EventTarget[]
  
  The targets to add the event listener to.
- type: string
  
  The type of event.
- listener: null | EventListenerOrEventListenerObject
  
  The listener.
- Optional options: boolean | EventListenerOptions
  
  The options.
Returns void

addMultipleListeners

addMultipleListeners(el: EventTarget, types: string[], listener: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

- Defined in browser/src/dom/addMultipleListeners.ts:19
Adds multiple event listeners with the same handler to an element.
example
```
addMultipleListeners(
  document.querySelector('.my-element'),
  ['click', 'mousedown'],
  () => { console.log('hello!') }
);
```
since
0.1.6
Parameters
- el: EventTarget
  
  Element to add listeners to.
- types: string[]
  
  Types of events to add.
- listener: null | EventListenerOrEventListenerObject
  
  Event listener.
- Optional options: boolean | EventListenerOptions
  
  Event listener options.
Returns void

addStyles

addStyles(el: HTMLElement, styles: Partial<CSSStyleDeclaration>): Partial<CSSStyleDeclaration>

- Defined in browser/src/dom/addStyles.ts:17
Adds the provided styles to the given HTML element.
example
```
addStyles(document.getElementById('my-element'), {
  background: 'red',
  color: '#ffff00',
  fontSize: '3rem'
});
```
since
0.1.3
Parameters
- el: HTMLElement
  
  The element to add styles to.
- styles: Partial<CSSStyleDeclaration>
  
  The styles to add.
Returns Partial<CSSStyleDeclaration>

arrayToHTMLList

arrayToHTMLList(arr: string[], listID: string): void

- Defined in browser/src/dom/arrayToHTMLList.ts:13
Converts the given array elements into <li> tags and appends them to the list of the given id.
example
```
arrayToHTMLList(['item 1', 'item 2'], 'myListID');
```
since
0.1.5
Parameters
- arr: string[]
  
  The array of elements to be converted.
- listID: string
  
  The id of the list to which the elements should be appended.
Returns void

bottomVisible

bottomVisible(): boolean

- Defined in browser/src/dom/bottomVisible.ts:11
Checks if the bottom of the page is visible.
example
```
bottomVisible(); // true
```
since
0.1.0
Returns boolean

copyToClipboard

copyToClipboard(str: string): void

- Defined in browser/src/dom/copyToClipboard.ts:12
Copies a string to the clipboard. Only works as a result of user action (i.e. inside a click event listener).
example
```
copyToClipboard('Lorem ipsum'); // 'Lorem ipsum' copied to clipboard.
```
alpha
since
0.1.5
Parameters
- str: string
  
  The string to copy.
Returns void

createElement

createElement(str: string): null | Element

- Defined in browser/src/dom/createElement.ts:18
Creates an element from a string (without appending it to the document). If the given string contains multiple elements, only the first one will be returned.
example
```
const el = createElement(
  `<div class="container">
    <p>Hello!</p>
  </div>`
);
console.log(el.className); // 'container'
```
since
0.1.1
Parameters
- str: string
  
  The string to create the element from.
Returns null | Element
The created element, only the first one will be returned.

elementContains

elementContains(parent: Element, child: Element): boolean

- Defined in browser/src/dom/elementContains.ts:20
Checks if the parent element contains the child element.
example
```
elementContains(
  document.querySelector('head'),
  document.querySelector('title')
);
// true
elementContains(document.querySelector('body'), document.querySelector('body'));
// false
```
since
0.1.0
Parameters
- parent: Element
  
  The parent element.
- child: Element
  
  The child element.
Returns boolean
true if the parent element contains the child element, otherwise false.

elementIsFocused

elementIsFocused(el: Element): boolean

- Defined in browser/src/dom/elementIsFocused.ts:13
Checks if the given element is focused.
example
```
elementIsFocused(el); // true if the element is focused
```
since
0.1.0
Parameters
- el: Element
  
  Element to check.
Returns boolean
True if the element is focused.

elementIsVisibleInViewport

elementIsVisibleInViewport(el: Element, partiallyVisible?: boolean): boolean

- Defined in browser/src/dom/elementIsVisibleInViewport.ts:16
Checks if the element specified is visible in the viewport.
example
```
// e.g. 100x100 viewport and a 10x10px element at position {top: -1, left: 0, bottom: 9, right: 10}
elementIsVisibleInViewport(el); // false - (not fully visible)
elementIsVisibleInViewport(el, true); // true - (partially visible)
```
since
0.1.0
Parameters
- el: Element
  
  Element to check.
- partiallyVisible: boolean = false
  
  Omit the second argument to determine if the element is entirely visible, or specify true to determine if it is partially visible.
Returns boolean
True if the element is visible in the viewport.

findClosestAnchor

findClosestAnchor(node: Node): null | Node

- Defined in browser/src/dom/findClosestAnchor.ts:13
Finds the anchor node closest to the given node, if any.
example
```
findClosestAnchor(document.querySelector('a > span')); // a
```
since
0.1.2
Parameters
- node: Node
  
  The node to search from.
Returns null | Node
The anchor node if found, or null if not.

findClosestMatchingNode

findClosestMatchingNode(node: Element, selector: string): null | Element

- Defined in browser/src/dom/findClosestMatchingNode.ts:15
Finds the closest matching node starting at the given node.
example
```
findClosestMatchingNode(document.querySelector('span'), 'body'); // body
```
since
0.1.1
Parameters
- node: Element
  
  Starting node
- selector: string
  
  Selector to match
Returns null | Element
Closest node or null

formToObject

formToObject(form: HTMLFormElement): {}

- Defined in browser/src/dom/formToObject.ts:14
Encodes a set of form elements as an object.
example
```
formToObject(document.querySelector('#form'));
// { email: 'test@email.com', name: 'Test Name' }
```
since
0.1.5
Parameters
- form: HTMLFormElement
  
  The form element
Returns {}
An object representing the form values.

fullscreen

fullscreen(mode?: boolean, el?: string): Promise<void>

- Defined in browser/src/dom/fullscreen.ts:14
Opens or closes an element in fullscreen mode.
example
```
fullscreen(); // Opens `body` in fullscreen mode
fullscreen(false); // Exits fullscreen mode
```
since
0.1.0
Parameters
- mode: boolean = true
  
  The mode to open the element in.
- el: string = "body"
  
  The element to open in fullscreen mode.
Returns Promise<void>

getAncestors

getAncestors(el: HTMLElement): HTMLElement[]

- Defined in browser/src/dom/getAncestors.ts:14
Returns all the ancestors of an element from the document root to the given element.
example
```
getAncestors(document.querySelector('nav'));
// [document, html, body, header, nav]
```
since
0.1.3
Parameters
- el: HTMLElement
  
  The element to get the ancestors of.
Returns HTMLElement[]
The ancestors of the element.

getElementsBiggerThanViewport

getElementsBiggerThanViewport(): Element[]

- Defined in browser/src/dom/getElementsBiggerThanViewport.ts:11
Returns an array of HTML elements whose width is larger than that of the viewport's.
example
```
getElementsBiggerThanViewport(); // <div id="ultra-wide-item" />
```
since
0.1.4
Returns Element[]

getImages

getImages(el: HTMLElement, includeDuplicates?: boolean): (null | string)[]

- Defined in browser/src/dom/getImages.ts:15
Fetches all images from within an element and puts them into an array.
example
```
getImages(document, true); // ['image1.jpg', 'image2.png', 'image1.png', '...']
getImages(document, false); // ['image1.jpg', 'image2.png', '...']
```
since
0.1.4
Parameters
- el: HTMLElement
  
  Element to search for images.
- includeDuplicates: boolean = false
  
  Whether to include duplicate images or not.
Returns (null | string)[]
An array of all images in the element.

getParentsUntil

getParentsUntil(el: Node, selector: string): Element[]

- Defined in browser/src/dom/getParentsUntil.ts:15
Finds all the ancestors of an element up until the element matched by the specified selector.
example
```
getParentsUntil(document.querySelector('#home-link'), 'header');
// [header, nav, ul, li]
```
since
0.1.4
Parameters
- el: Node
  
  Element to start from
- selector: string
  
  Stop at this element
Returns Element[]
The matched elements

getScrollPosition

getScrollPosition(el?: Element | Window): { x: number; y: number }

- Defined in browser/src/dom/getScrollPosition.ts:13
Returns the scroll position of the current page.
example
```
getScrollPosition(); // {x: 0, y: 200}
```
since
0.1.2
Parameters
- el: Element | Window = window
  
  Optional element to measure.
Returns { x: number; y: number }
The scroll position of the current page.
- x: number
- y: number

getSiblings

getSiblings(el: Node): Node[]

- Defined in browser/src/dom/getSiblings.ts:13
Returns an array containing all the siblings of the given element.
example
```
getSiblings(document.querySelector('head')); // ['body']
```
since
0.1.5
Parameters
- el: Node
  
  The element to get all the siblings from.
Returns Node[]
An array of all the element's siblings.

getStyle

getStyle(el: HTMLElement, ruleName: "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex"): string

- Defined in browser/src/dom/getStyle.ts:14
Retrieves the value of a CSS rule for the specified element.
example
```
getStyle(document.querySelector('p'), 'fontSize'); // '16px'
```
since
0.1.2
Parameters
- el: HTMLElement
  
  The element to get the style for.
- ruleName: "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex"
  
  The name of the CSS rule.
Returns string
The value of the CSS rule.

getVerticalOffset

getVerticalOffset(el: HTMLElement): number

- Defined in browser/src/dom/getVerticalOffset.ts:13
Finds the distance from a given element to the top of the document.
example
```
getVerticalOffset('.my-element'); // 120
```
since
0.1.1
Parameters
- el: HTMLElement
  
  Element to find the distance from.
Returns number
The distance from the top of the document to the element.

hasClass

hasClass(el: HTMLElement, className: string): boolean

- Defined in browser/src/dom/hasClass.ts:14
Checks if the given element has the specified class.
example
```
hasClass(document.querySelector('p.special'), 'special'); // true
```
since
0.1.3
Parameters
- el: HTMLElement
  
  The element to check.
- className: string
  
  The class to check for.
Returns boolean
true if the element has the class, false otherwise.

hide

hide(...el: HTMLElement[]): void

- Defined in browser/src/dom/hide.ts:12
Hides all the elements specified.
example
```
hide(...document.querySelectorAll('img')); // Hides all <img> elements on the page
```
since
0.1.5
Parameters
- Rest ...el: HTMLElement[]
  
  The elements to hide.
Returns void

injectCSS

injectCSS(css: string): HTMLStyleElement

- Defined in browser/src/dom/injectCSS.ts:14
Injects the given CSS code into the current document
example
```
injectCSS('body { background-color: #000 }');
// '<style>body { background-color: #000 }</style>'
```
since
0.1.2
Parameters
- css: string
  
  The CSS code to inject
Returns HTMLStyleElement
The created style element

insertAfter

insertAfter(el: Element, text: string): void

- Defined in browser/src/dom/insertAfter.ts:15
Inserts an HTML string after the end of the specified element.
example
```
insertAfter(document.getElementById('myId'), '<p>after</p>');
// <div id="myId">...</div><p>after</p>
```
since
0.1.1
Parameters
- el: Element
  
  The element to insert the string after.
- text: string
  
  The HTML string to insert.
Returns void
The element.

insertBefore

insertBefore(el: Element, text: string): void

- Defined in browser/src/dom/insertBefore.ts:15
Inserts an HTML string before the start of the specified element.
example
```
insertBefore(document.getElementById('myId'), '<p>before</p>');
// <p>before</p><div id="myId">...</div>
```
since
0.1.1
Parameters
- el: Element
  
  The element to insert the string before.
- text: string
  
  The HTML string to insert.
Returns void
The element.

isBrowserTabFocused

isBrowserTabFocused(): boolean

- Defined in browser/src/dom/isBrowserTabFocused.ts:12
Checks if the browser tab of the page is focused.
example
```
isBrowserTabFocused(); // true or false
```
since
0.1.0
Returns boolean
True if the browser tab is focused, false otherwise.

listenOnce

listenOnce<K>(el: HTMLElement, evt: K, fn: (this: HTMLElement, evt: HTMLElementEventMap[K]) => any): void
listenOnce<K>(el: Window, evt: K, fn: (this: Window, ev: WindowEventMap[K]) => any): void

- Defined in browser/src/dom/listenOnce.ts:2
Adds an event listener to an element that will only run the callback the first time the event is triggered.
example
```
listenOnce(
  document.getElementById('my-id'),
  'click',
  () => console.log('Hello world')
); // 'Hello world' will only be logged on the first click
```
since
0.1.2
Type parameters
- K: keyof HTMLElementEventMap
Parameters
- el: HTMLElement
  
  The element to add the event listener to.
- evt: K
  
  The event to listen for.
- fn: (this: HTMLElement, evt: HTMLElementEventMap[K]) => any
  
  The callback to run when the event is triggered.
  - - (this: HTMLElement, evt: HTMLElementEventMap[K]): any
    - Parameters
      - this: HTMLElement
      - evt: HTMLElementEventMap[K]
      Returns any
Returns void
- Defined in browser/src/dom/listenOnce.ts:8
Adds an event listener to an element that will only run the callback the first time the event is triggered.
example
```
listenOnce(
  document.getElementById('my-id'),
  'click',
  () => console.log('Hello world')
); // 'Hello world' will only be logged on the first click
```
since
0.1.2
Type parameters
- K: keyof WindowEventMap
Parameters
- el: Window
  
  The element to add the event listener to.
- evt: K
  
  The event to listen for.
- fn: (this: Window, ev: WindowEventMap[K]) => any
  
  The callback to run when the event is triggered.
  - - (this: Window, ev: WindowEventMap[K]): any
    - Parameters
      - this: Window
      - ev: WindowEventMap[K]
      Returns any
Returns void

nodeListToArray

nodeListToArray(nodeList: NodeList): Node[]

- Defined in browser/src/dom/nodeListToArray.ts:14
Converts a NodeList to an array.
example
```
nodeListToArray(document.childNodes); // [ <!DOCTYPE html>, html ]
```
since
0.1.4
Parameters
- nodeList: NodeList
  
  the NodeList to convert
Returns Node[]
an array of Nodes

observeMutations

observeMutations(element: Node, callback: (mutation: MutationRecord) => void, options?: MutationObserverInit): MutationObserver

- Defined in browser/src/dom/observeMutations.ts:18
Creates a new MutationObserver and runs the provided callback for each mutation on the specified element.
example
```
const obs = observeMutations(document, console.log);
// Logs all mutations that happen on the page
obs.disconnect();
// Disconnects the observer and stops logging mutations on the page
```
since
0.1.5
Parameters
- element: Node
  
  Element to observe.
- callback: (mutation: MutationRecord) => void
  
  Callback to run for each mutation.
  - - (mutation: MutationRecord): void
    - Parameters
      - mutation: MutationRecord
      Returns void
- Optional options: MutationObserverInit
  
  Options for the observer.
Returns MutationObserver
The new MutationObserver instance.

off

off<K>(el: HTMLElement, evt: K, handler: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void
off<K>(el: Window, evt: K, handler: (this: Window, ev: WindowEventMap[K]) => any, options?: boolean | EventListenerOptions): void

- Defined in browser/src/dom/off.ts:2
Removes an event listener from an element.
example
```
const fn = () => console.log('!');
document.body.addEventListener('click', fn);
off(document.body, 'click', fn); // no longer logs '!' upon clicking on the page
```
since
0.1.2
Type parameters
- K: keyof HTMLElementEventMap
Parameters
- el: HTMLElement
  
  The element to remove the event listener from.
- evt: K
  
  The event name.
- handler: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
  - - (this: HTMLElement, ev: HTMLElementEventMap[K]): any
    - Parameters
      - this: HTMLElement
      - ev: HTMLElementEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
- Defined in browser/src/dom/off.ts:9
Removes an event listener from an element.
example
```
const fn = () => console.log('!');
document.body.addEventListener('click', fn);
off(document.body, 'click', fn); // no longer logs '!' upon clicking on the page
```
since
0.1.2
Type parameters
- K: keyof WindowEventMap
Parameters
- el: Window
  
  The element to remove the event listener from.
- evt: K
  
  The event name.
- handler: (this: Window, ev: WindowEventMap[K]) => any
  - - (this: Window, ev: WindowEventMap[K]): any
    - Parameters
      - this: Window
      - ev: WindowEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void

on

on<K>(el: HTMLElement, evt: K, fn: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, opts?: { options?: boolean | AddEventListenerOptions; target?: string }): (e: HTMLElementEventMap[K]) => void
on<K>(el: Window, evt: K, fn: (this: Window, ev: WindowEventMap[K]) => any, opts?: { options?: boolean | AddEventListenerOptions; target?: string }): (e: WindowEventMap[K]) => void

- Defined in browser/src/dom/on.ts:2
Adds an event listener to an element with the ability to use event delegation.
example
```
const fn = () => console.log('!');
on(document.body, 'click', fn); // logs '!' upon clicking the body
on(document.body, 'click', fn, { target: 'p' });
// logs '!' upon clicking a `p` element child of the body
on(document.body, 'click', fn, { options: true });
// use capturing instead of bubbling
```
since
0.1.2
Type parameters
- K: keyof HTMLElementEventMap
Parameters
- el: HTMLElement
  
  The element to add the event listener to.
- evt: K
  
  The event to listen for.
- fn: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
  
  The function to run when the event is triggered.
  - - (this: HTMLElement, ev: HTMLElementEventMap[K]): any
    - Parameters
      - this: HTMLElement
      - ev: HTMLElementEventMap[K]
      Returns any
- Optional opts: { options?: boolean | AddEventListenerOptions; target?: string }
  
  The options to use when binding the event listener.
  - Optional options?: boolean | AddEventListenerOptions
  - Optional target?: string
Returns (e: HTMLElementEventMap[K]) => void
The function to remove the event listener from the element.
- - (e: HTMLElementEventMap[K]): void
  - Parameters
    - e: HTMLElementEventMap[K]
    Returns void
- Defined in browser/src/dom/on.ts:12
Adds an event listener to an element with the ability to use event delegation.
example
```
const fn = () => console.log('!');
on(document.body, 'click', fn); // logs '!' upon clicking the body
on(document.body, 'click', fn, { target: 'p' });
// logs '!' upon clicking a `p` element child of the body
on(document.body, 'click', fn, { options: true });
// use capturing instead of bubbling
```
since
0.1.2
Type parameters
- K: keyof WindowEventMap
Parameters
- el: Window
  
  The element to add the event listener to.
- evt: K
  
  The event to listen for.
- fn: (this: Window, ev: WindowEventMap[K]) => any
  
  The function to run when the event is triggered.
  - - (this: Window, ev: WindowEventMap[K]): any
    - Parameters
      - this: Window
      - ev: WindowEventMap[K]
      Returns any
- Optional opts: { options?: boolean | AddEventListenerOptions; target?: string }
  
  The options to use when binding the event listener.
  - Optional options?: boolean | AddEventListenerOptions
  - Optional target?: string
Returns (e: WindowEventMap[K]) => void
The function to remove the event listener from the element.
- - (e: WindowEventMap[K]): void
  - Parameters
    - e: WindowEventMap[K]
    Returns void

onClickOutside

onClickOutside(element: Node, callback: () => void): void

- Defined in browser/src/dom/onClickOutside.ts:14
Runs the callback whenever the user clicks outside of the specified element.
example
```
onClickOutside('#my-element', () => console.log('Hello'));
// Will log 'Hello' whenever the user clicks outside of #my-element
```
since
0.1.3
Parameters
- element: Node
  
  The element to listen to for clicks.
- callback: () => void
  
  The callback to call when the user clicks.
  - - (): void
    - Returns void
Returns void

prefix

prefix(prop: "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex"): null | string

- Defined in browser/src/dom/prefix.ts:14
Prefixes a CSS property based on the current browser.
example
```
prefix('appearance');
// 'appearance' on a supported browser, otherwise 'webkitAppearance', 'mozAppearance', 'msAppearance' or 'oAppearance'
```
alpha
since
0.1.5
Parameters
- prop: "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex"
  
  The unprefixed property name.
Returns null | string
The prefixed property name.

removeClass

removeClass(el: HTMLElement, className: string): void

- Defined in browser/src/dom/removeClass.ts:14
Removes a class from an HTML element.
example
```
removeClass(document.querySelector('p.special'), 'special');
// The paragraph will not have the 'special' class anymore
```
since
0.1.2
Parameters
- el: HTMLElement
  
  The HTML element.
- className: string
  
  The name of the class to remove.
Returns void

removeElement

removeElement(el: Element): Element

- Defined in browser/src/dom/removeElement.ts:14
Removes an element from the DOM.
example
```
removeElement(document.querySelector('#my-element'));
// Removes #my-element from the DOM
```
since
0.1.0
Parameters
- el: Element
  
  The element to remove.
Returns Element
The element that was removed.

removeEventListenerAll

removeEventListenerAll(targets: EventTarget[], type: string, listener: null | EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

- Defined in browser/src/dom/removeEventListenerAll.ts:17
Detaches an event listener from all the provided targets.
example
```
const linkListener = () => console.log('Clicked a link');
document.querySelector('a').addEventListener('click', linkListener);
removeEventListenerAll(document.querySelectorAll('a'), 'click', linkListener);
```
since
0.1.5
Parameters
- targets: EventTarget[]
  
  The targets from which to remove the event listener.
- type: string
  
  The type of event.
- listener: null | EventListenerOrEventListenerObject
  
  The listener.
- Optional options: boolean | EventListenerOptions
  
  The options.
Returns void

renderElement

renderElement(__namedParameters: { props?: Record<string, any>; type?: string }, container: Node): void

- Defined in browser/src/dom/renderElement.ts:24
Renders the given DOM tree in the specified DOM element.
example
```
const myElement = {
  type: 'button',
  props: {
    type: 'button',
    className: 'btn',
    onClick: () => alert('Clicked'),
    children: [{ props: { nodeValue: 'Click me' } }]
  }
};

renderElement(myElement, document.body);
```
since
0.1.6
Parameters
- __namedParameters: { props?: Record<string, any>; type?: string }
  - Optional props?: Record<string, any>
  - Optional type?: string
- container: Node
  
  The DOM element to render into.
Returns void

scrollToTop

scrollToTop(): void

- Defined in browser/src/dom/scrollToTop.ts:11
Smooth-scrolls to the top of the page.
example
```
scrollToTop(); // Smooth-scrolls to the top of the page
```
since
0.1.2
Returns void

serializeForm

serializeForm(form: HTMLFormElement): string

- Defined in browser/src/dom/serializeForm.ts:14
Encodes a set of form elements as a query string.
example
```
serializeForm(document.querySelector('#form'));
// email=test%40email.com&name=Test%20Name
```
since
0.1.6
Parameters
- form: HTMLFormElement
  
  The form elements to serialize.
Returns string
A query string representing the form.

setStyle

setStyle(el: HTMLElement, rule: number | typeof iterator | "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex" | "getPropertyPriority" | "getPropertyValue" | "item" | "removeProperty" | "setProperty", val: null | string): void

- Defined in browser/src/dom/setStyle.ts:15
Sets the value of a CSS rule for the specified HTML element.
example
```
setStyle(document.querySelector('p'), 'fontSize', '20px');
// The first <p> element on the page will have a font-size of 20px
```
since
0.1.1
Parameters
- el: HTMLElement
  
  The element to set the style for.
- rule: number | typeof iterator | "accentColor" | "alignContent" | "alignItems" | "alignSelf" | "alignmentBaseline" | "all" | "animation" | "animationDelay" | "animationDirection" | "animationDuration" | "animationFillMode" | "animationIterationCount" | "animationName" | "animationPlayState" | "animationTimingFunction" | "appearance" | "aspectRatio" | "backfaceVisibility" | "background" | "backgroundAttachment" | "backgroundBlendMode" | "backgroundClip" | "backgroundColor" | "backgroundImage" | "backgroundOrigin" | "backgroundPosition" | "backgroundPositionX" | "backgroundPositionY" | "backgroundRepeat" | "backgroundSize" | "baselineShift" | "blockSize" | "border" | "borderBlock" | "borderBlockColor" | "borderBlockEnd" | "borderBlockEndColor" | "borderBlockEndStyle" | "borderBlockEndWidth" | "borderBlockStart" | "borderBlockStartColor" | "borderBlockStartStyle" | "borderBlockStartWidth" | "borderBlockStyle" | "borderBlockWidth" | "borderBottom" | "borderBottomColor" | "borderBottomLeftRadius" | "borderBottomRightRadius" | "borderBottomStyle" | "borderBottomWidth" | "borderCollapse" | "borderColor" | "borderEndEndRadius" | "borderEndStartRadius" | "borderImage" | "borderImageOutset" | "borderImageRepeat" | "borderImageSlice" | "borderImageSource" | "borderImageWidth" | "borderInline" | "borderInlineColor" | "borderInlineEnd" | "borderInlineEndColor" | "borderInlineEndStyle" | "borderInlineEndWidth" | "borderInlineStart" | "borderInlineStartColor" | "borderInlineStartStyle" | "borderInlineStartWidth" | "borderInlineStyle" | "borderInlineWidth" | "borderLeft" | "borderLeftColor" | "borderLeftStyle" | "borderLeftWidth" | "borderRadius" | "borderRight" | "borderRightColor" | "borderRightStyle" | "borderRightWidth" | "borderSpacing" | "borderStartEndRadius" | "borderStartStartRadius" | "borderStyle" | "borderTop" | "borderTopColor" | "borderTopLeftRadius" | "borderTopRightRadius" | "borderTopStyle" | "borderTopWidth" | "borderWidth" | "bottom" | "boxShadow" | "boxSizing" | "breakAfter" | "breakBefore" | "breakInside" | "captionSide" | "caretColor" | "clear" | "clip" | "clipPath" | "clipRule" | "color" | "colorInterpolation" | "colorInterpolationFilters" | "colorScheme" | "columnCount" | "columnFill" | "columnGap" | "columnRule" | "columnRuleColor" | "columnRuleStyle" | "columnRuleWidth" | "columnSpan" | "columnWidth" | "columns" | "contain" | "content" | "counterIncrement" | "counterReset" | "counterSet" | "cssFloat" | "cssText" | "cursor" | "direction" | "display" | "dominantBaseline" | "emptyCells" | "fill" | "fillOpacity" | "fillRule" | "filter" | "flex" | "flexBasis" | "flexDirection" | "flexFlow" | "flexGrow" | "flexShrink" | "flexWrap" | "float" | "floodColor" | "floodOpacity" | "font" | "fontFamily" | "fontFeatureSettings" | "fontKerning" | "fontOpticalSizing" | "fontSize" | "fontSizeAdjust" | "fontStretch" | "fontStyle" | "fontSynthesis" | "fontVariant" | "fontVariantAlternates" | "fontVariantCaps" | "fontVariantEastAsian" | "fontVariantLigatures" | "fontVariantNumeric" | "fontVariantPosition" | "fontVariationSettings" | "fontWeight" | "gap" | "grid" | "gridArea" | "gridAutoColumns" | "gridAutoFlow" | "gridAutoRows" | "gridColumn" | "gridColumnEnd" | "gridColumnGap" | "gridColumnStart" | "gridGap" | "gridRow" | "gridRowEnd" | "gridRowGap" | "gridRowStart" | "gridTemplate" | "gridTemplateAreas" | "gridTemplateColumns" | "gridTemplateRows" | "height" | "hyphens" | "imageOrientation" | "imageRendering" | "inlineSize" | "inset" | "insetBlock" | "insetBlockEnd" | "insetBlockStart" | "insetInline" | "insetInlineEnd" | "insetInlineStart" | "isolation" | "justifyContent" | "justifyItems" | "justifySelf" | "left" | "letterSpacing" | "lightingColor" | "lineBreak" | "lineHeight" | "listStyle" | "listStyleImage" | "listStylePosition" | "listStyleType" | "margin" | "marginBlock" | "marginBlockEnd" | "marginBlockStart" | "marginBottom" | "marginInline" | "marginInlineEnd" | "marginInlineStart" | "marginLeft" | "marginRight" | "marginTop" | "marker" | "markerEnd" | "markerMid" | "markerStart" | "mask" | "maskType" | "maxBlockSize" | "maxHeight" | "maxInlineSize" | "maxWidth" | "minBlockSize" | "minHeight" | "minInlineSize" | "minWidth" | "mixBlendMode" | "objectFit" | "objectPosition" | "offset" | "offsetAnchor" | "offsetDistance" | "offsetPath" | "offsetRotate" | "opacity" | "order" | "orphans" | "outline" | "outlineColor" | "outlineOffset" | "outlineStyle" | "outlineWidth" | "overflow" | "overflowAnchor" | "overflowWrap" | "overflowX" | "overflowY" | "overscrollBehavior" | "overscrollBehaviorBlock" | "overscrollBehaviorInline" | "overscrollBehaviorX" | "overscrollBehaviorY" | "padding" | "paddingBlock" | "paddingBlockEnd" | "paddingBlockStart" | "paddingBottom" | "paddingInline" | "paddingInlineEnd" | "paddingInlineStart" | "paddingLeft" | "paddingRight" | "paddingTop" | "pageBreakAfter" | "pageBreakBefore" | "pageBreakInside" | "paintOrder" | "perspective" | "perspectiveOrigin" | "placeContent" | "placeItems" | "placeSelf" | "pointerEvents" | "position" | "quotes" | "resize" | "right" | "rotate" | "rowGap" | "rubyPosition" | "scale" | "scrollBehavior" | "scrollMargin" | "scrollMarginBlock" | "scrollMarginBlockEnd" | "scrollMarginBlockStart" | "scrollMarginBottom" | "scrollMarginInline" | "scrollMarginInlineEnd" | "scrollMarginInlineStart" | "scrollMarginLeft" | "scrollMarginRight" | "scrollMarginTop" | "scrollPadding" | "scrollPaddingBlock" | "scrollPaddingBlockEnd" | "scrollPaddingBlockStart" | "scrollPaddingBottom" | "scrollPaddingInline" | "scrollPaddingInlineEnd" | "scrollPaddingInlineStart" | "scrollPaddingLeft" | "scrollPaddingRight" | "scrollPaddingTop" | "scrollSnapAlign" | "scrollSnapStop" | "scrollSnapType" | "scrollbarGutter" | "shapeImageThreshold" | "shapeMargin" | "shapeOutside" | "shapeRendering" | "stopColor" | "stopOpacity" | "stroke" | "strokeDasharray" | "strokeDashoffset" | "strokeLinecap" | "strokeLinejoin" | "strokeMiterlimit" | "strokeOpacity" | "strokeWidth" | "tabSize" | "tableLayout" | "textAlign" | "textAlignLast" | "textAnchor" | "textCombineUpright" | "textDecoration" | "textDecorationColor" | "textDecorationLine" | "textDecorationSkipInk" | "textDecorationStyle" | "textDecorationThickness" | "textEmphasis" | "textEmphasisColor" | "textEmphasisPosition" | "textEmphasisStyle" | "textIndent" | "textOrientation" | "textOverflow" | "textRendering" | "textShadow" | "textTransform" | "textUnderlineOffset" | "textUnderlinePosition" | "top" | "touchAction" | "transform" | "transformBox" | "transformOrigin" | "transformStyle" | "transition" | "transitionDelay" | "transitionDuration" | "transitionProperty" | "transitionTimingFunction" | "translate" | "unicodeBidi" | "userSelect" | "verticalAlign" | "visibility" | "webkitAlignContent" | "webkitAlignItems" | "webkitAlignSelf" | "webkitAnimation" | "webkitAnimationDelay" | "webkitAnimationDirection" | "webkitAnimationDuration" | "webkitAnimationFillMode" | "webkitAnimationIterationCount" | "webkitAnimationName" | "webkitAnimationPlayState" | "webkitAnimationTimingFunction" | "webkitAppearance" | "webkitBackfaceVisibility" | "webkitBackgroundClip" | "webkitBackgroundOrigin" | "webkitBackgroundSize" | "webkitBorderBottomLeftRadius" | "webkitBorderBottomRightRadius" | "webkitBorderRadius" | "webkitBorderTopLeftRadius" | "webkitBorderTopRightRadius" | "webkitBoxAlign" | "webkitBoxFlex" | "webkitBoxOrdinalGroup" | "webkitBoxOrient" | "webkitBoxPack" | "webkitBoxShadow" | "webkitBoxSizing" | "webkitFilter" | "webkitFlex" | "webkitFlexBasis" | "webkitFlexDirection" | "webkitFlexFlow" | "webkitFlexGrow" | "webkitFlexShrink" | "webkitFlexWrap" | "webkitJustifyContent" | "webkitLineClamp" | "webkitMask" | "webkitMaskBoxImage" | "webkitMaskBoxImageOutset" | "webkitMaskBoxImageRepeat" | "webkitMaskBoxImageSlice" | "webkitMaskBoxImageSource" | "webkitMaskBoxImageWidth" | "webkitMaskClip" | "webkitMaskComposite" | "webkitMaskImage" | "webkitMaskOrigin" | "webkitMaskPosition" | "webkitMaskRepeat" | "webkitMaskSize" | "webkitOrder" | "webkitPerspective" | "webkitPerspectiveOrigin" | "webkitTextFillColor" | "webkitTextStroke" | "webkitTextStrokeColor" | "webkitTextStrokeWidth" | "webkitTransform" | "webkitTransformOrigin" | "webkitTransformStyle" | "webkitTransition" | "webkitTransitionDelay" | "webkitTransitionDuration" | "webkitTransitionProperty" | "webkitTransitionTimingFunction" | "webkitUserSelect" | "whiteSpace" | "widows" | "width" | "willChange" | "wordBreak" | "wordSpacing" | "wordWrap" | "writingMode" | "zIndex" | "getPropertyPriority" | "getPropertyValue" | "item" | "removeProperty" | "setProperty"
  
  The name of the CSS rule.
- val: null | string
  
  The value to set the rule to.
Returns void

show

show(...el: HTMLElement[]): void

- Defined in browser/src/dom/show.ts:13
Shows all the elements specified.
example
```
show(...document.querySelectorAll('img'));
// Shows all <img> elements on the page
```
since
0.1.5
Parameters
- Rest ...el: HTMLElement[]
  
  The elements to show.
Returns void

smoothScroll

smoothScroll(element: string): void

- Defined in browser/src/dom/smoothScroll.ts:14
Smoothly scrolls the element on which it's called into the visible area of the browser window.
example
```
smoothScroll('#fooBar'); // scrolls smoothly to the element with the id fooBar
smoothScroll('.fooBar');
// scrolls smoothly to the first element with a class of fooBar
```
since
0.1.1
Parameters
- element: string
  
  The element to scroll into the visible area of the browser window.
Returns void

toggleClass

toggleClass(el: Element, className: string): boolean

- Defined in browser/src/dom/toggleClass.ts:14
Toggles a class for an HTML element.
example
```
toggleClass(document.body, 'active');
```
since
0.1.1
Parameters
- el: Element
  
  The target element.
- className: string
  
  The class to toggle.
Returns boolean
The element.

triggerEvent

triggerEvent<T>(el: Element, eventType: string, detail?: T): boolean

- Defined in browser/src/dom/triggerEvent.ts:16
Triggers a specific event on a given element, optionally passing custom data.
example
```
triggerEvent(document.getElementById('myId'), 'click');
triggerEvent(document.getElementById('myId'), 'click', { username: 'bob' });
```
since
0.1.2
Type parameters
- T
Parameters
- el: Element
  
  Element to trigger the event on.
- eventType: string
  
  Name of the event to trigger.
- Optional detail: T
  
  Optional data to pass as detail to the event.
Returns boolean
true if the event was successfully triggered.

Random Functions

UUIDGeneratorBrowser

UUIDGeneratorBrowser(): string

- Defined in browser/src/random/UUIDGeneratorBrowser.ts:11
Generates a UUID in a browser.
example
```
UUIDGeneratorBrowser(); // '7982fcfe-5721-4632-bede-6000885be57d'
```
since
0.1.0
Returns string

String Functions

byteSize

byteSize(str: string): number

- Defined in browser/src/string/byteSize.ts:21
返回字符串的长度（以字节为单位）
remarks
将给定的字符串转换为 Blob 对象。

使用 Blob.size 获取字符串的长度（以字节为单位）

example
```
 byteSize('你好') // 6
```
since
0.1.0
Parameters
- str: string
  
  要计算的字符串
Returns number
字符串的长度（以字节为单位）

toCurrency

toCurrency(n: number, currency: string, LanguageFormat?: string): string

Takes a number and returns it in the specified currency formatting.

example

toCurrency(123456.789, 'EUR');
// €123,456.79  | currency: Euro | currencyLangFormat: Local
toCurrency(123456.789, 'USD', 'en-us');
// $123,456.79  | currency: US Dollar | currencyLangFormat: English (United States)
toCurrency(123456.789, 'USD', 'fa');
// ۱۲۳٬۴۵۶٫۷۹ ؜$ | currency: US Dollar | currencyLangFormat: Farsi
toCurrency(322342436423.2435, 'JPY');
// ¥322,342,436,423 | currency: Japanese Yen | currencyLangFormat: Local
toCurrency(322342436423.2435, 'JPY', 'fi');
// 322 342 436 423 ¥ | currency: Japanese Yen | currencyLangFormat: Finnish

since

0.1.0

Parameters

n: number

the number to format
currency: string

the currency to use
Optional LanguageFormat: string

the language format to use

Returns string

the formatted currency string

Index

Functions BOM

Functions Crypto

Functions DOM

Functions Random

Functions String

BOM Functions

copyToClipboardAsync

Parameters

str: string

Returns Promise<void>

currentURL

Returns string

detectDeviceType

Returns "Mobile" | "Desktop"

detectLanguage

Parameters

defaultLang: string = "US"

Returns string

getProtocol

Returns string

getSelectedText

Returns undefined | string

getURLParameters

Parameters

url: string

Returns {}

[key: string]: string

httpDelete

Parameters

url: string | URL

callback: (request: XMLHttpRequest) => void

Parameters

request: XMLHttpRequest

Returns void

err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error

Parameters

request: XMLHttpRequest

event: ProgressEvent<EventTarget>

Returns void

Returns void

httpGet

Parameters

url: string | URL

callback: (responseText: string) => void

Parameters

responseText: string

Returns void

err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error

Parameters

request: XMLHttpRequest

event: ProgressEvent<EventTarget>

Returns void

Returns void

httpPost

Parameters

url: string | URL

data: string

callback: (responseText: string) => void

Parameters

responseText: string

Returns void

err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error

Parameters

request: XMLHttpRequest

event: ProgressEvent<EventTarget>

Returns void

Returns void

httpPut

Parameters

url: string | URL

data: string

callback: (request: XMLHttpRequest) => void

Parameters

request: XMLHttpRequest

Returns void

err: (request: XMLHttpRequest, event: ProgressEvent<EventTarget>) => void = console.error

Parameters

request: XMLHttpRequest

event: ProgressEvent<EventTarget>