https://github.com/bezborodow/element-loaded-by-id

Promise for when an element matching an ID is loaded into the DOM.
https://github.com/bezborodow/element-loaded-by-id

Last synced: 18 days ago
JSON representation

Promise for when an element matching an ID is loaded into the DOM.

• Host: GitHub
• URL: https://github.com/bezborodow/element-loaded-by-id
• Owner: bezborodow
• License: bsd-3-clause
• Created: 2023-05-29T11:12:26.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-25T20:40:37.000Z (9 months ago)
• Last Synced: 2024-04-28T14:22:55.529Z (7 months ago)
• Language: JavaScript
• Homepage: https://npmjs.com/package/element-loaded-by-id
• Size: 12.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `elementLoadedById()`

**[`elementLoadedById()`](https://www.npmjs.com/package/element-loaded-by-id)**:

>  Detect when an [element](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement)

matching an [ID](https://developer.mozilla.org/en-US/docs/Web/API/Element/id)

is loaded into the [DOM](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model).

## Synopsis

```javascript

import elementLoadedById from 'element-loaded-by-id';

elementLoadedById(id).then(element => {

    // Do something...

});

```

### Installation

```console

npm i element-loaded-by-id

```

## Example

See [example](https://bezborodow.github.io/element-loaded-by-id/examples/loaded.html).

## Syntax

```javascript

elementLoadedById(id)

```

### Parameters

**`id`**: A unique ID for the element.

### Return Value

A [`Promise`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) that is:

 * **Already fulfilled**, if the element is found already loaded into the

   [document](https://developer.mozilla.org/en-US/docs/Web/API/Window/document).

 * **Already rejected**, if the element was not found and the DOM has already

   [finished

   loading](https://developer.mozilla.org/en-US/docs/Web/API/Document/readyState).

 * **Asynchronously fulfilled**, when a

   [mutation](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver)

   occurs that adds the element into the DOM.

 * **Asynchronously rejected**, when the DOM has [finished

   loading](https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event)

   and the element has not been found.

## Description

`elementLoadedById()` will search the document for the element by ID.

It will continue searching until the DOM has finished loading ([`DOMContentLoaded`

event](https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event)).

See also:

  * [`elementLoaded()`](https://github.com/bezborodow/element-loaded)