Gravatar-Android

The Gravatar Android SDK is a library that provides a set of UI components and utilities to fetch and display Gravatar images and profile data in Android applications.

If you're also looking to integrate Gravatar in your iOS app, check out our Gravatar SDK for iOS!

Features

• Avatar URL calculator based on email, email hash, and several query options.
• Ready-to-use asynchronous services for Gravatar REST API based on Kotlin Coroutines:
  • ProfileService to retrieve and update Gravatar user profiles.
  • AvatarService to retrieve, upload and update user's avatars.

• Display a user's avatar image through the Avatar component.
• Display a profile view through ready-to-use UI components.

• Quick Editor: This customizable sheet allows you to manage your avatar and Gravatar profile.
  • Authenticate with Gravatar.
  • Quick Editor scopes.

Installation

To add the Gravatar SDK to your project, you can use the following Gradle dependency:

dependencies {
    implementation("com.gravatar:gravatar:<version>")
    // OR
    implementation("com.gravatar:gravatar-ui:<version>")
    // OR
    implementation("com.gravatar:gravatar-quickeditor:<version>")
}

Additionally, if you're using version 2.3.1 or older of the SDK, you need to add custom Gradle repository:

repositories {
    maven {
        url = uri("https://a8c-libs.s3.amazonaws.com/android")
    }
}

For further details on how to integrate in your own app please take a look at our Get Started guide. You'll find a quick overview of how to get an API key and use the library in your projects.

Documentation

You can find some detailed articles, tutorials and API docs via these links:

• Getting started
• Gravatar docs
  • Uploading an Avatar
    • Let a user to update their avatar.
  • Fetching Profile Information
    • Fetch a public Gravatar profile.
  • AvatarURL Calculator
    • Create and validate Gravatar image URLs
• Gravatar UI docs
  • Avatar component
    • Use the Avatar component to display a user's avatar image.
  • Profile view designs
    • We offer a variety of profile view layouts for different usecases.
• Gravatar Quick Editor docs
  • Authentication
    • Set up the Gravatar OAuth2 to unlock some features.
  • Quick Editor
    • This customizable sheet allows users to update their avatars. Available for both UIKit and SwiftUI.

For those looking for a full API documentation: click here.

For Maintainers

If you're contributing to or maintaining this project, check out SDK's technical details.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

License

Gravatar-SDK-Android is an open source project covered by the Mozilla Public License Version 2.0.