updatify_flutter library

Classes

PingColor

Preset colors for the default ping indicator.

UpdatifyConfig

Project-level widget settings returned alongside the updates list.

UpdatifyPost

UpdatifyPostDecoration

A class that holds decoration styling for an Updatify post.

UpdatifyService

Client for the Updatify API.

UpdatifyTrigger

A tappable control that opens the Updatify updates dialog and signals when unseen updates are available.

UpdatifyUpdates

The full result of fetching a project's updates: the posts plus the project config.

UpdatifyWidget

A widget that fetches and displays a list of Updatify posts from the remote API.

Enums

ChipPosition

Enum representing the position of a chip in the UI.

PostType

UpdatifyPopupType

How UpdatifyTrigger presents the updates: as a centered modal dialog (showUpdatifyDialog) or a bottom sheet (showUpdatifyBottomSheet).

VoteType

A reaction a user can cast on an update.

Constants

kDefaultChipColors → const Map<PostType, Color>

Default base color for each PostType's chip.

kDefaultUpdatifyTitle → const String

The title shown when neither a caller-supplied title nor a server-provided UpdatifyConfig.widgetTitle is available.

Functions

showUpdatifyBottomSheet(BuildContext context, {required String projectId, UpdatifyPostDecoration itemDecoration = const UpdatifyPostDecoration(), Widget itemBuilder(BuildContext, UpdatifyPost)?, WidgetBuilder? dividerBuilder, ScrollController? controller, bool reverse = false, ScrollPhysics? physics, Color? backgroundColor, double? elevation, Color? barrierColor, BorderRadiusGeometry? borderRadius, double heightFactor = 0.85, bool isScrollControlled = true, bool showDragHandle = false, bool useSafeArea = true, bool isDismissible = true, bool enableDrag = true, String? title, TextStyle? titleStyle, EdgeInsetsGeometry? titlePadding, Decoration? titleDecoration, bool showCloseButton = true, Color? closeButtonColor, ButtonStyle? closeButtonStyle, EdgeInsetsGeometry? contentPadding, UpdatifyService? service, bool enablePostViewTracking = true, UpdatifyVoteBuilder? voteBuilder}) → Future<void>

Presents a list of Updatify posts in a modal bottom sheet.

showUpdatifyDialog(BuildContext context, {required String projectId, UpdatifyPostDecoration itemDecoration = const UpdatifyPostDecoration(), Widget itemBuilder(BuildContext, UpdatifyPost)?, WidgetBuilder? dividerBuilder, ScrollController? controller, bool reverse = false, ScrollPhysics? physics, Color? backgroundColor, double? elevation, ShapeBorder? shape, BorderRadiusGeometry? borderRadius, EdgeInsets? insetPadding, String? semanticLabel, bool barrierDismissible = true, Color? barrierColor, String? barrierLabel, String? title, TextStyle? titleStyle, EdgeInsetsGeometry? titlePadding, Decoration? titleDecoration, bool showCloseButton = true, Color? closeButtonColor, ButtonStyle? closeButtonStyle, EdgeInsetsGeometry? contentPadding, EdgeInsetsGeometry? contentMargin, double? width, UpdatifyService? service, bool enablePostViewTracking = true, UpdatifyVoteBuilder? voteBuilder}) → Future<void>

Displays a dialog containing a list of Updatify posts fetched from the API.

Typedefs

DateStringFormatter = String Function(DateTime)

UpdatifyTriggerBuilder = Widget Function(BuildContext context, bool hasNewUpdates, VoidCallback openUpdates)

Builds the trigger's visible control.

UpdatifyVoteBuilder = Widget Function(BuildContext context, VoteType? currentVote, void onVote(VoteType vote))

Builds the vote control shown on each post.