AppInfoBadge

Additional

Language
Kotlin
Version
1.3 (Apr 10, 2020)
Created
Mar 21, 2020
Updated
Apr 10, 2020 (Retired)
Owner
Cristi Dita (ditacristianionut)
Contributors
Cristi Dita (ditacristianionut)
ditacristian
2
Activity
Badge
Generate
Download
Source code

AppInfoBadge

A simple about screen library that can display the following information:

  • App permissions list
  • License page
  • Libraries page
  • Changelog page
  • PlayStore link
  • Contact page

Download

allprojects {
 repositories {
  jcenter() 
  maven { url "https://jitpack.io" }
 } 
}
dependencies { 
  implementation 'com.github.ditacristianionut:AppInfoBadge:$version'
}

How to use

Use AppInfoBadge to create an instance of AppInfoBadgeFragment configured as you wish:

 val aboutPage = AppInfoBadge  
  .darkMode { true }  
  .headerColor { Color.RED }  
  .withAppIcon { true }  
  .withPermissions { true }  
  .withChangelog { true }  
  .withLicense { true }  
  .withLibraries { true }
  .withRater { true }  
  .withEmail { "developer@gmail.com" }  
  .withSite { "https://www.developer.com" }
  .withCustomItems { listOf<BaseInfoItem>() }
  .show()

Custom items

Apart from the predefined items, you can inject your own list of items. There are two types of items:

  • InfoItemWithView - when selected, a bottom sheet dialog with your own defined content is displayed
  • InfoItemWithLink - when selected, a link defined by you is opened

InfoItemWithView fields:

  • iconId: Int - a drawable resource that is used on the main page and inside the bottom sheet dialog (header icon)
  • title: String - the name of the item used on the main page
  • headerColor: Int: - background color of the header
  • res: Int? - a layout resouce that will be displayed on the bottom sheet dialog
  • view: View? - a view that will be displayed on the bottom sheet dialog You can only use one of the two: res or view!

InfoItemWithLink fields:

  • iconId: Int - a drawable resource that is used on the main page and inside the bottom sheet dialog (header icon)
  • title: String - the name of the item used on the main page
  • headerColor: Int: - background color of the header
  • link: Uri - the URI of the resource that will be open on item click
Samples:
val itemWithView = InfoItemWithView(  
  iconId = R.drawable.ic_test,  
  title = "First custom item with view",  
  headerColor = R.color.deep_purple_600,  
     res = null,  
     view = ImageView(this).also {  
      it.setImageResource(R.drawable.ic_link) 
   }  
)  
  
val itemWithRes = InfoItemWithView(  
 iconId = R.drawable.ic_test,  
   title = "Second custom item with view",  
   headerColor = R.color.indigo_600,  
   res = R.layout.test_item,  
   view = null  
)  
  
val itemWithLink = InfoItemWithLink(  
 iconId = R.drawable.ic_link,  
   title = "Custom link",  
   headerColor = R.color.deep_purple_600,  
   link = Uri.parse("https://www.google.com")
)

Changelog

An HTML file named changelog.html that you have to put under assets.

Sample:
<html>
    <body>

        <h2>Version 3</h2>
        <p>This new version is amazing</p>

        <h2>Version 2</h2>
        <p>Bugfixes and general improvements</p>

        <h2>Version 1</h2>
        <p>Initial release</p>
    
    </body>
</html>

Libraries

An HTML file named libraries.html that you have to put under assets.

Sample:
<html>
    <body>
        <ul>
            <li><a href="https://github.com/ditacristianionut/AppInfoBadge">AppInfoBadge</a></li>
            <li><a href="https://github.com/afollestad/material-dialogs">Material Dialogs</a></li>
        </ul>
    </body>
</html>

License

An HTML file named license.html that you have to put under assets.

Sample:
<html>
    <body>

        <h2>Apache License, Version 2.0</h2>
        <h3>
            Apache License
            Version 2.0, January 2004
            http://www.apache.org/licenses/
        </h3>
        <p>
            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.
        </p>

        <h2>GNU General Public License version 3</h2>
        <h3>
            License Copyright: Copyright © 2007 Free Software Foundation, Inc.
        </h3>
        <p>
            This program is free software: you can redistribute it and/or modify
            it under the terms of the GNU General Public License as published by
            the Free Software Foundation, either version 3 of the License, or
            (at your option) any later version.
        
            This program is distributed in the hope that it will be useful,
            but WITHOUT ANY WARRANTY; without even the implied warranty of
            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
            GNU General Public License for more details.
        
            You should have received a copy of the GNU General Public License
            along with this program.
        </p>

        <h2>MIT License</h2>
        <p>
            Copyright (c) <2020> <>
            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.
        </p>

    </body>
</html>