Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 2.66 KB

README.md

File metadata and controls

85 lines (61 loc) · 2.66 KB
Raw

Avatars for Android Maven Central

This project provides a easy way to build avatar compositions for Android applications, as you can see in the screenshot.

Screenshot

Usage

Declare it into your pom.xml

<dependency>
    <groupId>net.sectorsieteg</groupId>
    <artifactId>avatars</artifactId>
    <version>1.0.0</version>
    <type>aar</type>
</dependency>

Or into your build.gradle

dependencies {
    compile 'net.sectorsieteg:avatars:1.0.0'
}

How to Use

Inside the layout, you only needs a ImageView in order to show the avatar.

    <ImageView
        android:id="@+id/avatar"
        android:layout_height="fill_parent"
        android:layout_width="fill_parent"/>

The AvatarDrawableFactory will abstract you about how the avatars are built. We will be able to create a rounded or a squared avatar from this entry point.

For the squared avatars depending of the number of images passed to the factory, a composition for one, two, three or four will be created. Returning the specific implementation for that case.

There are this types of compositions:

  • RoundedAvatarDrawable
  • BorderedRoundedAvatarDrawable
  • SquaredAvatarDrawable
  • DoubleSquaredAvatarDrawable
  • TripleSquaredAvatarDrawable
  • QuadrupleSquaredAvatarDrawable
BitmapFactory.Options options = new BitmapFactory.Options();
options.inMutable = false;
Bitmap avatar = BitmapFactory.decodeResource(getResources(), R.drawable.avatar, options);

AvatarDrawableFactory avatarFactory = new AvatarDrawableFactory(getResources());

Drawable avatarDrawable = avatarFactory.getSquaredAvatarDrawable(avatar, avatar);
ImageView avatarView = (ImageView)rootView.findViewById(R.id.avatar);
avatarView.setImageDrawable(avatarDrawable);

Contributors

License

Copyright 2014 Pedro Álvarez Fernández

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.