It is a widget that uses the first few letters of a word to create an avatar with a set of basic functions.
Getting Started #
Add the plugin:
dependencies: ... avatar_letter: ^1.0.1
Basic Usage #
AvatarLetter( size: 200, backgroundColor: Colors.amber, textColor: Colors.black, fontSize: 100, upperCase: true, numberLetters: 1, letterType: LetterType.Circular, text: 'Test 01', ),
Customization (Optional) #
letterType - Sets the format of the avatar that can be: (Rectangle, circular, none). Default to Rectangle<br/> text - The text that will be used to extract the letters. Default to '?'<br/> textColor - Sets the color of the letters. Default to Black<br/> textColorHex - Sets the color of the letters from a valid hexadecimal code. Default to #ffffff<br/> backgroundColor - Represents the background color of the avatar. Default to Black <br/> backgroundColorHex - Represents the background color of the avatar from a valid hexadecimal code. Default to #000000<br/> numberLetters - Sets the number of letters to be extracted from the text. Default to 1 <br/> fontWeight - Sets the font style. Default to Bold <br/> fontFamily - Sets the font . fontSize - Sets the size of the letters within the avatar. Default to 16<br/> upperCase - Used to set the uppercase letters of the avatar. Default to False <br/> size - Sets the size of the avatar. Default to 50 <br/>
Use this package as a library
1. Depend on it
Add this to your package's pubspec.yaml file:
dependencies: avatar_letter: ^1.0.1
2. Install it
You can install packages from the command line:
$ flutter pub get
Alternatively, your editor might support
flutter pub get.
Check the docs for your editor to learn more.
3. Import it
Now in your Dart code, you can use:
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
We analyzed this package on Oct 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:
- Dart: 2.5.1
- pana: 0.12.21
- Flutter: 1.9.1+hotfix.4
Detected platforms: Flutter
References Flutter, and has no conflicting libraries.
lib/avatar_letter.dart. (-1 points)
lib/avatar_letter.dart reported 2 hints:
line 18 col 7: This class (or a class which this class inherits from) is marked as '@immutable', but one or more of its instance fields are not final: AvatarLetter.letterType, AvatarLetter.backgroundColor, AvatarLetter.backgroundColorHex, AvatarLetter.textColor, AvatarLetter.textColorHex, AvatarLetter.size
line 79 col 3: This function has a return type of 'String', but doesn't end with a return statement.
Maintain an example. (-10 points)
Create a short demo in the
example/ directory to show how to use this package.
Common filename patterns include
avatar_letter.dart. Packages with multiple examples should provide
For more information see the pub package layout conventions.