Automattic/Gravatar-SDK-iOS

Features

Core services:

• Avatar URL calculator based on email, email hash, and several query options.
• Avatar downloading based on email or url.

- Built-in image cache (with the ability to inject your own cache).

• Avatar uploading to a Gravatar account.
• Gravatar profile fetching based on email.

Gravatar UI:

• Display a profile view or an avatar through ready-to-use UI components.
• Quick Editor: This customizable sheet allows you to manage your avatar and Gravatar profile.

- Select an existing avatar or upload a new one. - Manage and update the "About" section of your Gravatar profile.

• UIImageView extension to directly set the downloaded image.
• SwiftUI Avatar component(AvatarView)

Tutorials

• Profile views as contacts list
• Adding the Quick Editor to a SwiftUI View

Installation

Create an API key

Follow the steps in the REST API documentation to create a Gravatar API key. You can use some features without an API Key, but you’ll receive limited information, and stricter rate limits may apply, so we highly encourage you to create one in the developer portal.

For installation instructions and examples, see out getting started guide.

Documentation

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

• Gravatar docs

- Getting started - Install and start using Gravatar for iOS - Downloading an Avatar - Download an avatar provided by Gravatar. - 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

• GravatarUI docs

- Getting started - Install and start using GravatarUI for iOS - UIImageView extension - Use UIImageView extension to easily set an avatar. - SwiftUI AvatarView - A customizable SwiftUI component to easily set an avatar. - Profile view designs - We offer a variety of profile view layouts for different usecases. - Gravatar OAuth - 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.

Author

Gravatar

Coding Style

Check out our Coding Style guide.

Contributing

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

License

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

Package Metadata

Repository: Automattic/Gravatar-SDK-iOS

Homepage: https://gravatar.com

Stars: 120

Forks: 34

Open issues: 11

Default branch: trunk

Primary language: swift

License: MPL-2.0

Topics: gravatar

README: README.md