Skip to content

Latest commit

 

History

History
185 lines (137 loc) · 6.59 KB

README.md

File metadata and controls

185 lines (137 loc) · 6.59 KB

pub package package publisher GitHub code size

Avatar Plus

Avatar Plus is a Flutter wrapper for Multiavatar that allows you to generate and customize unique avatars easily. With up to 12 billion unique avatars possible, this package is perfect for creating profile pictures, gaming logos, or adding personalized touches to your design projects.

Features

  • Generate Unique Avatars: Create avatars based on any text input with just a click or a keyboard shortcut.
  • Customizable: Integrate and customize avatars in your Flutter applications.
  • Randomized Associations: Names and words are randomly assigned to avatars, ensuring each one is unique.
  • Free to Use: Use any generated avatar freely across various applications.

Demo

'Screen 1' 'Screen 3' 'Screen 2'

Sample Code

Here is a basic example demonstrating how to use the avatar_plus package with various customization options:

AvatarPlus("Jonny")            

Installation

Add the following line to your pubspec.yaml file under dependencies:

dependencies:
  avatar_plus: ^1.0.0

Then run:

flutter pub get

Usage

To use Avatar Plus in your Flutter application:

Import the Package

import 'package:avatar_plus/avatar_plus.dart';

Basic Example

Here's a simple example of how to generate an avatar using Avatar Plus:

import 'package:flutter/material.dart';
import 'package:avatar_plus/avatar_plus.dart';

void main() {
  runApp(const MyApp());
}

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Avatar Plus example',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: const Example(),
    );
  }
}

class Example extends StatelessWidget {
  const Example({super.key});

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      bottomNavigationBar: const Column(
        crossAxisAlignment: CrossAxisAlignment.center,
        mainAxisSize: MainAxisSize.min,
        children: [
          Text(
            "Avatar Plus",
            style: TextStyle(fontSize: 40),
          ),
          Text("Yudiz Solutions Limited © 2024"),
          SizedBox(
            height: 20,
          )
        ],
      ),
      body: Center(
        child: AvatarPlus(
          "jonny",
          height: MediaQuery.of(context).size.width - 20,
          width: MediaQuery.of(context).size.width - 20,
        ),
      ),
    );
  }
}

Additional Usage Examples

You can generate avatars in various formats using Avatar Plus:

1. Get Avatar as a String

String svgCode = AvatarPlusGen.instance.generate("Jonny");

2. Get Avatar String with Transparent Background

String svgCode = AvatarPlusGen.instance.generate("Jonny", trBackground: true);

3. Get Avatar as an SVG Widget

Widget svgWidget = AvatarPlus("Jonny", height: 100, width: 100);

4. Get Avatar SVG Widget with Transparent Background

Widget svgWidget = AvatarPlus("Jonny", trBackground: true, height: 100, width: 100);

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributors

All Contributors

YudizAndroidNaresh
YudizAndroidNaresh

🚇 ⚠️ 💻

Contributions

Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository if you would like to contribute to Avatar Plus.

Support

If you encounter any issues or have questions, feel free to open an issue on GitHub.

Visitors Count

Loading