Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bumptech/glide

An image loading and caching library for Android focused on smooth scrolling
https://github.com/bumptech/glide

android disk-cache gif glide imageloader

Last synced: 3 days ago
JSON representation

An image loading and caching library for Android focused on smooth scrolling

Awesome Lists containing this project

README 

        
Glide

=====



[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.bumptech.glide/glide/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.bumptech.glide/glide)

| [View Glide's documentation][20] | [简体中文文档][22] | [Report an issue with Glide][5]



Glide is a fast and efficient open source media management and image loading framework for Android that wraps media

decoding, memory and disk caching, and resource pooling into a simple and easy to use interface.



![](static/glide_logo.png)



Glide supports fetching, decoding, and displaying video stills, images, and animated GIFs. Glide includes a flexible API

that allows developers to plug in to almost any network stack. By default Glide uses a custom `HttpUrlConnection` based

stack, but also includes utility libraries plug in to Google's Volley project or Square's OkHttp library instead.



Glide's primary focus is on making scrolling any kind of a list of images as smooth and fast as possible, but Glide is

also effective for almost any case where you need to fetch, resize, and display a remote image.



Download

--------

For detailed instructions and requirements, see Glide's [download and setup docs page][28].



You can download a jar from GitHub's [releases page][1].



Or use Gradle:



```gradle

repositories {

  google()

  mavenCentral()

}



dependencies {

  implementation 'com.github.bumptech.glide:glide:4.16.0'

}

```



Or Maven:



```xml



  com.github.bumptech.glide

  glide

  4.16.0



```



For info on using the bleeding edge, see the [Snapshots][17] docs page.



R8 / Proguard

--------

The specific rules are [already bundled](library/proguard-rules.txt) into the aar which can be interpreted by R8 automatically



How do I use Glide?

-------------------

Check out the [documentation][20] for pages on a variety of topics, and see the [javadocs][3].



For Glide v3, see the [wiki][2].



Simple use cases will look something like this:



```java

// For a simple view:

@Override public void onCreate(Bundle savedInstanceState) {

  ...

  ImageView imageView = (ImageView) findViewById(R.id.my_image_view);



  Glide.with(this).load("https://goo.gl/gEgYUd").into(imageView);

}



// For a simple image list:

@Override public View getView(int position, View recycled, ViewGroup container) {

  final ImageView myImageView;

  if (recycled == null) {

    myImageView = (ImageView) inflater.inflate(R.layout.my_image_view, container, false);

  } else {

    myImageView = (ImageView) recycled;

  }



  String url = myUrls.get(position);



  Glide

    .with(myFragment)

    .load(url)

    .centerCrop()

    .placeholder(R.drawable.loading_spinner)

    .into(myImageView);



  return myImageView;

}

```



Status

------

Version 4 is now released and stable. Updates are released periodically with new features and bug fixes.



Comments/bugs/questions/pull requests are always welcome! Please read [CONTRIBUTING.md][5] on how to report issues.



Compatibility

-------------



 * **Minimum Android SDK**: Glide v4 requires a minimum API level of 14.

 * **Compile Android SDK**: Glide v4 requires you to compile against API 26 or later.



 If you need to support older versions of Android, consider staying on [Glide v3][14], which works on API 10, but is not actively maintained.



 * **OkHttp 3.x**: There is an optional dependency available called `okhttp3-integration`, see the [docs page][23].

 * **Volley**: There is an optional dependency available called `volley-integration`, see the [docs page][24].

 * **Round Pictures**: `CircleImageView`/`CircularImageView`/`RoundedImageView` are known to have [issues][18] with `TransitionDrawable` (`.crossFade()` with `.thumbnail()` or `.placeholder()`) and animated GIFs, use a [`BitmapTransformation`][19] (`.circleCrop()` will be available in v4) or `.dontAnimate()` to fix the issue.

 * **Huge Images** (maps, comic strips): Glide can load huge images by downsampling them, but does not support zooming and panning `ImageView`s as they require special resource optimizations (such as tiling) to work without `OutOfMemoryError`s.



Build

-----

Building Glide with gradle is fairly straight forward:



```shell

git clone https://github.com/bumptech/glide.git

cd glide

./gradlew jar

```



**Note**: Make sure your *Android SDK* has the *Android Support Repository* installed, and that your `$ANDROID_HOME` environment

variable is pointing at the SDK or add a `local.properties` file in the root project with a `sdk.dir=...` line.



Samples

-------

Follow the steps in the [Build](#build) section to set up the project and then:



```shell

./gradlew :samples:flickr:run

./gradlew :samples:giphy:run

./gradlew :samples:svg:run

./gradlew :samples:contacturi:run

```

You may also find precompiled APKs on the [releases page][1].



Development

-----------

Follow the steps in the [Build](#build) section to setup the project and then edit the files however you wish.

[Android Studio][26] cleanly imports both Glide's source and tests and is the recommended way to work with Glide.



To open the project in Android Studio:



1. Go to *File* menu or the *Welcome Screen*

2. Click on *Open...*

3. Navigate to Glide's root directory.

4. Select `setting.gradle`



For more details, see the [Contributing docs page][27].



Getting Help

------------

To report a specific problem or feature request, [open a new issue on Github][5]. For questions, suggestions, or

anything else, email [Glide's discussion group][6], or join our IRC channel: [irc.freenode.net#glide-library][13].



Contributing

------------

Before submitting pull requests, contributors must sign Google's [individual contributor license agreement][7].



Thanks

------

* The **Android team** and **Jake Wharton** for the [disk cache implementation][8] Glide's disk cache is based on.

* **Dave Smith** for the [GIF decoder gist][9] Glide's GIF decoder is based on.

* **Chris Banes** for his [gradle-mvn-push][10] script.

* **Corey Hall** for Glide's [amazing logo][11].

* Everyone who has contributed code and reported issues!



Author

------

Sam Judd - @sjudd on GitHub, @samajudd on Twitter



License

-------

BSD, part MIT and Apache 2.0. See the [LICENSE][16] file for details.



Disclaimer

---------

This is not an official Google product.



[1]: https://github.com/bumptech/glide/releases

[2]: https://github.com/bumptech/glide/wiki

[3]: https://bumptech.github.io/glide/ref/javadocs.html

[4]: https://www.jetbrains.com/idea/download/

[5]: https://github.com/bumptech/glide/blob/master/CONTRIBUTING.md

[6]: https://groups.google.com/forum/#!forum/glidelibrary

[7]: https://developers.google.com/open-source/cla/individual

[8]: https://github.com/JakeWharton/DiskLruCache

[9]: https://gist.github.com/devunwired/4479231

[10]: https://github.com/chrisbanes/gradle-mvn-push

[11]: static/glide_logo.png

[12]: https://github.com/bumptech/glide/wiki/Integration-Libraries

[13]: http://webchat.freenode.net/?channels=glide-library

[14]: https://github.com/bumptech/glide/tree/3.0

[15]: https://github.com/bumptech/glide/tree/master

[16]: https://github.com/bumptech/glide/blob/master/LICENSE

[17]: http://bumptech.github.io/glide/dev/snapshots.html

[18]: https://github.com/bumptech/glide/issues?q=is%3Aissue+CircleImageView+OR+CircularImageView+OR+RoundedImageView

[19]: https://github.com/wasabeef/glide-transformations

[20]: https://bumptech.github.io/glide/

[22]: https://muyangmin.github.io/glide-docs-cn/

[23]: http://bumptech.github.io/glide/int/okhttp3.html

[24]: http://bumptech.github.io/glide/int/volley.html

[25]: http://bumptech.github.io/glide/doc/download-setup.html#proguard

[26]: https://developer.android.com/studio/index.html

[27]: http://bumptech.github.io/glide/dev/contributing.html

[28]: http://bumptech.github.io/glide/doc/download-setup.html