![\"Downloads](\"https://img.shields.io/npm/dm/@nativescript-community/ui-image.svg\")
\r\n![\"NPM](\"https://img.shields.io/npm/v/@nativescript-community/ui-image.svg\")
\n\t\n\t\t\r\n\n\t
\n Advanced and efficient image display plugin which uses Glide (Android) and SDWebImage (iOS) to implement caching, placeholders, image effects, and much more.\n \n
\n\n![](\"https://github.com/nativescript-community/ui-image/raw/master/images/demo-ios.gif\")
| ![](\"https://github.com/nativescript-community/ui-image/raw/master/images/demo-android.gif\")
|\n| --- | ----------- |\n| iOS Demo | Android Demo |\n\n\r\n[](#table-of-contents)\r\n\r\n## Table of Contents\n\n* [Installation](#installation)\r\n* [setup](#setup)\r\n* [API](#api)\r\n\t* [Events](#events)\r\n\t\t* [Event arguments](#event-arguments)\r\n\t* [Properties](#properties)\r\n\t* [Advanced *optional* attributes](#advanced-optional-attributes)\r\n\t* [Cache](#cache)\r\n\t\t* ['Refresh' the 'src'](#refresh-the-src)\r\n\t\t* [Clear everything from the cache](#clear-everything-from-the-cache)\r\n\t\t* [Evict all images with a specific URI from the cache](#evict-all-images-with-a-specific-uri-from-the-cache)\r\n\t\t* [Manually shut down the native imageModule library](#manually-shut-down-the-native-imagemodule-library)\r\n* [Flavors](#flavors)\r\n* [Demos](#demos)\r\n* [Demos and Development](#demos-and-development)\r\n\t* [Repo Setup](#repo-setup)\r\n\t* [Build](#build)\r\n\t* [Demos](#demos-1)\r\n* [Contributing](#contributing)\r\n\t* [Update repo ](#update-repo-)\r\n\t* [Update readme ](#update-readme-)\r\n\t* [Update doc ](#update-doc-)\r\n\t* [Publish](#publish)\r\n\t* [modifying submodules](#modifying-submodules)\r\n* [Questions](#questions)\n\n\r\n[](#installation)\r\n\r\n## Installation\nRun the following command from the root of your project:\n\n`ns plugin add @nativescript-community/ui-image`\n\n\r\n[](#setup)\r\n\r\n## setup\n\n```javascript\nimport imageModule = require(\"@nativescript-community/ui-image\");\n\n//do this before creating any image view\nimageModule.initialize();\n```\n\n\r\n[](#api)\r\n\r\n## API\n\n### Events\n\n **finalImageSet** - arguments *FinalEventData*\n\nThis event is fired after the final image has been set. When working with animated images you could use this event to start the animation by calling the *FinalEventData.animatable.start()* function.\n\n```xml\n<@nativescript-community/ui-image:Img finalImageSet=\"onFinalImageSet\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction onFinalImageSet(args) {\n var imageModuleEventData = args;\n var img = imageModuleEventData.object;\n}\nexports.onFinalImageSet = onFinalImageSet;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, FinalEventData } from \"@nativescript-community/ui-image\";\n\nexport function onFinalImageSet(args: FinalEventData) {\n var img = args.object as Img;\n}\n```\n\n- **failure** - arguments *FailureEventData*\n\nThis event is fired after the fetch of the final image failed.\n\n```xml\n<@nativescript-community/ui-image:Img failure=\"onFailure\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction onFailure(args) {\n var img = args.object;\n}\nexports.onFailure = onFailure;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, FailureEventData } from \"@nativescript-community/ui-image\";\n\nexport function onFailure(args: FailureEventData) {\n var img = args.object as Img;\n}\n```\n\n- **intermediateImageSet** - arguments *IntermediateEventData* (Android only)\n\nThis event is fired after any intermediate image has been set.\n\n```xml\n<@nativescript-community/ui-image:Img intermediateImageSet=\"onIntermediateImageSet\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction onIntermediateImageSet(args) {\n var img = args.object;\n}\nexports.onIntermediateImageSet = onIntermediateImageSet;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, IntermediateEventData } from \"@nativescript-community/ui-image\";\n\nexport function onIntermediateImageSet(args: IntermediateEventData) {\n var img = args.object as Img;\n}\n```\n\n- **intermediateImageFailed** - arguments *FailureEventData* (Android only)\n\nThis event is fired after the fetch of the intermediate image failed.\n\n```xml\n<@nativescript-community/ui-image:Img intermediateImageFailed=\"onIntermediateImageFailed\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction intermediateImageFailed(args) {\n var img = args.object;\n}\nexports.intermediateImageFailed = intermediateImageFailed;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, FailureEventData } from \"@nativescript-community/ui-image\";\n\nexport function intermediateImageFailed(args: FailureEventData) {\n var img = args.object as Img;\n}\n```\n\n- **submit** - arguments *EventData* (Android only)\n\nThis event is fired before the image request is submitted.\n\n```xml\n<@nativescript-community/ui-image:Img submit=\"onSubmit\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction onSubmit(args) {\n var img = args.object;\n}\nexports.onSubmit = onSubmit;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, EventData } from \"@nativescript-community/ui-image\";\n\nexport function onSubmit(args: EventData) {\n var img = args.object as Img;\n}\n```\n\n- **release** - arguments *EventData* (Android only)\n\nThis event is fired after the controller released the fetched image.\n\n```xml\n<@nativescript-community/ui-image:Img release=\"onRelease\"/>\n```\n\nJavaScript:\n\n```javascript\nfunction onRelease(args) {\n var img = args.object;\n}\nexports.onRelease = onRelease;\n```\n\nTypeScript:\n\n```typescript\nimport {Img, EventData } from \"@nativescript-community/ui-image\";\n\nexport function onRelease(args: EventData) {\n var img = args.object as Img;\n}\n```\n\n#### Event arguments\n\nInstances of this class are provided to the handlers of the *finalImageSet*.\n\n```typescript\nimport {Img, FinalEventData, ImageInfo, AnimatedImage } from \"@nativescript-community/ui-image\";\n\nexport function onFinalImageSet(args: FinalEventData) {\n var info: ImageInfo = args.imageInfo;\n var animatable: AnimatedImage = args.animatable;\n var quality: number = info.getQualityInfo().getQuality();\n var isFullQuality: boolean = info.getQualityInfo().isOfFullQuality();\n var isOfGoodEnoughQuality: boolean = info.getQualityInfo().isOfGoodEnoughQuality();\n}\n```\n\n- **FailureEventData**\n\nInstances of this class are provided to the handlers of the *failure* and *intermediateImageFailed*.\n\n```typescript\nimport {Img, FailureEventData, imageModuleError } from \"@nativescript-community/ui-image\";\n\nexport function onFailure(args: FailureEventData) {\n var error: imageModuleError = args.error;\n var message: string = error.getMessage();\n var type: string = error.getErrorType();\n var fullError: string = error.toString();\n}\n```\n\n- **IntermediateEventData**\n\nInstances of this class are provided to the handlers of the *intermediateImageSet*.\n\n```typescript\nimport {Img, IntermediateEventData, ImageInfo } from \"@nativescript-community/ui-image\";\n\nexport function onIntermediateImageSet(args: IntermediateEventData) {\n var info: ImageInfo = args.imageInfo;\n var quality: number = info.getQualityInfo().getQuality();\n var isFullQuality: boolean = info.getQualityInfo().isOfFullQuality();\n var isOfGoodEnoughQuality: boolean = info.getQualityInfo().isOfGoodEnoughQuality();}\n```\n\n- **EventData**\n\nInstances of this class are provided to the handlers of the *release* and *submit*.\n\n```typescript\nimport {Img, EventData } from \"@nativescript-community/ui-image\";\n\nexport function onSubmit(args: EventData) {\n var img = args.object as Img;\n}\n```\n\n\n### Properties\n\n- **src** \n\nString value used for the image URI. You can use this property to set the image to be loaded from remote location (http, https), from the resources and local files of your {N} application.\n\n```xml\n<@nativescript-community/ui-image:Img src=\"https://docs.nativescript.org/angular/img/cli-getting-started/angular/chapter0/NativeScript_logo.png\"/>\n```\n\n- **placeholderImageUri** \n\nString value used for the placeholder image URI. You can use this property to set a placeholder image loaded from the local and resources files of your {N} application.\n\n**Note: Currently there are limitations on how many different Images can be set to as 'placeholderImage' before OutOfMemoryError is thrown. For best results its recommended to use a single image for all ```placeholderImageUri``` of your Img instances.*\n\n```xml\n<@nativescript-community/ui-image:Img placeholderImageUri=\"~/placeholder.jpg\"/>\n```\n\n- **failureImageUri** \n\nString value used for the failure image URI. You can use this property to set a failure image loaded from the local and resources files of your {N} application that will be shown if the loading of the src is not successful.\n\n```xml\n<@nativescript-community/ui-image:Img failureImageUri=\"~/failure.jpg\"/>\n```\n\n\n### Advanced *optional* attributes\n\nThere are a couple of *optional* attributes that could be set on the Img instance to achieve advanced behaviors:\n\n- **backgroundUri** (Android only)\n\nString value used for the background image URI. Using this property has similar effect as the placeholderImageUri but the image is stretched to the size of the Img.\n\n**Note: Currently there are limitations on how many different Images can be set to as 'background' before OutOfMemoryError is thrown. For best results its recommended to use a single image for all ```backgroundUri``` of your Img instances.*\n\n```xml\n<@nativescript-community/ui-image:Img backgroundUri=\"~/image.jpg\"/>\n```\n\n- **stretch** \n\nString value used by Img image scale type. This property can be set to:\n\n'*center*' - Performs no scaling.\n\n'*centerCrop*' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.\n\n'*centerInside*' - Scales the child so that it fits entirely inside the parent.\n\n'*fitCenter*' - Scales the child so that it fits entirely inside the parent.\n\n'*aspectFit*' - Scales the child so that it fits entirely inside the parent.\n\n'*fitStart*' - Scales the child so that it fits entirely inside the parent.\n\n'*fitEnd*' - Scales the child so that it fits entirely inside the parent.\n\n'*fitXY*' - Scales width and height independently, so that the child matches the parent exactly.\n\n'*fill*' - Scales width and height independently, so that the child matches the parent exactly.\n\n'*focusCrop*' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.\n\n'*aspectFill*' - Scales the child so that both dimensions will be greater than or equal to the corresponding dimension of the parent.\n\n\n```xml\n<@nativescript-community/ui-image:Img stretch=\"centerInside\"/>\n```\n\n- **fadeDuration** \n\nNumber value used for the fade-in duration. This value is in milliseconds.\n\n```xml\n<@nativescript-community/ui-image:Img fadeDuration=\"3000\"/>\n```\n\n- **blurRadius** \n\nNumber value greater than zero, used as input for the blur function. Larger value means slower processing. For example a value of `10` means that each pixel in the image will be blurred using all adjacent pixels up to a distance of 10.\n\n```xml\n<@nativescript-community/ui-image:Img blurRadius=\"25\"/>\n```\n\n- **blurDownSampling** (Android only)\n\nNumber value greater than zero, used to scale the image before applying the blur function. Larger value means faster processing. For example a value of `2` means that the image will be scaled by a factor of two before applying blur.\n\n```xml\n<@nativescript-community/ui-image:Img blurDownSampling=\"2\"/>\n```\n\n- **aspectRatio** \n\nNumber value used as the aspect ratio of the image. This property is useful when you are working with different aspect ratio images and want to have a fixed Width or Height. The ratio of an image is calculated by dividing its width by its height. \n\n*Note: In some layout scenarios it is necessary to set the ```verticalAlignment``` of the Img to 'top' or 'bottom' in order to \"anchor\" the img and achieve dynamic sizing.*\n\n```xml\n<@nativescript-community/ui-image:Img aspectRatio=\"1.33\" verticalAlignment=\"top\"/>\n```\n\n- **decodeWidth** (downsampling)\n\nNumber value used as the downsampled width of the imageModule drawable.\n\n```xml\n<@nativescript-community/ui-image:Img decodeWidth=\"100\"/>\n```\n\n- **decodeHeight** (downsampling)\n\nNumber value used as the downsampled width of the imageModule drawable.\n\n```xml\n<@nativescript-community/ui-image:Img decodeHeight=\"100\"/>\n```\n\n- **headers**\n\nObject that defines custom request headers to be sent with the image download request.\n\n```xml\n<@nativescript-community/ui-image:Img headers=\"{Authorization: 'bearer abcdefghijk'}\"/>\n```\n\n- **progressiveRenderingEnabled**\n\nBoolean value used for enabling or disabling the streaming of progressive JPEG images. This property is set to 'false' by default. Setting this property to 'true' while loading JPEG images not encoded in progressive format will lead to a standard loading of those images.\n\n```xml\n<@nativescript-community/ui-image:Img progressiveRenderingEnabled=\"true\"/>\n```\n\n- **roundAsCircle** \n\nBoolean value used for determining if the image will be rounded as a circle. Its default value is false. If set to true the image will be rounder to a circle.\n\n```xml\n<@nativescript-community/ui-image:Img roundAsCircle=\"true\"/>\n```\n\n- **roundTopLeftRadius** \n\nRadius of the Top Left corner in \n\n```xml\n<@nativescript-community/ui-image:Img roundTopLeftRadius=\"50\"/>\n```\n\n- **roundTopRightRadius** \n\nRadius of the Top Right corner in \n\n```xml\n<@nativescript-community/ui-image:Img roundTopRightRadius=\"50\"/>\n```\n- **roundBottomLeftRadius** \n\nRadius of the Bottom Left corner in \n\n```xml\n<@nativescript-community/ui-image:Img roundBottomLeftRadius=\"50\"/>\n```\n- **roundBottomRightRadius** \n\nRadius of the Bottom Right corner in \n\n```xml\n<@nativescript-community/ui-image:Img roundBottomRightRadius=\"50\"/>\n```\n\n- **autoPlayAnimations** \n\nBoolean value used for enabling the automatic playing of animated images. Note that rounding of such images is not supported and will be ignored.\n\n```xml\n<@nativescript-community/ui-image:Img autoPlayAnimations=\"true\"/>\n```\n\n- **tapToRetryEnabled** (Android only)\n\nBoolean value used for enabling/disabling a tap to retry action for the download of the Img image.\n\n```xml\n<@nativescript-community/ui-image:Img tapToRetryEnabled=\"true\"/>\n```\n\n### Cache\nThe @nativescript-community/ui-image {N} plugin has built-in cache mechanism which handles managing the images in the memory. There are two types of cache mechanisms `memory` and `disk`, you can manually manage both of them with the following functionality.\n\n#### 'Refresh' the 'src'\nNot so rarely you may have a scenario where the actual image on your remote service from the `src` of the `Img` has changed but the {N} app already has an image in its internal cache. In such scenario you can easily 'refresh' the `src` by calling the `updateImageUri()`:\n\n```\n// 'img' is the instance the 'Img' in the project.\nimg.updateImageUri();\n```\n\n\n#### Clear everything from the cache\nManaging the caches in @nativescript-community/ui-image is done via the `ImagePipeline`. In order to get the reference of the ImagePipeline simply call the `getImagePipeline()` function:\n\n```\nvar imageModuleModel = require(\"@nativescript-community/ui-image\");\n\nvar imagePipeLine = imageModuleModel.getImagePipeline();\n```\n\n- Clear both the memory and disk caches\n\n```\nimagePipeLine.clearCaches();\n``` \n\n- Clear the memory cache\n\n```\nimagePipeLine.clearMemoryCaches();\n``` \n\n- Clear the disk cache\n\n```\nimagePipeLine.clearDiskCaches();\n``` \n\n#### Evict all images with a specific URI from the cache\nIf clearing the entire cache is not what you desired, you can clear only the images linked with a specific URI (`src`). Evicting is done again via the ImagePipeline:\n\n```\nvar imageModuleModel = require(\"@nativescript-community/ui-image\");\n\nvar imagePipeLine = imageModuleModel.getImagePipeline();\n```\n\n- Evict URI from both the memory and disk caches\n\n```\nimagePipeLine.evictFromCache(\"