ProfilePage class

The ProfilePage widget is able to show the data of a user. By default the user is able to change this data. The widget has a couple of parameters listed below:

User will contain the data of the user which atleast contain a first name, last name and an avatar/image. Besides this information the ProfileData can be used to set custom user fields.

With the use of the service set by a ProfileService some actions can be determined what should occur when the user does the following actions: Deleting/editing the profile or uploading an image.

The style can be used the set some style options regarding the whole form. This is done by setting a ProfileStyle. The following styling can be set: The style of the avatar, the padding of the page and default padding between items.

CustomAvatar can be set to override the standard avatar using any Widget.

ShowAvatar can be set using a bool to determine whether the avatar should be shown and be able to be set by the user. Default set to true.

BottomActionText sets the text for the inkwell at the bottom of the page. If this is set the null then the InkWell is disabled.

ItemBuilder is used to determine how the user data is represented.

ItemBuilderOptions can be used to just set the settings for fields instead of defining the field itself and how it is used. This field should not be used when the itemBuilder is set.

Inheritance

Constructors

ProfilePage({required User user, required ProfileService service, Key? key, ProfileStyle style = const ProfileStyle(), Widget? customAvatar, bool showAvatar = true, Color? avatarBackgroundColor, bool showItems = true, ItemBuilder? itemBuilder, ItemBuilderOptions? itemBuilderOptions, String? bottomActionText, List<String> prioritizedItems = const [], bool showDefaultItems = true, Widget wrapItemsBuilder(BuildContext context, Widget child)?, WrapViewOptions? wrapViewOptions, Map<String, Widget>? extraWidgets, GlobalKey<FormState>? formKey, ChangePasswordConfig changePasswordConfig = const ChangePasswordConfig(enablePasswordChange: false)})
const

Properties

avatarBackgroundColor → Color?
The background color of the avatar when no image is available.
final
bottomActionText → String?
Sets the text for the InkWell at the bottom of the profile page. The InkWell is disabled when null.
final
changePasswordConfig → ChangePasswordConfig
Configuration to give the user the option to change his/her password.
final
customAvatar → Widget?
The way to override the standard avatar is needed.
final
extraWidgets → Map<String, Widget>?
The map of extra widgets that might want to be added like empty SizedBoxes for styling.
final
formKey → GlobalKey<FormState>?
Use the form key to save on any custom callback
final
hashCode → int
The hash code for this object.
no setterinherited
itemBuilder → ItemBuilder?
Itembuilder is used the build each field in the user.
final
itemBuilderOptions → ItemBuilderOptions?
Used to set settings of each field in user.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
prioritizedItems → List<String>
Map keys of items that should be shown first before the default items and the rest of the items.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
service → ProfileService
The service the determine what should happen when the user takes action.
final
showAvatar → bool
Whether to show the users avatar.
final
showDefaultItems → bool
Shows textfields for firstname and lastname if is set to true
final
showItems → bool
Whether you want to show the input fields, sometimes you just want to edit the avatar.
final
style → ProfileStyle
Style to set some general styling parameters fot the whole page.
final
user → User
User containing all the user data.
final
wrapItemsBuilder → (Widget Function(BuildContext context, Widget child)?)
Customize the parent widget for all fields
final
wrapViewOptions → WrapViewOptions?
Edit the direction and spacing between every item
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ProfilePage>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited