Socket
Book a DemoInstallSign in
Socket

app-img

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

app-img

a lazy image loading custom element for considerate user experiences

latest
Source
npmnpm
Version
1.0.0
Version published
Maintainers
1
Created
Source

Features

  • Waits to start loading until the image is in view
  • Neat custom properties api for modifying presentation layer
  • Fade in animation
  • No dependencies
  • Ready for avatars to galleries

note: this custom element doesn't provide any polyfills

Get Started

  • npm i app-img
  • load the web component in your HTML, perhaps via JS like this import 'app-img.element'

Intended Usage / API

<app-img src='...'></app-img>
<app-img src='...' viewport='#scrollcontainer'></app-img>
<app-img src='...' no-shadow></app-img>
<app-img src='...' style='--fade-speed:0'></app-img>
<app-img src='...' style='--fit:none'></app-img>
<app-img src='...' style='--loading-bg:black;--loading-text_color:white;'></app-img>
$('app-img').addEventListener('loaded', ({target}) => 
  console.log(target))

Changing Presentation

Change the custom property values on the <app-img> node.

--loading-bg: any|css|color|type; 
/* default: hsl(0,0%,85%) */

--loading-text_color: hex|hsl|rgb|etc;
/* default: hsl(0,0%,70%) */

--fit: fill|contain|cover|none|scale-down;
/* default: cover */

--position: left|top|50%|20px|etc; 
/* default: initial */

--fade-speed: s|ms; 
/* default: 0.5s */

Changing Behavior

<!-- opt out of shadowDOM -->
<app-img no-shadow></app-img>

<!-- opt out of animation -->
<app-img style='--fade-speed:0;'></app-img>

<!-- 
  when you need to specify the observed scroll container 
  pass a querySelector string into the attribute
-->
<app-img viewport='#scrollview'></app-img>

FAQs

Package last updated on 14 Feb 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.