IODevBlue/BannerX-Transformers

Custom transformers for the BannerX library.

BannerX-Transformers

Table of content

• Documentations
• Uses
• Installation
• Contributions
• Changelog
• License

Documentations

Documentations are available online in Javadoc and KDoc.

Uses

BannerX-Transformers is only used as an extension of the BannerX library.

AccordionBannerTransformer

AlphaBannerTransformer

CartwheelBannerTransformer

CenterScaleBannerTransformer

DescentBannerTransformer

FlipBannerTransformer

OverlayBannerTransformer

PunchyBannerTransformer

ScaleBannerTransformer

SidedStackBannerTransformer

Installation

1. Grab a JAR artifact from the Maven Central Repository:

implementation 'io.github.iodevblue:bannerx-transformers:1.0.0'

• On Apache Maven

<dependency>
  <groudId> io.github.iodevblue </groudId>
  <artifactId> bannerx-transformers </artifactId>
  <version> 1.0.0 </version>
</dependency>

If it is a snapshot version, add the snapshot Maven Nexus OSS repository:

maven {   
  url 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
}

Then retrieve a copy:

implementation 'io.github.iodevblue:bannerx-transformers:1.0.0-SNAPSHOT'

2. Grab a JAR artifact from the release section.

• Place it in libs folder in your project module and install in your project.

implementation fileTree(dir:' libs', include:'*jar')

Contributions

Contributors are welcome!

NOTE: This repository is split into two branches:

• main branch
• development branch All developing implementations and proposed changes are pushed to the development branch and finalized updates are pushed to the main branch.

To note if current developments are being made, there would be more commits in the development branch than in the main branch.

A BannerX transformer is simply a ViewPager2.PageTransformer that implements the Parcelable interface.

Check the Contributing for more information.

Changelog

• 1.0.0
  • Initial release

More version history can be gotten from the Change log file.

License

    Copyright 2023 IO DevBlue

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.