Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyb3rko/about-icons
Android library to easily give credit if using icons which require attribution
https://github.com/cyb3rko/about-icons
android attribution credits icons library
Last synced: about 1 month ago
JSON representation
Android library to easily give credit if using icons which require attribution
- Host: GitHub
- URL: https://github.com/cyb3rko/about-icons
- Owner: cyb3rko
- License: apache-2.0
- Created: 2020-07-15T15:21:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-10-03T16:17:27.000Z (about 2 years ago)
- Last Synced: 2024-08-01T19:50:58.644Z (5 months ago)
- Topics: android, attribution, credits, icons, library
- Language: Kotlin
- Homepage: https://play.google.com/store/apps/details?id=com.cyb3rko.abouticonssample
- Size: 14.2 MB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - cyb3rko/about-icons - Android library to easily give credit if using icons which require attribution (Kotlin)
README
# Android About Icons Library
[](https://android-arsenal.com/api?level=16)
[](https://jitpack.io/#cyb3rko/about-icons)
[](https://github.com/cyb3rko/about-icons/commits/master)
[](https://www.apache.org/licenses/LICENSE-2.0)
- [About this project](#about-this-project)
- [Features](#features)
- [How to use](#how-to-use)
- [Planned improvements](#planned-improvements)
- [Screenshots](#screenshots)
- [Contribute](#contribute)
- [Apps using this library](#apps-using-this-library)
- [License](#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](https://flaticon.com) or [fontawesome.com](https://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](#2-mark-icons))
- automatically retrieving the information and credits by reading related string arrays (further information [here](#3-add-information))
- automatically highlight icons who have been modified by reading related string entry (further information [here](#3-add-information))
## How to use
### 1. Implementation
Add this to your **root** build.gradle file:
```gradle
allprojects {
repositories {
maven { url "https://jitpack.io" }
}
}
```
Then add this to your **module's** build.gradle file:
```gradle
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](https://github.com/cyb3rko/about-icons/issues/new) for the used [licenses library](https://github.com/cyb3rko/android-licenses-library))):
- [apache_2.0](https://www.apache.org/licenses/LICENSE-2.0)
- [mit](https://opensource.org/licenses/MIT)
- [cc_by_3.0](https://creativecommons.org/licenses/by/3.0/)
- [cc_by_sa_3.0](https://creativecommons.org/licenses/by-sa/3.0/)
- [cc_by_4.0](https://creativecommons.org/licenses/by/4.0/)
- [cc_by_sa_4.0](https://creativecommons.org/licenses/by-sa/4.0/)
- [cc_by_nc_3.0](https://creativecommons.org/licenses/by-nc/3.0/)
```xml
Dave Gandy
flaticon.com
https://www.flaticon.com/free-icon/external-link-symbol_25284
false
cc_by_3.0
xnimrodx
flaticon.com
https://www.flaticon.com/free-icon/computer_2905155
...
```
### 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:
```java
.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
```kotlin
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
super.onCreateView(inflater, container, savedInstanceState)
return AboutIcons(requireContext(), R.drawable::class.java, supportFragmentManager).get()
}
```
Java Activity
```java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(new AboutIcons(this, R.drawable.class, getSupportFragmentManager()).get());
}
```
**Advanced example (using configuration) for a fragment**:
Kotlin:
```kotlin
override fun onCreateView(inflater: LayoutInflater, container: ViewGroup?, savedInstanceState: Bundle?): View {
super.onCreateView(inflater, container, savedInstanceState)
val aboutIcons = AboutIcons(requireContext(), R.drawable::class.java, supportFragmentManager)
.setTitle("Your Title")
.hideModificationAnnotation();
return aboutIcons.get()
}
```
Java Activity:
```java
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
AboutIcons aboutIcons = new AboutIcons(this, R.drawable.class, getSupportFragmentManager())
.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:
```pro
-keep class .R
-keep class **.R$* {
;
}
```
## 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](https://github.com/cyb3rko/about-icons/issues) for new features or bug reports.
If you want to directly contribute code just open [pull requests](https://github.com/cyb3rko/about-icons/pulls).
## Apps using this library
*If you want to add an app here, just open a [new issue](https://github.com/cyb3rko/about-icons/issues/new) / [PR](https://github.com/cyb3rko/about-icons/compare).*
LogViewer for openHAB
by Cyb3rko
## Used Libraries
Click here to see the list
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 © 2022, 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.