Skip to content

An android library which lets you add a view with two dimensional scrolling (X & Y) and zoom.

Notifications You must be signed in to change notification settings

justdvnsh/TwoDScrollableZoomableLayout

Repository files navigation

MIT License LinkedIn "Buy Me A Coffee" Patreon Slack


Two Dimensional Scroll View With Zoom

An awesome library to include Two Dimensional Scroll view with zooming capabilities in your app.
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. License
  5. Contact

About The Project

The project aims to solve a personal problem of including Two Dimensional Scrolling view with zoom. A few my projects needed this feature to view the images just like a wallpaper app does to let you set the wallpaper. However, the scroll views in the wallpapers simply scroll horizontally. My problem was that a lot of images were loosing their quality if they were set to the phone's height. I didn't want that. For example, my AnimeClassroom has a manga reading feature. Now the images in mangas are very large both horizontally and vertically. If the height was set to match phone's height, the image lost its quality thus making it harder to read. So, I made this Custom view to solve that problem. Now, I have converted this into a library so that it could be used in any project.

WARNING! : THIS PROJECT IS STILL IN HEAVY DEVELOPMENT, THEREFORE YOU MAY ENCOUNTER BUGS. You can OPEN the ISSUE on GITHUB REPOSITORY.

NEW FEATURES WILL BE ADDED REGULARLY

(Back to top)

Getting Started

Simply fork the repo. Clone it into your machine and let AndroidStudio handle the rest.

Installation

To include this library, follow the below steps.

Step 1 -> Add this line in root build.gradle at the end of repositories.

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

Step 2 -> Add this line in your module build.gradle file.

dependencies {
    implementation 'com.github.justdvnsh:TwoDScrollableZoomableLayout:0.0.2'
}

See the open issues for a full list of proposed features (and known issues).

(Back to top)

Sample Video demonstration

![Alternate Text]

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "feature-request". Don't forget to give the project a star! Thanks again!

NOTE -> Every PR will be reviewed before merging.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

PLEASE MAKE SURE TO REMOVE THE .idea/ files before pushing a commit

Want to support me by buying me a coffee ? "Buy Me A Coffee"

Want to contribute to this project by supporting us through money ? Patreon

Want to join the discussions ? Slack

(Back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Divyansh Dwivedi - @justdvnsh - [email protected]

Project Link: https://github.com/justdvnsh/TwoDScrollableZoomableLayout

Join Discussion at: Slack

(Back to top)