flutter_mini_app_bridge #

A Flutter package that provides a robust bridge between your Flutter SuperApp and web-based mini-apps. This package offers an easy way to register and invoke bridge methods on the Flutter side while seamlessly integrating with a JavaScript bridge.

Features #

• Bridge Method Registration: Register, invoke, and manage bridge methods with ease.
• Event Management: Listen for and dispatch events between Flutter and your mini-app.

Installation #

Add flutter_mini_app_bridge to your pubspec.yaml:

dependencies:
  flutter_mini_app_bridge: ^1.0.0+1

Then run:

flutter pub get

Usage #

Flutter Side #

1. Import the Package:

   import 'package:flutter_mini_app_bridge/flutter_mini_app_bridge.dart';
   

2. Create an Instance of the Bridge Controller:

   final bridgeController = MiniAppBridgeController(
     logger: (msg) => print(msg),
     methodTimeout: Duration(seconds: 30),
   );
   

3. Register a Bridge Method:

   bridgeController.registerMethod('exampleClass', 'exampleMethod', (params) async {
     return BridgeResponse.success({'result': 'Hello from Flutter!'});
   });
   

4. Process Incoming Requests:

   String response = await bridgeController.processRequest(messageFromMiniApp);
   // Send the response back to the mini-app
   

JavaScript Side #

1. Include the Script in Your HTML:

   <script src="https://unpkg.com/js-mini-app-bridge-plus@1.0.0/mini-app-bridge.min.js"></script>
   

2. Using the Bridge in Your Mini-App:

   superapp
     .call("exampleClass", "exampleMethod", { someParam: "value" })
     .then((response) => {
       console.log("Response from Flutter:", response);
     })
     .catch((error) => {
       console.error("Error calling Flutter method:", error);
     });
   

API Reference #

Flutter Bridge Controller #

• registerMethod(className, methodName, handler, {override}) Registers a bridge method.
• unregisterMethod(className, methodName) Unregisters a specific bridge method.
• processRequest(message) Processes an incoming mini-app request.
• createEventPayload(eventName, data) Creates a JSON payload for events.
• unregisterAllMethods() Clears all registered methods.

JavaScript Bridge #

• window.superapp.call(className, methodName, params?) Calls a native Flutter method.
• window.superapp.addListener(eventName, callback) Adds an event listener.
• window.superapp.removeListener(eventName, callback) Removes an event listener.
• window.superapp.getParams(key?) Retrieves stored parameters.
• window.superapp.receiveMessage(response) Processes incoming messages.

Contributing #

Contributions are welcome! Feel free to open issues or submit pull requests on GitHub.

License #

This project is licensed under the MIT License.