UpgradePrompt class

Reusable paywall CTA that figures out the right destination based on the current user's plan, platform, and org membership.

Drop this into any screen where the user has hit an entitlement limit — it never shows purchase UI directly; it routes to the appropriate screen where StoreKit / Play Billing / Stripe Checkout lives.

if (!ent.canUseTeams) {
  return const UpgradePrompt(feature: 'Team analytics');
}
Inheritance
Available extensions

Constructors

UpgradePrompt({Key? key, String? feature, bool compact = false, String? orgId})
const

Properties

compact → bool
When true, render as a single-line inline banner instead of a card.
final
feature → String?
Human-readable feature name used in the message ("Team analytics requires the Team plan").
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
orgId → String?
Optional org-id scope. Pass the org whose screen is being gated so the upgrade CTA navigates to THAT org's billing page, not a fallback first org. For solo paywalls (e.g. settings screen) leave this null.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
build(BuildContext context, WidgetRef ref) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → ConsumerStatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → _ConsumerState
Creates the mutable state for this widget at a given 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