SetupScreen class

Onboarding screen shown when no Supabase instance is configured.

Offers two paths:

  • Quick Start: connect to the built-in demo instance (only available when the app was built with --dart-define demo credentials).
  • Self-Hosted: enter custom Supabase URL + anon key. On first connect, the bundled schema is applied via the Supabase Management API using a one-time access token (PAT or org token).
Inheritance
Available extensions

Constructors

SetupScreen({Key? key, VoidCallback? onConnected, SetupClientFactory? clientFactory, SupabaseProvisioner? provisioner, SchemaSqlLoader? schemaLoader, FunctionBundleLoader? functionLoader})
const

Properties

clientFactory → SetupClientFactory
Factory for the temporary client used by Test Connection.
final
functionLoader → FunctionBundleLoader
Loader for the bundled Edge Function source. Injected for tests.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onConnected → VoidCallback?
Called after Supabase is successfully initialized, so the app can rebuild with a new router that has supabaseReady: true.
final
provisioner → SupabaseProvisioner?
Provisioner used to apply the bundled schema via the Management API. Defaults to a plain SupabaseProvisioner (created lazily so tests can inject a stub).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaLoader → SchemaSqlLoader
Loader for the bundled schema SQL. Injected for tests.
final

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).
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<SetupScreen>
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, 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