The Gleap SDK for Flutter is the easiest way to integrate Gleap into your apps. Communicate with your users directly and build better software by discovering their everyday pain points. Gleap is your all-in-one customer feedback tool for apps and websites. For the SDK to work, you need an API key, which you can get for free at app.gleap.io.

​
Supported platforms

✅ iOS✅ Android✅ Web

​
🏗 Installation

Open a terminal window and navigate to the root folder of your iOS project.

​
Install the Gleap SDK

​
Run this command to add Gleap to your dependencies:

 flutter pub add gleap_sdk

​
Flutter v2 Support

If you are using Flutter < v3, please import the gleap_sdk as shown below: 
dependencies:
  gleap_sdk:
    git:
      url: https://github.com/GleapSDK/Flutter-SDK.git
      ref: flutter-v2

​
iOS installation

Navigate to your iOS project folder within the terminal and update your cocoapods by running: 
pod install

​
Android installation

Android should be already good to go. If theres a version conflict pls add the following to your android manifest: 
<manifest ... xmlns:tools="http://schemas.android.com/tools">
 <uses-sdk  android:minSdkVersion="21"
        tools:overrideLibrary="io.gleap.gleap_sdk"/>
 <application .... tools:overrideLibrary="io.gleap.gleap_sdk">
 ...
Important: Always have a look at your minSdkVersion on android and your minimum target version on iOS to keep them on the same minimum version gleap needs.

​
Web installation

Navigate to your web project folder and insert the following snippet as first element within the head tag of your index.html 
<script>
!function(){if(!(window.Gleap=window.Gleap||[]).invoked){window.GleapActions=[];var e=new Proxy({invoked:!0},{get:function(e,n){return"invoked"===n?e.invoked:function(){var e=Array.prototype.slice.call(arguments);window.GleapActions.push({e:n,a:e})}},set:function(e,n,t){return e[n]=t,!0}});window.Gleap=e;var n=document.getElementsByTagName("head")[0],t=document.createElement("script");t.type="text/javascript",t.async=!0,t.src="https://sdk.gleap.io/latest/index.js",n.appendChild(t)}}();
</script>
Please note that you must need to run flutter clean and flutter pub get after adding the Gleap script to your index.html file.

​
Configure the SDK

The last step is to initialize & configure the Gleap SDK by adding the following code. If you want to add the Gleap SDK in your main.dart make sure to call WidgetsFlutterBinding.ensureInitialized(); before you initialize the Gleap SDK. 
Gleap.initialize(token: 'YOUR_API_KEY');
Congratulations 🎉 You are all set 👋

​
Required permissions (Android)

In order to use the image picker for attachments, add the following permissions to your AndroidManifest.xml. 
<uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
<uses-permission android:name="android.permission.READ_MEDIA_VISUAL_USER_SELECTED"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" />
The following permissions are needed to enable audio recordings. 
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-feature android:name="android.hardware.audio.pro" />
<uses-feature android:name="android.hardware.microphone"/>

​
Required permissions (iOS)

In order to use the image picker for attachments, add the following permissions to your Info.plist. 
<key>NSPhotoLibraryUsageDescription</key> <string>We need access to your photo library to allow you to select an image.</string> 

<key>NSCameraUsageDescription</key> <string>We need access to your camera to take photos.</string>
The following permissions are needed to enable audio recordings. 
<key>NSMicrophoneUsageDescription</key> <string>We need access to your microphone to record audio with videos.</string>

​
🤝 Need help?

We are here to help! hello@gleap.io