ngx-auth-img
v1.0.1
Published
Angular directive to automatically attach authentication to img requests made from your templates.
Maintainers
Readme
NGX-Auth-Img
Is an Angular attribute directive. It can do the following things for you:
- Automatically append authorization information to each img request made from your templates
- Show a fallback in case the asset is not available
- Load a thumbnail first
- Blur the thumbnail and unblur it once the request for the full-image succeeded
Setup
- Run
npm i --save ngx-auth-img - Import
NgxAuthImgModule - Create your config token, which implements
AuthImgConfigInterfaceand add it to your module's providers array e.g.:
{
provide: AUTH_IMG_CONFIG_TOKEN,
useValue: authImgConfig
}- Add the selector to any img tag such as:
<img ngxAuthImg [src]="https://example.com/asset.png">- You can override a fallback source as attribute
fallbackSrcorthumbnailOnlyfor each usage
Configure
The directive takes a configuration with the following properties according to AuthImgConfigInterface:
tokenName: string - Name of the authentication token in your local storagetokenQueryName: string - The query parameter appended to each requestthumbnailQueryName: string - The query parameter used to request a thumbnaildefaultThumbnail: boolean - Wether the full image or only the thumbnail should be requesteddefaultFallbackSrc: string - The source used if the request failed and nofallbackSrcattribute is set on the img element.
