Android About Icons Library
- About this project
- Features
- How to use
- Planned improvements
- Screenshots
- Contribute
- Apps using this library
- License
About this project
This Android library simplifies the exhausting process of giving credits to licensed icons which require attribution (like icons from flaticon.com or fontawesome.com in the free plan).
YOU CAN DOWNLOAD THE SAMPLE APP HERE!
If you want to build the app on your own, build the debug build variant.
This was my very first library and I'm still a student so the progress might not be as fast as on other projects.
Features
- automatically recognizing the icons to show based on file name (further information here)
- automatically retrieving the information and credits by reading related string arrays (further information here)
- automatically highlight icons who have been modified by reading related string entry (further information here)
How to use
1. Implementation
Add this to your root build.gradle file:
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
Then add this to your module's build.gradle file:
dependencies {
implementation 'com.github.cyb3rko:about-icons:lastest-version'
}
2. Mark icons
Afterwards you have to add an underscore to every icon filename you want the library to attribute.
If you don't add an underscore, the icon is ignored.
Example:
3. Add information
Now you have to add the information the library needs for attributing.
Do this by adding a string array for each icon with the icon name as string array name (without the underscore; it doesn't matter in which .xml file):
- author name (should be added)
- website (should be added)
- link to the used icon (should be added)
- boolean if icon was modified (default is false)
- icon license (currently supported licenses (if you are missing one, please open an issue for the used licenses library)):
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string-array name="icon_alink">
<item>Dave Gandy</item>
<item>flaticon.com</item>
<item>https://www.flaticon.com/free-icon/external-link-symbol_25284</item>
<item>false</item>
<item>cc_by_3.0</item>
</string-array>
<string-array name="icon_art">
<item>xnimrodx</item>
<item>flaticon.com</item>
<item>https://www.flaticon.com/free-icon/computer_2905155</item>
</string-array>
...
</resources>
4. Create view
At last just create a new AboutIcons object, pass the context and the drawable class, and get the view by calling get().
Optionally you can configure your AboutIcons page using following config methods:
.setTitle(customTitle: String)
.setTitleSize(customSize: Float)
.setModificationTitle(customTitle: String)
.setModificationTitleSize(customSize: Float)
.hideModificationAnnotation()
HINT: If you want to hide the title, simply call "setTitle("")", then the title layout will be hidden
Simple example for a fragment: Kotlin
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
super.onCreateView(inflater, container, savedInstanceState)
return AboutIcons(requireContext(), R.drawable::class.java).get()
}
Java Activity
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(new AboutIcons(this, R.drawable.class).get());
}
Advanced example (using configuration) for a fragment:
Kotlin:
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
super.onCreateView(inflater, container, savedInstanceState)
val aboutIcons = AboutIcons(requireContext(), R.drawable::class.java)
.setTitle("Your Title")
.hideModificationAnnotation();
return aboutIcons.get()
}
Java Activity:
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
AboutIcons aboutIcons = new AboutIcons(this, R.drawable.class)
.setTitle("Your Title")
.setModificationTitleSize(6f)
.hideModificationAnnotation();
setContentView(aboutIcons.get());
}
Proguard Minify Compatibility
If you have minify enabled and you let it shrink the resources this library is most likely to not be able to find your icons you want to give credit to.
Then simply add the following to your proguard rules:
-keep class .R
-keep class **.R$* {
<fields>;
}
Planned improvements
- improving scroll performance
- adding simple licensing information for several icon library websites
Screenshots
 |
 |
 |
|---|
Contribute
Of course I'm happy about any kind of contribution.
Feel free to open issues for new features or bug reports. If you want to directly contribute code just open pull requests.
Apps using this library
If you want to add an app here, just open a new issue / PR.
 |
LogViewer for openHAB | by Cyb3rko |
Used Libraries
Click here to see the list
| Toasty | by GrenderG | licensed under GNU Lesser General Public License v3.0 |
| Material Dialogs | by Aidan Follestad | licensed under Apache License 2.0 |
| Android Licenses Library | by Cyb3rKo | licensed under Apache License 2.0 |
Used Icons
Click here to see the list
| Multiple Icons made by Freepik from www.flaticon.com |
| Multiple Icons made by Dave Gandy from www.flaticon.com |
License
Copyright © 2021, Cyb3rKo
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.
10 Dec 15, 2022
13 Apr 8, 2022
14 Jan 26, 2022
370 Dec 28, 2022
0 Jan 9, 2022
117 Nov 25, 2022
9 Sep 9, 2022
230 Dec 23, 2022
4 Dec 15, 2022
21 Dec 15, 2022
28 Oct 1, 2022
6 Mar 5, 2022
1.4k Jan 1, 2023
43 Dec 29, 2022
60 Nov 18, 2022
38 Sep 25, 2022
28 Oct 5, 2022
3 Dec 15, 2022
5 Dec 29, 2022