UiTimeline class

A grouped, reverse-chronological activity timeline.

Events are grouped by their UTC calendar day. Use dayTotals together with onLoadMore to progressively reveal older events within individual days. Date and time label builders make the component localization-friendly without imposing an internationalization package on applications.

Inheritance

Constructors

UiTimeline({Key? key, required List<UiTimelineEvent> events, String emptyText = 'No activity yet.', Map<String, int> dayTotals = const {}, String? loadingDay, ValueChanged<String>? onLoadMore, UiTimelineLoadMoreLabelBuilder? loadMoreLabelBuilder, UiTimelineDateLabelBuilder? dateLabelBuilder, UiTimelineTimeLabelBuilder? timeLabelBuilder, String defaultMessageTitle = 'Message', DateTime? now})
const

Properties

dateLabelBuilder UiTimelineDateLabelBuilder?
final
dayTotals Map<String, int>
Total event count keyed by the UTC YYYY-MM-DD day.
final
defaultMessageTitle String
final
emptyText String
final
events List<UiTimelineEvent>
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingDay String?
final
loadMoreLabelBuilder UiTimelineLoadMoreLabelBuilder?
final
now DateTime?
Clock override used by relative day labels and deterministic tests.
final
onLoadMore ValueChanged<String>?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
timeLabelBuilder UiTimelineDateLabelBuilder?
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
createElement() StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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, int wrapWidth = 65}) 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