Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jrvansuita/materialabout

🔖 It's a material-design about screen to use on your Android apps. A developer profile and application information easy to integrate.
https://github.com/jrvansuita/materialabout

about about-app about-me actions android android-library android-ui app-info avatar developer-tools java links material material-design material-ui profile social-media social-network

Last synced: about 1 month ago
JSON representation

🔖 It's a material-design about screen to use on your Android apps. A developer profile and application information easy to integrate.

Host: GitHub
URL: https://github.com/jrvansuita/materialabout
Owner: jrvansuita
License: mit
Created: 2017-02-12T16:41:05.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2023-03-30T00:24:06.000Z (over 1 year ago)
Last Synced: 2024-09-29T23:23:56.550Z (about 1 month ago)
Topics: about, about-app, about-me, actions, android, android-library, android-ui, app-info, avatar, developer-tools, java, links, material, material-design, material-ui, profile, social-media, social-network
Language: Java
Homepage:
Size: 4.98 MB
Stars: 1,525
Watchers: 38
Forks: 209
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        






# Material About

This is an [**Android**](https://developer.android.com) project. You, as a mobile developer, can use this library to show a material about screen in your apps.

It was built to make your life easier when introducing you to your users, and also, to create an about screen pattern for material android apps. It's really simple and dynamic, check it out.

##### Note: If you're missing some feature please let me know. Or even better, create a pull request. Also, I'm needing some help to translate the strings.xml to other languages.

##### Supported Languages: 🇺🇸 🇧🇷 🇪🇸 🇮🇹 🇷🇺 🇩🇪 :cn: :tr: 🇺🇦 🇫🇷 🇦🇪 🇰🇷

[![JitPack](https://jitpack.io/v/jrvansuita/MaterialAbout.svg)](https://jitpack.io/#jrvansuita/MaterialAbout)

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-MaterialAbout-green.svg?)](https://android-arsenal.com/details/1/4614) [![MaterialUp](https://img.shields.io/badge/MaterialUp-MaterialAbout-6ad0d9.svg?)](https://www.uplabs.com/posts/material-about) 

# Sample app

 This library has a lot more customization and features than is able to show here. Please check the sample app and feel free to help with a pull request. You can take a look at the sample app [located on this project](/app/).



[![Appetize.io](https://img.shields.io/badge/Apptize.io-Run%20Now-brightgreen.svg?)](https://appetize.io/embed/3b4dpd5kv90mpa67mp5h8mugc0?device=nexus7&scale=50&autoplay=true&orientation=portrait&deviceColor=black) [![Demo](https://img.shields.io/badge/Demo-Download-blue.svg)](http://apk-dl.com/dl/com.vansuita.materialabout.sample) 

 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/118bb89e3bed43e2b462201654224a60)](https://www.codacy.com/app/jrvansuita/MaterialAbout?utm_source=github.com&utm_medium=referral&utm_content=jrvansuita/MaterialAbout&utm_campaign=Badge_Grade) 

 

# Setup

This library requires `minSdkVersion` to be set to `14` or above, like the [Official Support Library](https://developer.android.com/topic/libraries/support-library/index.html#api-versions).

#### Step #1. Add the JitPack repository to your build file:

```gradle

allprojects {

    repositories {

	...

	maven { url "https://jitpack.io" }

    }

}

```

#### Step #2. Add the dependency ([See latest release](https://jitpack.io/#jrvansuita/MaterialAbout)).

```groovy

dependencies {

       compile 'com.github.jrvansuita:MaterialAbout:+'

}

```

# Implementation

Create a [AboutView](/library/src/main/java/com/vansuita/materialabout/views/AboutView.java) instance with [AboutBuilder](/library/src/main/java/com/vansuita/materialabout/builder/AboutBuilder.java).

```java

@Override

protected void onCreate(Bundle savedInstanceState) {

    super.onCreate(savedInstanceState);

    AboutView view = AboutBuilder.with(this)

                 .setPhoto(R.mipmap.profile_picture)

                 .setCover(R.mipmap.profile_cover)

                 .setName("Your Full Name")

                 .setSubTitle("Mobile Developer")

                 .setBrief("I'm warmed of mobile technologies. Ideas maker, curious and nature lover.")

                 .setAppIcon(R.mipmap.ic_launcher)

                 .setAppName(R.string.app_name)

                 .addGooglePlayStoreLink("8002078663318221363")

                 .addGitHubLink("user")

                 .addFacebookLink("user")

                 .addFiveStarsAction()

                 .setVersionNameAsAppSubTitle()

                 .addShareAction(R.string.app_name)

                 .setWrapScrollView(true)

                 .setLinksAnimated(true)

                 .setShowAsCard(true)

                 .build();

    addContentView(view, layoutParams);

}

```

# Additional

### Getting the list of actions or links from AboutBuilder.

```java

AboutBuilder aboutBuilder = AboutBuilder.with(this);

List actions = aboutBuilder.getActions();

List links = aboutBuilder.getActions();

```

#### Getting the view instance of any action or link from AboutView?

```java

AboutView view = AboutBuilder.with(this)

                 ...

                 .build();

View lastLinkView = view.findItem(builder.getLastLink());

View lastActionView = view.findItem(builder.getLastAction());

```

# Used libraries

* [com.android.support:appcompat-v7](https://developer.android.com/topic/libraries/support-library/packages.html#v7-appcompat)

* [com.android.support:cardview-v7](https://developer.android.com/topic/libraries/support-library/packages.html#v7-cardview)

* [com.github.jrvansuita:IconHandler](https://github.com/jrvansuita/IconHandler)

#