/webcomponents/lazy-img/README.md

https://github.com/fluster/deckdeckgo · Markdown · 28 lines · 17 code · 11 blank · 0 comment · 0 complexity · d74b5943bb7783f60dc05ffca2b3d949 MD5 · raw file 

    

  1. [![npm][npm-badge]][npm-badge-url]
    2. 

  2. [![license][npm-license]][npm-license-url]
    3. 

  3. 

  4. [npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/lazy-img
    5. 

  5. [npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/lazy-img
    6. 

  6. [npm-license]: https://img.shields.io/npm/l/@deckdeckgo/lazy-img
    7. 

  7. [npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/main/webcomponents/lazy-img/LICENSE
    8. 

  8. 

  9. # DeckDeckGo - A dead simple Web Component to lazy load images
    10. 

  10. 

  11. This Web Component is a dead simple component to lazy load images which was developed for the project [DeckDeckGo].
    12. 

  12. 

  13. It leverages the IntersectionObserver API to lazy load images and also allows you to trigger "manually" their loading.
    14. 

  14. 

  15. ## Table of contents
    16. 

  16. 

  17. - [Getting Started](#getting-started)
    18. 

  18. - [License](#license)
    19. 

  19. 

  20. ## Getting Started
    21. 

  21. 

  22. To get started with this Web Component, have a look to its [documentation](https://docs.deckdeckgo.com/?path=/story/components-lazy-image--lazy-image).
    23. 

  23. 

  24. ## License
    25. 

  25. 

  26. MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com)
    27. 

  27. 

  28. [deckdeckgo]: https://deckdeckgo.com
    29.