The Gleap SDK for Flutter is the easiest way to integrate Gleap into your apps!
Gleap helps developers build the best software faster. It is your affordable in-app bug reporting tool for apps, websites and industrial applications.
Checkout our website to learn more about gleap.
Checkout our documentation for full reference. Include the following dependency in your pubspec.yml:
dependencies:
gleap_sdk: "^16.4.3"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
Flutter v2 Support If you are using Flutter < v3, please import the gleap_sdk as shown below:
dependencies:
gleap_sdk:
git:
url: git@github.com:GleapSDK/Flutter-SDK.git
ref: flutter-v2
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.
iOS installation
Navigate to your iOS project folder within the terminal and update the cocoapods by typing
pod install
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(Gleap,t,i){if(!(Gleap=window.Gleap=window.Gleap||[]).invoked){for(window.GleapActions=[],Gleap.invoked=!0,Gleap.methods=["identify","setEnvironment","setTags","attachCustomData","setCustomData","removeCustomData","clearCustomData","registerCustomAction","trackEvent","log","preFillForm","showSurvey","sendSilentCrashReport","startFeedbackFlow","startBot","setAppBuildNumber","setAppVersionCode","setApiUrl","setFrameUrl","setRegion","setWSApiUrl","setRealtimeHost","setBannerUrl","setModalUrl","isOpened","open","close","on","setLanguage","setOfflineMode","initialize","disableConsoleLogOverwrite","logEvent","hide","enableShortcuts","showFeedbackButton","destroy","getIdentity","isUserIdentified","clearIdentity","openConversations","openConversation","openHelpCenterCollection","openHelpCenterArticle", "askAI","openHelpCenter","searchHelpCenter","openNewsArticle","openNews","openFeatureRequests","isLiveMode"],Gleap.f=function(e){return function(){var t=Array.prototype.slice.call(arguments);window.GleapActions.push({e:e,a:t})}},t=0;t<Gleap.methods.length;t++)Gleap[i=Gleap.methods[t]]=Gleap.f(i);Gleap.load=function(){var t=document.getElementsByTagName("head")[0],i=document.createElement("script");i.type="text/javascript",i.async=!0,i.src="https://sdk.gleap.io/latest/index.js",t.appendChild(i)},Gleap.load()}}();
</script>
Initialize Gleap SDK
Import the Gleap SDK by adding the following import inside one of your root components.
import 'package:gleap_sdk/gleap_sdk.dart';Gleap.initialize(token: 'YOUR_API_KEY')Your API key can be found in the project settings within Gleap.
Data regions
Projects hosted in the US data region select it before initializing. The default region is eu, so existing integrations need no change.
await Gleap.setRegion(region: 'us');
await Gleap.initialize(token: 'YOUR_API_KEY');setRegion sets the API, websocket and realtime hosts for the region at once; the static widget hosts are global and stay unchanged. For custom domains, the manual setters setApiUrl, setWSApiUrl, setRealtimeHost, setFrameUrl, setBannerUrl and setModalUrl are available. A manual setter called after setRegion overrides that single host.
On web, data regions require the loader snippet above (it queues the new methods until the JavaScript SDK has loaded).
Network logging
We support network logging for the packages Http and Dio. For details on how to enable network logging for these packages, check the Gleap Http Interceptor and the Gleap Dio Interceptor packages.