Supabase Flutter

The authentication example demonstrates several sign-in methods available in supabase_flutter. The following patterns are used:

• Email & password: Uses signUp, signInWithPassword, resetPasswordForEmail, and verifyOTP with OtpType.recovery followed by updateUser.
• Magic link & email OTP: Uses signInWithOtp(email: ...) followed by verifyOTP(type: OtpType.email).
• Phone (SMS OTP): Uses signInWithOtp(phone: ...) followed by verifyOTP(type: OtpType.sms).
• OAuth social: Uses signInWithOAuth for providers like Google, GitHub, and Apple. This requires configuring a redirectTo deep link (e.g., io.supabase.authexample://login-callback/) to return the user to the app.
• Anonymous: Uses signInAnonymously, which can later be upgraded to a permanent account using updateUser to add an email and password.
• Multi-factor authentication (MFA): Uses auth.mfa.enroll, challengeAndVerify, listFactors, and unenroll to manage TOTP factors.

Realtime allows you to receive live updates from your database.

Realtime as a Stream

You can convert a database query into a Stream using .stream(primaryKey: [...]).

Warning: When using StreamBuilder in Flutter, persist the stream in a StatefulWidget variable rather than constructing it inside the build method to prevent rapid rebuilds and connection loss.

Postgres Changes

Listen to specific table changes (Insert, Update, Delete) using onPostgresChanges on a channel.

Broadcast

Send low-latency messages between clients without hitting the database using sendBroadcastMessage and onBroadcast.

// Realtime as a Stream
class _MyWidgetState extends State<MyWidget> {
  final stream = supabase.from('countries').stream(primaryKey: ['id']);

  @override
  Widget build(BuildContext context) {
    return StreamBuilder<List<Map<String, dynamic>>>(stream: stream, builder: (context, snapshot) {
      // ...
    });
  }
}

// Postgres Changes
final myChannel = supabase.channel('my_channel');
myChannel
    .onPostgresChanges(
      event: PostgresChangeEvent.all,
      schema: 'public',
      table: 'countries',
      callback: (payload) {
        // Handle change
      },
    )
    .subscribe();

// Broadcast
await myChannel.sendBroadcastMessage(
  event: 'cursor-pos',
  payload: {'x': 30, 'y': 50},
);

To implement native Apple sign-in on iOS or macOS, use the sign_in_with_apple package alongside supabase_flutter.

1. Follow sign_in_with_apple setup instructions for iOS/macOS.
2. Add your app's Bundle ID to the Supabase Dashboard under Authentication -> Providers -> Apple.
3. Generate a raw nonce, hash it using SHA-256, and pass both the raw and hashed versions to the Apple credential request.
4. Use signInWithIdToken with OAuthProvider.apple to complete the Supabase authentication.

import 'package:sign_in_with_apple/sign_in_with_apple.dart';
import 'package:supabase_flutter/supabase_flutter.dart';

/// Performs Apple sign in on iOS or macOS
Future<AuthResponse> signInWithApple() async {
  final rawNonce = supabase.auth.generateRawNonce();
  final hashedNonce = sha256.convert(utf8.encode(rawNonce)).toString();

  final credential = await SignInWithApple.getAppleIDCredential(
    scopes: [
      AppleIDAuthorizationScopes.email,
      AppleIDAuthorizationScopes.fullName,
    ],
    nonce: hashedNonce,
  );

  final idToken = credential.identityToken;
  if (idToken == null) {
    throw const AuthException(
        'Could not find ID Token from generated credential.');
  }

  return signInWithIdToken(
    provider: OAuthProvider.apple,
    idToken: idToken,
    nonce: rawNonce,
  );
}