# class-references

> Add or remove a class using reference counting

Latest version **0.1.0** (published 2018-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install class-references
pnpm add class-references
yarn add class-references
bun add class-references
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-08-25 |
| First published | 2018-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 20.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Simon Andrews |
| Maintainers | simon360 |

## Links

- npm: https://www.npmjs.com/package/class-references
- npm.io page: https://npm.io/package/class-references

## Recent versions

- 0.1.0 (latest) — 2018-08-25
- 0.0.4 — 2018-08-25
- 0.0.3 — 2018-08-25
- 0.0.2 — 2018-08-25
- 0.0.1 — 2018-08-24

## README

# `class-references`

> A framework-agnostic library for managing multiple references to class names.

For more details, see the [main README file](https://github.com/simon360/class-references/blob/master/README.md).

## Installation

Using npm:

```
npm install --save class-references
```

Using yarn:

```
yarn add class-references
```

## Usage

Any time you want to add a class (eg. `MyClassName`) to an element (eg. `document.body`), use:

```js
import { requestTokenForClass } from "class-references";

const token = requestTokenForClass(document.body, "MyClassName");
```

When you're ready to remove the class, make sure you can recall the token, and use:

```js
import { releaseToken } from "class-references";

releaseToken(document.body, token);
```

### Advanced examples

```js
import { releaseToken, requestTokenForClass } from "class-references";

const className = "u-preventScroll";
const element = document.body;

const token1 = requestTokenForClass(element, className); // Class is added
const token2 = requestTokenForClass(element, className); // Class was already added, but another token reserves it.

releaseToken(element, token1); // token1 is released; token2 not released, class remains
releaseToken(element, token2); // both tokens are released, class removed
```

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