Skip to content

RewLight/github_identicon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Identicon

A simple package for generating Github flavor Identicons.
There is also a out-of-box component for instant use.

Features

GithubIdenticonGenerator: The core of this package.
GithhbIdenticon: The out-of-box component.

Getting started

  1. add github_identicon: ^1.0.1 as a dependency in your pubspec.yaml;
  2. import and use it;
  3. maybe enjoy it I guess?

Usage

Both GithubIdenticon and GithubIdenticonGenerator have the same args:

class GitHubIdenticonGenerator {
final String seed;
final double size;
final bool showGrid;
final Color? color;
/// Creates a GitHub identicon generator
///
/// [seed] : Unique identifier for the avatar
/// [size] : Output image size in pixels
/// [showGrid] : Whether to display the 5x5 grid lines (default: false)
/// [color] : Optional color for the identicon. If it's null, color is generated from hash.

For example:

import 'package:github_identicon/github_identicon.dart';

GithubIdenticon(
  seed: "octocat",
  size: 256
)

That's it.

License

MIT License.

About

Github flavor Identicons for Flutter

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages