Skip to content

Latest commit

 

History

History
243 lines (179 loc) · 9.03 KB

README.md

File metadata and controls

243 lines (179 loc) · 9.03 KB
Raw

Dynamic Support

License Release

A complete library to build apps for Android 4.0 (API 14) and above with a built-in theme engine. It is built on top of the latest app compat library to provide best compatibility.

Since v2.0.0, it uses AndroidX so, first migrate your project to AndroidX.
Since v3.0.0, it is dependent on Java 8 due to the dependency on DrawerLayout.
Since v6.3.0, it is targeting Java 17 to provide maximum compatibility.
Since v6.4.0, the minimum SDK is Android 4.4 (API 19) to comply with the latest policies.

Contents

Installation

It can be installed by adding the following dependency to your build.gradle file:

dependencies {
    // For AndroidX enabled projects.
    implementation 'com.pranavpandey.android:dynamic-support:6.4.1'

    // For legacy projects.
    implementation 'com.pranavpandey.android:dynamic-support:1.3.0'
}

Usage

It is a collection of activities, fragments, widgets, views and some utility functions required to build a standard Android app. It also provides some built-in use cases like an intro screen, drawer activity, about screen, collapsing app bar, navigation bar view, color picker, multiple locales, runtime permissions, etc. which can be used and customised according to the requirements.

For a complete reference, please read the documentation.

Theme engine

Each activity and widget can be themed by using the built-in theme engine with background aware functionality to avoid any visibility issues. Colors can be selected by using the provided material design colors or by selecting a custom color from the built-in picker which supports HEX, HSV, ARGB and CMYK values.

Background aware

Below are the same colors applied on the light and dark backgrounds respectively. But the final color is adjusted according to the colored view background to provide best visibility.

Sample

This library is fully commented so, please check the individual classes or files for the documentation. Basic documentation will be available soon.

Checkout the sample to know more about the basic implementation.

Dependency

It depends on the dynamic-theme, dynamic-locale and dynamic-preferences to perform various internal operations. So, their functions can also be used to perform other useful operations.

Proguard

This library uses reflection at some places to theme widgets at runtime. So, their original name must be preserved to theme them properly. It will automatically apply the appropriate rules if proguard is enabled in the project.

The following rules will be applied by this library:

# Keep application class.
-keep public class * extends android.app.Application

# Keep methods in Activity that could be used in the XML.
-keepclassmembers class * extends android.app.Activity {
    public void *(android.view.View);
}

# Keep support library classes.
#-keep class android.support.v4.widget.** { *; }
#-keep class android.support.v7.widget.** { *; }
#-keep class android.support.design.widget.** { *; }
#-keep class android.support.design.internal.** { *; }

# Keep AndroidX classes.
-keep class androidx.core.widget.** { *; }
#-keep class androidx.appcompat.widget.** { *; }
-keep class androidx.appcompat.view.menu.** { *; }
-keep class androidx.recyclerview.widget.** { *; }
-keep class androidx.viewpager.widget.** { *; }

# Keep Material Components classes.
-keep class com.google.android.material.internal.** { *; }
-keep class com.google.android.material.navigation.** { *; }
-keep class com.google.android.material.textfield.** { *; }

# Keep all the Dynamic Support models.
-keep class com.pranavpandey.android.dynamic.support.model.** { *; }
-keepclassmembers class * implements android.os.Parcelable {
    static ** CREATOR;
}

# Dynamic Theme rules

# Gson uses generic type information stored in a class file when working with fields.
# Proguard removes such information by default, so configure it to keep all of it.
-keepattributes Signature

# For using Gson annotation.
-keepattributes *Annotation*

# Gson specific classes.
-keep class sun.misc.Unsafe { *; }
-keep class com.google.gson.** { *; }

Built with Dynamic

All of my apps are using some or all part of this library. You can download them via Google Play. Please email me if you are using this library and want to feature your app here. Also, please checkout the Rotation and Everyday apps to experience the full potential of this library.

Supported

Developed

Translations

  • German (de) - Flubberlutsch
  • French (fr) - Nitesh Jha | Others
  • Hindi (hi) - Siddh Narhari
  • Indonesian (in) - Gamal Kevin A
  • Italian (it) - Nicola
  • Portuguese (pt) - Jorge Alexandre | Matheus Coelho
  • Russian (ru) - Maxim Anisimov
  • Spanish (es) - Dave
  • Turkish (tr) - Fatih Fırıncı
  • Chinese (Simplified) (zh-rCN) - 残念
  • Chinese (Traditional) (zh-rTW) - 會呼吸的風 | 人工知能

Author

Pranav Pandey

GitHub Follow on Twitter Donate via PayPal

License

Copyright 2018-2024 Pranav Pandey

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.