ngx-webp-polyfill v0.0.5
Angular Webp Polyfill
A Webp polyfill for Angular, using webp-hero
. This module applies to polyfill as Angular Pipes/Directives for:
1. Image elements
2. Elements with a background-image
style
You can view a demo here.
Installation
NPM
npm install --save ngx-webp-polyfill webp-hero p-queue
Yarn
yarn add ngx-webp-polyfill webp-hero p-queue
To allow the polyfill to be applied to images one-at-a-time (as enforced by webp-hero
) we use p-queue
to queue the decoding.
Usage
NgxWebpPolyfillModule.forRoot(options?: WebpPolyfillOptions)
Import NgxWebpPolyfillModule.forRoot(options?: WebpPolyfillOptions)
into AppModule
.
WebpPolyfillOptions
applyPolyfill: (url: string) => boolean
(defaults to true) to conditionally apply the polyfill conditionally i.e. for specific browsers
import { NgxWebpPolyfillModule } from 'ngx-webp-polyfill';
export function webpPolyfillOptions(url: string) {
return true;
}
@NgModule({
imports: [
NgxWebpPolyfillModule.forRoot({
applyPolyfill: webpPolyfillOptions
})
]
})
export class AppModule { }
NgxWebpPolyfillModule.forChild()
Import NgxWebpPolyfillModule.forChild()
into your application child modules, where needed.
import { NgxWebpPolyfillModule } from 'ngx-webp-polyfill';
@NgModule({
imports: [
NgxWebpPolyfillModule.forChild()
]
})
export class MyFeatureModule { }
Template example
Apply the polyfill directives in your template with the following options.
Pipes
The pipes perform asynchronous logic; they return Observable<string>
and need to be applied in combination with the async
pipe.
webpImage
<img *ngIf="myImageUrl | webpImage | async as imagePipeTransform"
[src]="imagePipeTransform"
alt="My Image"
class="thumbnail"/>
Note: The use of *ngIf
is required here as the async
pipe will emit null
as an initial value.
webpBackground
<div [style.background-image]="'url(' + myImageUrl + ')' | webpBackground | async"
style="width: 200px; height: 200px"></div>
Directives
These directives are a less desirable options to their equivalent pipe.
twWebpImage
<img [twWebpImage]="myImageUrl" class="photo" [src]="myImageUrl" alt="My Image"/>
twWebpBackground
<div [twWebpBackground]="myImageUrl" style="width: 200px; height: 200px"></div>
Contributing
Fork and send us a pull request. Consider discussing the change with us before committing the code. The library follows semantic versioning principles, which is automated using conventional commit messages.
To use the interactive CLI when committing:
$ git add <file/s to commit>
$ yarn commit
Or use your IDE, commits messages are linted!
Release
These instructions are for maintainers of this library, to release a new version:
Package
- Generate new version and tag with
yarn release && git push --follow-tags origin master
- Builds and package the library
yarn package:library
- Publish the library to NPM
cd dist/ngx-webp-polyfill && npm publish
Demo
- To build the demo run
yarn build
3 years ago
4 years ago
5 years ago
5 years ago
5 years ago
5 years ago
5 years ago