# dom-element-getter-helpers

> Helpers for creating or retrieving dom element containers for single-spa applications

Latest version **2.1.0** (published 2025-08-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install dom-element-getter-helpers
pnpm add dom-element-getter-helpers
yarn add dom-element-getter-helpers
bun add dom-element-getter-helpers
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2025-08-19 |
| First published | 2021-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jolyn Denning |
| Maintainers | joeldenning, jolyndenning |

## Links

- npm: https://www.npmjs.com/package/dom-element-getter-helpers
- Repository: https://github.com/single-spa/dom-element-getter-helpers
- Homepage: https://github.com/single-spa/dom-element-getter-helpers#readme
- Issues: https://github.com/single-spa/dom-element-getter-helpers/issues
- npm.io page: https://npm.io/package/dom-element-getter-helpers

## Dependencies (1)

- [single-spa](https://npm.io/package/single-spa.md) ^7.0.0-beta.9

## Recent versions

- 2.1.0 (latest) — 2025-08-19
- 2.0.3 — 2025-04-18
- 2.0.2 — 2025-04-01
- 2.0.1 — 2025-03-05
- 2.0.0 — 2025-03-04
- 1.1.1 — 2021-09-23
- 1.1.0 — 2021-09-21
- 1.0.0 — 2021-09-21

## README

# dom-element-getter-helpers

An npm package used internally by single-spa framework helpers to determine where to mount a single-spa application or parcel.

## Installation

```sh
npm install --save dom-element-getter-helpers

yarn add --dev dom-element-getter-helpers

pnpm install --save-dev dom-element-getter-helpers
```

## Usage

### chooseDomElementGetter(opts, props)

This accepts an options object and the single-spa props for an application or parcel. The options object can have a `domElementGetter` property on it. The props can have a `domElement` or `domElementGetter` property on it. If none of those properties are provided, a default dom element getter is used, which creates a div that is appended to `<body>`.

This function returns a function that returns an HTMLElement container for the single-spa application or parcel. Note that the single-spa props will automatically be passed to the domElementGetter function.

```js
import { chooseDomElementGetter } from "dom-element-getter-helpers";

const opts = {
  domElementGetter() {
    return document.getElementById("1");
  },
};

const props = {
  domElement: document.getElementById("2"),
  domElementGetter: document.getElementById("3"),
};

const domElementGetter = chooseDomElementGetter(opts, props);
const domElement = domElementGetter();
```

---
_Source: https://npm.io/package/dom-element-getter-helpers · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._