Flutter SDK

A Flutter SDK for integrating the Longswipe Widget into your application. Provides both a widget-based approach and a controller-based approach for maximum flexibility.

Installation

dependencies:
  longswipe: ^1.0.1

Integration Options

This SDK provides two ways to integrate the Longswipe Widget:

1. LongswipeWidget: A ready-to-use widget with built-in UI
2. LongswipeController: A flexible controller for custom UI implementations

LongswipeWidget

A lightweight widget that loads the Longswipe Widget script and provides a simple interface with built-in UI for integrating the widget into your application.

import 'package:flutter/material.dart';
import 'package:longswipe/longswipe.dart';

class PaymentScreen extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Payment')),
      body: Center(
        child: LongswipeWidget(
          apiKey: 'your_api_key_here',
          referenceId: 'unique-transaction-id',
           environment: Environment.sandbox,
          onResponse: (type, data) {
            switch (type) {
              case ResType.success:
                print('Success: $data');
                break;
              case ResType.error:
                print('Error: $data');
                break;
              case ResType.close:
                print('Widget closed');
                break;
              case ResType.start:
                print('Widget started');
                break;
              case ResType.loading:
                print('Widget loading');
                break;
            }
          },
          defaultCurrency: Currency.USDT,
          defaultAmount: 100,
          buttonText: 'Pay with Longswipe',
        ),
      ),
    );
  }
}

Image samples

Properties

Property	Type	Required	Description
apiKey	String	Yes	Your Longswipe API key
environment	Environment	Yes	Production or sandbox (Environment.sandbox Or Environment.production)
referenceId	String	Yes	Unique identifier for the transaction
onResponse	Function<ResType, dynamic>	Yes	Callback function for widget events
defaultCurrency	Currency	No	Default currency for redemption
defaultAmount	double	No	Default amount for redemption
config	Map<String, dynamic>	No	Additional configuration options
metaData	Map<String, dynamic>	No	Metadata to pass to the widget
child	Widget	No	Optional child widget as the trigger
buttonText	String	No	Optional custom text for the default button
buttonStyle	ButtonStyle	No	Optional custom style for the default button

Response Types

The onResponse callback receives a type parameter that can be one of the following:

Type	Description
success	Widget operation completed successfully
error	An error occurred during widget operation
close	Widget was closed by the user
start	Widget has started and is ready
loading	Widget is loading

LongswipeController

A flexible controller that provides more control over the Longswipe Widget integration, allowing you to create custom UI components.

import 'package:flutter/material.dart';
import 'package:longswipe/longswipe.dart';

class CustomPaymentScreen extends StatefulWidget {
  @override
  _CustomPaymentScreenState createState() => _CustomPaymentScreenState();
}

class _CustomPaymentScreenState extends State<CustomPaymentScreen> {
  late LongswipeController _controller;
  String _status = '';
  dynamic _result;

  @override
  void initState() {
    super.initState();
    _controller = LongswipeController(
      options: LongswipeControllerOptions(
        apiKey: 'your_api_key_here',
        environment: Environment.sandbox,
        referenceId: 'unique-transaction-id',
        defaultCurrency: Currency.USDT,
        defaultAmount: 100,
        metaData: {'source': 'flutter-app'},
        onResponse: _handleResponse,
      ),
    );
  }

  void _handleResponse(ResType type, dynamic data) {
    setState(() {
      _status = type.toValue();
      if (data != null) {
        _result = data;
      }
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(title: Text('Custom Payment')),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: [
            Text('Status: $_status'),
            SizedBox(height: 20),
            if (_result != null) ...[
              Text('Result:'),
              Text(_result.toString()),
              SizedBox(height: 20),
            ],
            ElevatedButton(
              onPressed: () => _controller.openModal(context),
              child: Text('Open Payment Modal'),
            ),
          ],
        ),
      ),
    );
  }
}

Controller Options

The LongswipeController constructor accepts a LongswipeControllerOptions object with the following properties:

Property	Type	Required	Description
apiKey	String	Yes	Your Longswipe API key
environment	Environment	Yes	Production or sandbox (Environment.sandbox Or Environment.production)
referenceId	String	Yes	Unique identifier for the transaction
onResponse	Function<ResType, dynamic>	Yes	Callback function for widget events
defaultCurrency	Currency	No	Default currency for redemption
defaultAmount	double	No	Default amount for redemption
config	Map<String, dynamic>	No	Additional configuration options
metaData	Map<String, dynamic>	No	Metadata to pass to the widget

Controller Methods and Properties

Name	Type	Description
openModal	Future<void>	Function to open the Longswipe payment modal
isLoaded	bool	Whether the Longswipe script has loaded successfully
isLoading	bool	Whether the Longswipe script is currently loading

Required Permissions

This package requires camera permissions for QR code scanning. You need to add the following to your app:

Android

Add the following permissions to your android/app/src/main/AndroidManifest.xml file:

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.CAMERA" />

iOS

Add the following to your ios/Runner/Info.plist file:

<key>NSCameraUsageDescription</key>
<string>This app needs camera access to scan QR codes for payment processing</string>

Request Permissions in Your App

It's recommended to request camera permissions at app startup:

import 'package:permission_handler/permission_handler.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();

  // Request camera permission at app startup
  await Permission.camera.request();

  runApp(MyApp());
}

Implementation Details

This package uses:

• flutter_inappwebview: For embedding a WebView with JavaScript integration
• permission_handler: For handling camera permissions

The implementation loads the Longswipe JavaScript widget in a WebView and communicates with it using JavaScript channels. When the user opens the payment modal, a new screen is presented with the WebView that handles the payment process.

Development

1. Clone the repository
2. Install dependencies:

   flutter pub get
3. Run the example app:

   cd example
   flutter run

License

MIT