Respond to button actions in Flutter SDK

If you are building flows or paywalls using the Adapty builder, it’s crucial to set up buttons properly:

1. Add a button in the builder and assign it either a pre-existing action or create a custom action ID.
2. Write code in your app to handle each action you’ve assigned.

This guide shows how to handle custom and pre-existing actions in your code.

Close flows and paywalls

To add a button that will close your flow or paywall, in the builder, add a button and assign it the Close action. No code is required: the default flowViewDidPerformAction implementation dismisses the view when it receives CloseAction.

Override flowViewDidPerformAction if you need custom behavior — for example, to also close the view on the Android system back button, as in v3:

void flowViewDidPerformAction(AdaptyUIFlowView view, AdaptyUIAction action) {
    switch (action) {
      case const CloseAction():
      case const AndroidSystemBackAction():
        view.dismiss();
        break;
      case OpenUrlAction(:final url, :final openIn):
        AdaptyUI().openUrl(url, openIn: openIn);
        break;
      default:
        break;
    }
}

Open URLs from flows and paywalls

To add a button that opens a link (e.g., Terms of use or Privacy policy), in the builder, add a button, assign it the Open URL action, and enter the URL you want to open.

No code is required: the default flowViewDidPerformAction implementation opens the URL natively via AdaptyUI().openUrl, honoring the in-app or external browser setting from the dashboard.

The default behavior is enough for most cases. If you still want to open URLs yourself, override the handler:

void flowViewDidPerformAction(AdaptyUIFlowView view, AdaptyUIAction action) {
    switch (action) {
      case const CloseAction():
        view.dismiss();
        break;
      case OpenUrlAction(url: final url):
        // Open the URL in whatever way fits your app
        break;
      default:
        break;
    }
}

Log into the app

To add a button that logs users into your app:

1. In the builder, add a button and assign it the Login action.
2. In your app code, implement a handler for the login action that identifies your user.

void flowViewDidPerformAction(AdaptyUIFlowView view, AdaptyUIAction action) {
    switch (action) {
      case CustomAction(action: 'login'):
        // Navigate to your login screen in whatever way fits your app
        break;
      default:
        break;
    }
}

Handle custom actions

To add a button that handles any other actions:

1. In the builder, add a button, assign it the Custom action, and assign it an ID.
2. In your app code, implement a handler for the action ID you’ve created.

For example, if you have another set of subscription offers or one-time purchases, you can add a button that will display another flow or paywall:

void flowViewDidPerformAction(AdaptyUIFlowView view, AdaptyUIAction action) {
   switch (action) {
     case CustomAction(action: 'openNewPaywall'):
       // Display another flow or paywall
       break;
     default:
       break;
   }
}

If you are building paywalls using the Adapty paywall builder, it’s crucial to set up buttons properly:

1. Add a button in the paywall builder and assign it either a pre-existing action or create a custom action ID.
2. Write code in your app to handle each action you’ve assigned.

This guide shows how to handle custom and pre-existing actions in your code.

Close paywalls

To add a button that will close your paywall:

1. In the paywall builder, add a button and assign it the Close action.
2. In your app code, implement a handler for the CloseAction and AndroidSystemBackAction actions.

void paywallViewDidPerformAction(AdaptyUIPaywallView view, AdaptyUIAction action) {
    switch (action) {
      case const CloseAction():
      case const AndroidSystemBackAction():
        view.dismiss();
        break;
      default:
        break;
    }
}

Open URLs from paywalls

To add a button that opens a link from your paywall (e.g., Terms of use or Privacy policy):

1. In the paywall builder, add a button, assign it the Open URL action, and enter the URL you want to open.
2. In your app code, implement a handler for the openUrl action that opens the received URL in a browser.

// You have to install url_launcher plugin in order to handle urls:
// https://pub.dev/packages/url_launcher
import 'package:url_launcher/url_launcher.dart';

void paywallViewDidPerformAction(AdaptyUIPaywallView view, AdaptyUIAction action) {
    switch (action) {
      case OpenUrlAction(url: final url):
        final Uri uri = Uri.parse(url);
        launchUrl(uri, mode: LaunchMode.inAppBrowserView);
        break;
      default:
        break;
    }
}

Log into the app

To add a button that logs users into your app:

1. In the paywall builder, add a button and assign it the Login action.
2. In your app code, implement a handler for the login action that identifies your user.

void paywallViewDidPerformAction(AdaptyUIPaywallView view, AdaptyUIAction action) {
    switch (action) {
      case CustomAction(action: 'login'):
        // Navigate to your login screen in whatever way fits your app
        break;
      default:
        break;
    }
}

Handle custom actions

To add a button that handles any other actions:

1. In the paywall builder, add a button, assign it the Custom action, and assign it an ID.
2. In your app code, implement a handler for the action ID you’ve created.

For example, if you have another set of subscription offers or one-time purchases, you can add a button that will display another paywall:

void paywallViewDidPerformAction(AdaptyUIPaywallView view, AdaptyUIAction action) {
   switch (action) {
     case CustomAction(action: 'openNewPaywall'):
       // Display another paywall
       break;
     default:
       break;
   }
}