https://github.com/jgw96/lazy-iframe

Lazy load iframes using web components! #usetheplatform
https://github.com/jgw96/lazy-iframe

Last synced: about 15 hours ago
JSON representation

Lazy load iframes using web components! #usetheplatform

• Host: GitHub
• URL: https://github.com/jgw96/lazy-iframe
• Owner: jgw96
• License: mit
• Created: 2017-10-04T18:55:38.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-10-04T19:06:28.000Z (about 7 years ago)
• Last Synced: 2024-05-02T02:08:22.747Z (6 months ago)
• Language: JavaScript
• Size: 152 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-stenciljs - Lazy Iframe

README

        
![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

# lazy-iframe

lazy-iframe is a web component built with stencil that lets you lazy load iframes as the user scrolls over them. It uses the [intersectionObserver](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) to achieve this functionality. This can be handy for embedding youtube videos, ads that work through an iframe etc.

## API

- src(string): the src of the asset you want to load in the iframe

- title(string): the title for the iframe

## Styling

lazy-iframe exposes two css variables to enable easy styling of the iframe. Here is a usage example:

```

// in your apps css

:root {

  --iframe-width: 100px;

  --iframe-height: 100px;

}

```

### Usage

```

 

```

### Script tag

- [Publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages)

- Put a this script tag `` in the head of your index.html

- Then you can use the element anywhere in your template, JSX, html etc

### Node Modules

- Run `npm install my-name --save`

- Put a script tag similar to this `