https://github.com/krishnanmuthiahpillai/android_about_us
Android About Page
https://github.com/krishnanmuthiahpillai/android_about_us
Last synced: 3 months ago
JSON representation
Android About Page
- Host: GitHub
- URL: https://github.com/krishnanmuthiahpillai/android_about_us
- Owner: krishnanmuthiahpillai
- Created: 2017-08-28T07:49:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-08-28T07:50:37.000Z (almost 8 years ago)
- Last Synced: 2024-10-31T15:38:25.617Z (8 months ago)
- Language: Java
- Size: 246 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-android - Android_about_us
README
# Android About Page
Create an awesome About Page for your Android App in 2 minutes
This library allows to generate beautiful About Pages with less effort, it's fully customizable and supports opening specific intent
```java
View aboutPage = new AboutPage(this)
.isRTL(false)
.setImage(R.drawable.dummy_image)
.addItem(versionElement)
.addItem(adsElement)
.addGroup("Connect with us")
.addEmail("[email protected]")
.addWebsite("http://medyo.github.io/")
.addFacebook("the.medy")
.addTwitter("medyo80")
.addYoutube("UCdPQtdWIsg7_pi4mrRu46vA")
.addPlayStore("com.ideashower.readitlater.pro")
.addGitHub("medyo")
.addInstagram("medyo80")
.create();
```
## Setup
Available on Jcenter, Maven and JitPack
```groovy
compile 'com.github.medyo:android-about-page:1.2.1'
```
## Usage
### 1. Add Description
```java
setDescription(String)
```
### 2. Add Image
```java
setImage(Int)
```
### 3. Add predefined Social network
The library has already some predefined social networks like :
* Facebook
* Twitter
* Instagram
* Youtube
* PlayStore
```java
addFacebook(String PageID)
addTwitter(String AccountID)
addYoutube(String AccountID)
addPlayStore(String PackageName)
addInstagram(String AccountID)
addGitHub(String AccountID)
```
### 4. Add Custom Element
For example `app version` :
```java
Element versionElement = new Element();
versionElement.setTitle("Version 6.2");
addItem(versionElement)
```
### 5. Available attributes for Element Class
| Function | Description |
| ------------- |:-------------:|
| setTitle(String) | Set title of the element|
| setIconTint(Int) | Set color of the element|
| setIconDrawable(Int) | Set icon of the element|
| setValue(String) | Set Element value like Facebook ID|
| setIntent(Intent) | Set an intent to be called on `onClickListener` |
| setGravity(Gravity) | Set a Gravity for the element |
| setOnClickListener(View.OnClickListener) | If `intent` isn't suitable for you need, implement your custom behaviour by overriding the click listener|
## Sample Project
[medyo/android-about-page/app/](https://github.com/medyo/android-about-page/tree/master/app)
## Translations
The library does supports the following languages :
* English (default)
* German (by [vanniktech](https://github.com/vanniktech))
* Italian (by [greenaddress](https://github.com/greenaddress))
* Croatian (by [skmlcd](https://github.com/skmlcd))
* Arabic (by [zecharyah](https://github.com/zecharyah))
* Slovenian (by [skmlcd](https://github.com/skmlcd))
* Ukrainian (by [NumezmaT](https://github.com/NumezmaT))
* Russian (by [NumezmaT](https://github.com/NumezmaT))
* Romanian (by [Vally79](https://github.com/Vally79))
* Portuguese Brazil (by [rbaprado](https://github.com/rbaprado))
* French (by [medyo](https://github.com/medyo))
* Simplified Chinese (by [whiskeyfei](https://github.com/whiskeyfei))
* Spanish (by [danramirez](https://github.com/danramirez))
* Japanese (by [chibatching](https://github.com/chibatching))
* Turkish (by [tekseker](https://github.com/tekseker))
* Catalan (by [unxavi](https://github.com/unxavi))
* Czech (by [semanticer](https://github.com/semanticer))
* Hungarian (by [jbarat](https://github.com/jbarat))
* Korean (by [Alfex4936](https://github.com/Alfex4936))
* Swedish (by [Krillsson](https://github.com/Krillsson))
* Polish (by [karmil32](https://github.com/karmil32))
* Persian (by [mortezasun](https://github.com/mortezasun))
* Traditional Chinese (by [ppcrong](https://github.com/ppcrong))
* Serbian (by [ljmocic](https://github.com/ljmocic))
* Greek (by [jvoyatz](https://github.com/jvoyatz))
Please make a Pull request to add a new language.
## ProGuard
Nothing to include
## License
~~~
The MIT License (MIT)
Copyright (c) 2016 Mehdi Sakout
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.
~~~