# @mvsde/iframe-click-to-play

> Some ``s might save cookies or do other kinds of tracking. This isn't allowed under GDPR law without prior consent from the user. A “click-to-play” solution helps with this situation.

Latest version **0.4.0** (published 2020-09-28) · Hippocratic-2.1 license · 0 weekly downloads

## Install

```sh
npm install @mvsde/iframe-click-to-play
pnpm add @mvsde/iframe-click-to-play
yarn add @mvsde/iframe-click-to-play
bun add @mvsde/iframe-click-to-play
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.0 |
| Published | 2020-09-28 |
| First published | 2020-03-27 |
| Weekly downloads | 0 |
| License | Hippocratic-2.1 |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 26.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Fynn Becker |
| Maintainers | mvsde |

## Links

- npm: https://www.npmjs.com/package/@mvsde/iframe-click-to-play
- Repository: https://github.com/mvsde/iframe-click-to-play
- Issues: https://github.com/mvsde/iframe-click-to-play/issues
- npm.io page: https://npm.io/package/@mvsde/iframe-click-to-play

## Recent versions

- 0.4.0 (latest) — 2020-09-28
- 0.3.0 — 2020-08-11
- 0.2.0 — 2020-08-10
- 0.1.2 — 2020-03-27
- 0.1.1 — 2020-03-27
- 0.1.0 — 2020-03-27

## README

# iframe Click-to-Play

Some `<iframe>`s might save cookies or do other kinds of tracking. This isn't allowed under GDPR law without prior consent from the user. A “click-to-play” solution helps with this situation.

[Demos →](https://iframe-click-to-play.fynn.be)

## Installation

```bash
npm install @mvsde/iframe-click-to-play
```

## Usage

### Markup

Rename the `src` attribute of the `<iframe>` to `data-src` This makes sure no external content gets loaded without prior consent. A fallback element is required which may have arbitrary content. The trigger button can be part of the fallback element, but doesn’t need to be.

#### Standalone `<iframe>`

[Demo for the standalone variant →](https://iframe-click-to-play.fynn.be/standalone.html)

```html
<iframe
  class="iframe"
  data-src="https://www.youtube.com/embed/OrxmtDw4pVI"
  width="960"
  height="540"
></iframe>

<div class="fallback">
  <h2>YouTube Video Embed</h2>
  <p>Click to load the embedded YouTube video.</p>
  <button class="trigger">Load video</button>
</div>
```

#### `<iframe>` within a container

[Demo for the container variant →](https://iframe-click-to-play.fynn.be/container.html)

The `<iframe>` can be nested inside a container. The script automatically searches for the first descendant `<iframe>`.

```html
<div class="iframe">
  <iframe
    class="iframe"
    data-src="https://www.youtube.com/embed/OrxmtDw4pVI"
    width="960"
    height="540"
  ></iframe>
</div>

<div class="fallback">
  <h2>YouTube Video Embed</h2>
  <p>Click to load the embedded YouTube video.</p>
  <button class="trigger">Load video</button>
</div>
```

### JavaScript

Select the `<iframe>` or the element containing it, the fallback element, and the trigger button. Create a new `IframeClickToPlay` instance.

```js
import { IframeClickToPlay } from '@mvsde/iframe-click-to-play'

const iframe = document.querySelector('.iframe')
const fallback = document.querySelector('.fallback')
const trigger = document.querySelector('.trigger')

new IframeClickToPlay({ iframe, fallback, trigger }).init()
```

---
_Source: https://npm.io/package/@mvsde/iframe-click-to-play · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._