Flutter tagging approach

Flutter Tagging Approach:

🚧

Important:

Flutter SDK version 2.2.2 enables the option to add tagging from the Flutter side of your app. This is an optional feature that will be still improved upon, so please do provide any feedback you may have when testing.

This feature does not currently support Bottom Navigation or Tab Navigation for the tagging if using Navigator 1.0 or 2.0, however there is ongoing work on Navigator 2.0 that will tackle similar issues in the near future.

From the FlutterUXCam SDK version 2.2.2 you'll have now the option to add a FlutterUxcamNavigatorObserver to your app, which will enable capturing your routes (screens) for screen Tagging without having to manually tag them.

Follow the below steps to add this to your app:

  1. Inside your dart file import flutter_uxcam like this:
import 'package:flutter_uxcam/flutter_uxcam.dart';
  1. Make sure the config parameter enableAutomaticScreenNameTagging is set as false
  2. Add the observer:
  • If using Navigator 1.0:
MaterialApp(
   ...
   navigatorObservers: [
     FlutterUxcamNavigatorObserver(), 
   ],
   ...
 )
  • If using Navigator 2.0:

Add it to the observers for your Router.

(The below example is using GoRouter)

final GoRouter router = GoRouter(
    ...
 observers: [
    FlutterUxcamNavigatorObserver(),
 ],
    ...
)
  1. It is suggested you add names to your routes, otherwise some routes may show as default, i.e '/ '
GoRoute(
  path: {routeName},
  name: {Preferred Route Name},
  builder: (BuildContext context, GoRouterState state) {
    return ScreenName(key: state.pageKey);
  },
),