appsonair_flutter_appremark 0.3.0

AppsOnAir AppRemark flutter sdk allows you to capture current screen on device shake directly through AppsOnAir.

AppsOnAir-flutter-AppRemark

⚠️ Important Notice ⚠️

The plugin is fully functional and integrates with our AppRemark service, which is currently in public beta. While you can start using it today, please note that there may be minor changes or improvements as we prepare for full production launch.

How it works?

This SDK is used to submit AppRemark (Either it is bug/issue or any suggestion/feedback of your app).

AppsOnAir offers a service to monitor your problems or app recommendations/improvements by taking screenshots of your apps when you shake your device.

When you shake the device, it automatically takes screenshots of your apps. By modifying those app screenshots, users can draw attention to the specific problems or any app suggestions for enhancements.

Users have the option to turn off shakeGesture. They can also manually open the "Add Remark" screen.

To learn more about AppsOnAir AppRemark, please visit the AppsOnAir website

Minimum Requirements

• Android Gradle Plugin (AGP): Version 8.0.2 or higher
• Kotlin: Version 1.7.10 or higher
• Gradle: Version 8.0 or higher

Android Setup

Add meta-data to the app's AndroidManifest.xml file under the application tag.

Make sure meta-data name is “AppsonairAppId”.

Provide your application id in meta-data value.

</application>
    ...
    <meta-data
        android:name="AppsonairAppId"
        android:value="********-****-****-****-************" />
</application>

Add below code to setting.gradle.

pluginManagement {
    ...
    repositories {
        google()
        mavenCentral()
        gradlePluginPortal()
        maven { url 'https://jitpack.io' }
    }
}

Add below code to your root level build.gradle.

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

Add below code to your Launcher activity.

Add the following code because Fluter is preventing the SDK from capturing the current screen.

import io.flutter.embedding.android.RenderMode

class MainActivity : FlutterActivity(){
    override fun getRenderMode(): RenderMode {
        return RenderMode.texture
    }
}

Requirements

Minimum deployment target: iOS 14.0

iOS Setup

Add your application ID in Info.plist:

<key>AppsonairAppId</key>
<string>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</string>

For more details on how to get your application ID, check this URL.

Add the photo library permission to your Info.plist:

<key>NSPhotoLibraryUsageDescription</key>
<string>$(PRODUCT_NAME) need permission to choose image from gallery for AppRemark feature.</string>

---

iOS Dependency Manager

This plugin supports both CocoaPods and Swift Package Manager (SPM). SPM support requires Flutter 3.24.0 or higher.

By default, CocoaPods is used. You can control which dependency manager your project uses by adding the following to your app's pubspec.yaml:

Option 1 — CocoaPods (default)

Use this if you want to always use CocoaPods regardless of any global Flutter setting:

# pubspec.yaml
flutter:
  config:
    # false → always uses CocoaPods (default)
    enable-swift-package-manager: false

No other steps needed. Run:

flutter pub get
cd ios && pod install

Option 2 — Swift Package Manager

Requires Flutter ≥ 3.24.0. SPM support on iOS is available starting from this version.

Use this to opt into SPM and use AppsOnAir-iOS-AppRemark via Swift Package Manager:

# pubspec.yaml
flutter:
  config:
    # true → uses Swift Package Manager
    enable-swift-package-manager: true

Then run:

flutter pub get

Flutter will automatically resolve AppsOnAir-iOS-AppRemark v1.2.1 via SPM. No additional Xcode configuration is required.

Note: You can also enable SPM globally for all your Flutter projects (instead of per-project) by running:

flutter config --enable-swift-package-manager

In that case, you can remove the config block from pubspec.yaml entirely and Flutter will use SPM automatically.

Summary

enable-swift-package-manager	Flutter version	Result
false	any	CocoaPods — uses
true	≥ 3.24.0	SPM — uses
not set	any (global off)	CocoaPods — default behaviour
not set	≥ 3.24.0 (global on)	SPM — Flutter global setting applies

💡 Recommendation: We recommend migrating to Swift Package Manager — it is Apple's official, actively maintained dependency manager and receives updates first.

---

Example

Follow this step to add AppRemark using shakeGesture with the default theme of "Add Remark" screen.

 @override
  void initState() {
    super.initState();
    Future.delayed(const Duration(milliseconds: 100), () async {
      await AppRemarkService.initialize(context,
        onRemarkResponse: (result) {
        // Handle response here
       },
      );
    });
  }

Follow this step to add AppRemark using shakeGesture with the custom theme of "Add Remark" screen.

Here users can customize the theme of "Add Remark" screen according to their app theme by passing "options" inform of Map, which contains key-value pair of user's theme data.

Users have to pass given keys into "options". Using "options", this SDK will set the theme of "Add Remark" screen.

Make sure keys are same as below.

Key	DataType	Value	Description
pageBackgroundColor	String	"#E8F1FF"	Set page background color
appBarBackgroundColor	String	"#E8F1FF"	Set appbar background color
appBarTitleText	String	"Add Remark"	Set appbar title text
appBarTitleColor	String	"#000000"	Set appbar title color
remarkTypeLabelText	String	"Remark Type"	Set remark type label text
descriptionLabelText	String	"Description"	Set description label text
descriptionHintText	String	"Add description here..."	Set description hint text
descriptionMaxLength	int	255	Set description max length
buttonText	String	"Submit"	Set button text
buttonTextColor	String	"#FFFFFF"	Set button text color
buttonBackgroundColor	String	"#007AFF"	Set button background color
labelColor	String	"#000000"	Set textfield label color
hintColor	String	"#B1B1B3"	Set textfield hint color
inputTextColor	String	"#000000"	Set textfield input text color

AppRemarkService.initialize(
    context,
    options: {
        'pageBackgroundColor': '#FFC0CB',
        'descriptionMaxLength': 25,
    },
    onRemarkResponse: (result) {
    // Handle response here
     },
);

"shakeGestureEnable" is set to true by default, allowing the device to capture your current screen when it shakes. If it is false, the device shake's auto-capture screen will be disabled.

AppRemarkService.initialize(
    context,
    shakeGestureEnable: false,
    onRemarkResponse: (result) {
     // Handle response here
     },
);

Follow this step to open AppRemark screen manually,

AppRemarkService.addRemark(context);

Follow this step to send your customize payload, which you want to save in order to monitor your app.

Users have to pass "extraPayload" inform of Map, which contains key-value pair of user's additional meta-data.

await AppRemarkService.setAdditionalMetaData(extraPayload: {
      "userName": "USER_NAME",
      "userId": "USER_ID"});

Note: Call the setAdditionalMetaData method whenever you want to add or update details