Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avaloniautils/asyncimageloader.avalonia
Provides way to asynchronous bitmap loading from web for Avalonia Image control and more
https://github.com/avaloniautils/asyncimageloader.avalonia
avalonia avaloniaui c-sharp-library cross-platform image
Last synced: 2 days ago
JSON representation
Provides way to asynchronous bitmap loading from web for Avalonia Image control and more
- Host: GitHub
- URL: https://github.com/avaloniautils/asyncimageloader.avalonia
- Owner: AvaloniaUtils
- License: mit
- Created: 2021-11-09T14:08:26.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-17T14:46:24.000Z (4 months ago)
- Last Synced: 2024-10-30T01:02:38.708Z (about 2 months ago)
- Topics: avalonia, avaloniaui, c-sharp-library, cross-platform, image
- Language: C#
- Homepage:
- Size: 1.35 MB
- Stars: 154
- Watchers: 2
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# AsyncImageLoader.Avalonia
Provides way to asynchronous bitmap loading for Avalonia Image control.
Features:
- Supports urls and downloading from web
- Asynchronous loading
- Integrated inmemory cache
- Integrated disk cache
- Easy to implement your own way of images loading and caching
## Getting started
1. Install `AsyncImageLoader.Avalonia` [nuget package](https://www.nuget.org/packages/AsyncImageLoader.Avalonia/)
```
dotnet add package AsyncImageLoader.Avalonia
```
2. Start using
## Using
Note: The first time you will need to import the AsyncImageLoader namespace to your xaml file. Usually your IDE should [suggest it automatically](https://user-images.githubusercontent.com/29896317/140953397-00028365-5b93-4e6c-b470-094a555870c8.png). The root element in the file will be [like this](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia.Demo/Views/MainWindow.axaml#L6):
```xaml
```
Note: Assets and resources in Avalonia described [here](https://docs.avaloniaui.net/docs/getting-started/assets).
### ImageLoader attached property
The only thing you need to do in your xaml is to replace the `Source` property in `Image` with `ImageLoader.Source`.
For example, your old code:
```xaml
```
Should turn into:
```xaml
```
Also you can use `ImageLoader.IsLoading` readonly attached property that indicates whether the load is in progress or not.
AsyncImageLoader **support** `resm:` and `avares:` links.
And does **not** support relative referenced assets such as `Source="icon.png"` or `Source="/icon.png"`. Use [AdvancedImage control](#advancedimage-control).
### AdvancedImage control
This control provides all capabilities of ImageLoader attached property and **support** relative referenced assets such as `Source="icon.png"` or `Source="/icon.png"`.
Before you go, add following style to you `App.xaml` file and `Application.Styles` section:
```xaml
```
And you can use `AdvancedImage` as any other control:
```xaml
```
This control allows specifying a custom IAsyncImageLoader for particular control.
Also, this control has loading indicator support out of the box.
### ImageBrush
If you need a brush you can use Avalonia's `ImageBrush` with `ImageBrushLoader.Source` property (instead of default `Source`). It will look like that:
```xaml
```
## Loaders
ImageLoader will use instance of [IImageLoader](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia/IAsyncImageLoader.cs) for serving your requests.
You can change the loader used by setting new one to the [ImageLoader.AsyncImageLoader](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia/ImageLoader.cs#L10) property. Do not forget to Dispose previous loader.
There are several loaders available out of the box:
- [BaseWebImageLoader](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia/Loaders/BaseCachedWebImageLoader.cs) - Provides non cached way to asynchronously load images without caching. Can be used as base class for custom loaders you dont want caching in any way.
- [RamCachedWebImageLoader](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia/Loaders/RamCachedWebImageLoader.cs) - This is inheritor if BaseWebImageLoader with in memory images caching. Can be used as base class for custom loaders you want only inmemory caching.
- [DiskCachedWebImageLoader](https://github.com/AvaloniaUtils/AsyncImageLoader.Avalonia/blob/master/AsyncImageLoader.Avalonia/Loaders/DiskCachedWebImageLoader.cs) - This is inheritor if RamCachedWebImageLoader with in memory caching and disk caching for downloaded from the internet images. Can be used as base class for custom loaders if you want disk caching out of the box.
`RamCachedWebImageLoader` are used by default.