medyo

Android About Page

Create an awesome About Page for your Android App in 2 minutes
By medyo

android android-ui

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)
.setCustomFont(String) // or Typeface
.setImage(R.drawable.dummy_image)
.addItem(versionElement)
.addItem(adsElement)
.addGroup("Connect with us")
.addEmail("[email protected]")
.addWebsite("https://mehdisakout.com/")
.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
implementation 'io.github.medyo:android-about-page:2.0.0'


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 :



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|
| setSkipTint(Boolean) | Skip tinting the icon (useful when using non vector drawables)|
| 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|


6. How to use the library in a fragment

java
@Override
public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup container, @Nullable Bundle savedInstanceState) {
return new AboutPage(getContext())
.isRTL(false)
.setDescription(getString(R.string.app_description))
.addGroup(getString(R.string.contact_group))
.addEmail("[email protected]", "Email")
.addGroup(getString(R.string.application_information_group))
.addItem(new VersionElement())
.create();
}

snippet by nrhoffmann


7. Styling

The library supports day-night modes. The dependents may use the following
styling attributes to create a dedicated style for AboutPage. If the
dependents choose not to specify an explicit style, the library falls back to
sensible defaults.


First, declare an AboutPage style in your styles.xml.


```xml

#ffffff
#333333
#999999
@style/TextAppearance.App.AboutPage.Description


@style/about_elementTextAppearance.Dark
@style/about_groupTextAppearance

bold|italic

```


To apply this style globally, assign its reference to aboutStyle attribute in
your app theme.


```xml

@style/Widget.AboutPage

```


Or explicitly pass the style resource to the AboutPage constructor to apply it
on selective AboutPage instances.


java
AboutPage aboutPage = new AboutPage(context, R.style.Widget_AboutPage);


8. Force Night/Day mode

We recommend that the dependents use
AppCompatDelegate.setDefaultNightMode()
to force enable/disable the night mode across their apps. If the dependents are
unable to use the recommended approach, they can use the AboutPage(Context,
boolean)
constructor to specify the desired mode. The dependents must note that
by using this constructor, the AboutPage will use its default styles, ignoring
any explicitly specified style.


java
AboutPage aboutPage = AboutPage(context, true); // force enable dark mode.
AboutPage aboutPage = AboutPage(context, false); // force enable bright mode.


Sample Project

medyo/android-about-page/app/


Translations

The library does supports the following languages :



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.
~~~