Home

Awesome

ScrollGalleryView

Build Status Android Arsenal Join the chat at https://gitter.im/VEINHORN/ScrollGalleryView

ScrollGalleryView is a flexible library which helps you to create awesome media galleries in your Android application. It's easily integrated with the most popular image loading libraries such as Picasso, Glide and Fresco.

ScrollGalleryView

Key features

Installing

Add JitPack repository to your root build.gradle (see more details here):

allprojects {
    repositories {
        // ...
        maven { url 'https://jitpack.io' }
    }
}

Add dependency to your module build.gradle:

implementation 'com.veinhorn.scrollgalleryview:library:1.2.6'

MediaLoaders

There are several MediaLoaders implementations for most popular caching libraries: Picasso, Glide, Fresco.

Picasso

implementation 'com.veinhorn.scrollgalleryview:picasso-loader:1.2.4'

Glide

implementation 'com.veinhorn.scrollgalleryview:glide-loader:1.2.9'

Fresco

implementation 'com.veinhorn.scrollgalleryview:fresco-loader:1.2.4'

Usage

Add ScrollGalleryView to your layout:

<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <com.veinhorn.scrollgalleryview.ScrollGalleryView
        android:id="@+id/scroll_gallery_view"
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:background="#000"/>
</LinearLayout>

Initialize ScrollGalleryView in your activity:

import static com.veinhorn.scrollgalleryview.loader.picasso.dsl.DSL.*; // simplifies adding media

public class MainActivity extends FragmentActivity {
    private ScrollGalleryView galleryView;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        galleryView = ScrollGalleryView
                .from((ScrollGalleryView) findViewById(R.id.scroll_gallery_view))
                .settings(
                        GallerySettings
                                .from(getSupportFragmentManager())
                                .thumbnailSize(100)
                                .enableZoom(true)
                                .build()
                )
                .add(image("http://pirate-islands.com/wp-content/uploads/2018/07/07_Dom-Fernando-II_01-636x310.jpg"))
                .add(image("http://povodu.ru/wp-content/uploads/2016/04/pochemu-korabl-derzitsa-na-vode.jpg"))
                .add(video("http://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_1mb.mp4", R.mipmap.default_video))
                .build();
    }
}

If you use ScrollGalleryView version prior 1.2.0 or need more info about gallery initialization you can find it here.

Adding media

ScrollGalleryView supports different types of media such as images and videos. You can create image gallery, video gallery, or mix them in any way. To abstract from concreate way of image loading ScrollGalleryView uses MediaLoader so it makes possible to use different image loading libraries depending on your needs (Picasso, Glide, Fresco).

Picasso loader

Default image loader

Library is also contains default image loader but it's not optimized for performance.

Note: it's highly recommended to use custom image loader against default

Configuration

You can specify a bunch of additional settings during gallery initialization.

OptionMethodDescription
Thumbnail size.setThumbnailSize(200)You can configure thumbnails size in
Zoom.setZoom(true)Enable zoom
Hide thumbnails.withHiddenThumbnails(false)Hide scroll view container with thumbnails on the bottom of screen
Hide thumbnails on click.hideThumbnailsOnClick(true)Hide scroll view container with thumbnails when you click on main image area

Adding listeners

ScrollGalleryView supports adding listeners for events like: image click, long image click, changed page. More details you can find in separate doc.

Sample application

The sample application published on Google Play.

Get it on Google Play

License

MIT License

Copyright (c) 2019 Boris Korogvich

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.