feature_discovery 0.6.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 90

feature_discovery #

This Flutter package implements Feature Discovery following the Material Design guidelines.

With Feature Discovery, you can add context to any UI element, i.e. any Widget in your Flutter app.
Here is a small demo of the example app:

Installing #

To use this package, follow the installing guide.

Usage #

FeatureDiscovery #

To be able to work with any of the global functions provided by the feature_discovery package, you will have to wrap your widget tree in a FeatureDiscovery widget.
There are many places where you can add FeatureDiscovery in your build tree, but the easiest to assure that it sits on top is to wrap your MaterialApp with it:

const FeatureDiscovery(
  child: MaterialApp(
   ...
  )
)

DescribedFeatureOverlay #

For every UI element (Widget) that you want to describe using Feature Discovery, you will need to add a DescribedFeatureOverlay.
This widget takes all the parameters for the overlay that will be displayed during Feature Discovery and takes the Widget you want to display the overlay about as its child.

Feature ids #

Every feature you describe should have a unique identifier, which is a String passed to the featureId parameter. You will also need to provide these ids when starting the discovery.

DescribedFeatureOverlay(
  featureId: 'add_item_feature_id', // Unique id that identifies this overlay.
  tapTarget: const Icon(Icons.add), // The widget that will be displayed as the tap target.
  title: Text('Add item'),
  description: Text('Tap the plus icon to add an item to your list.'),
  backgroundColor: Theme.of(context).primaryColor,
  targetColor: Colors.white,
  textColor: Colors.white,
  child: IconButton( // Your widget that is actually part of the UI.
    icon: cons Icon(Icons.add),
    onPressed: addItem,
  ),
);
Additional parameters

contentLocation #

This is ContentLocation.trivial by default, however, the package cannot always determine the correct placement for the overlay. In those cases, you can provide either of these two:

  • ContentLocation.below: Text is displayed below the target.

  • ContentLocation.above: Text is displayed above the target.

onComplete #

   onComplete: () async {
    // Executed when the tap target is tapped. The overlay will not close before
    // this function returns and after that, the next step will be opened.
    print('Target tapped.');
    // You can prevent completion by returning false.
    return true;
  },

onDismiss #

  onDismiss: () async {
    // Called when the user taps outside of the overlay, trying to dismiss it.
    print('Overlay dismissed.');
    // You can prevent dismissal by returning false.
    return true;
  },

onOpen #

  onOpen: () async {
    // This callback is called before the overlay is displayed.
    print('The overlay is about to be displayed.');
    // If you return false, the overlay will not be opened and the next step
    // will be attempted to open.
    return true;
  },

enablePulsingAnimation #

This is set to true by default, but you can disable the pulsing animation about the tap target by setting this to false.

allowShowingDuplicate #

If multiple DescribedFeatureOverlays have the same featureId, they will interfere with each other during discovery and if you want to display multiple overlays at the same time, you will have to set allowShowingDuplicate to true for all of them.

overflowMode #

This is OverflowMode.ignore by default, which will simply render the content you pass to title and description, even if it overflows the background area, i.e. the circle of the overlay. Alternatively, you can specify any of the following if you desire different behavior:

  • OverflowMode.clipContent will clip any content that is outside of the inner area (the background's circle).

  • OverflowMode.extendBackground will expand the background circle if necessary.

  • OverflowMode.wrapBackground will expand the background circle if necessary, but also shrink it if the content is smaller than the default background size.

FeatureDiscovery.discoverFeatures #

When you want to showcase your features, you can call FeatureDiscovery.discoverFeatures with the applicable feature ids. The features will be displayed as steps in order if the user does not dismiss them.
By tapping the tap target, the user will be sent on to the next step and by tapping outside of the overlay, the user will dismiss all queued steps.

FeatureDiscovery.discoverFeatures(
  context,
  const <String>{ // Feature ids for every feature that you want to showcase in order.
    'add_item_feature_id',
  },
);

If you want to display Feature Discovery for a page right after it has been opened, you can use SchedulerBinding.addPostFrameCallback in the initState method of your StatefulWidget:

@override
void initState() {
  // ...
  SchedulerBinding.instance.addPostFrameCallback((Duration duration) {
    FeatureDiscovery.discoverFeatures(
      context,
      const <String>{ // Feature ids for every feature that you want to showcase in order.
        'add_item_feature_id',
      },
    ); 
  });
  super.initState();
}

Other methods #

You can view the API reference for FeatureDiscovery to find other useful methods for controlling the Feature Discovery process programmatically.

EnsureVisible #

You can use the EnsureVisible widget to automatically scroll to widgets that are inside of scrollable viewports when they are described during Feature Discovery:

// You need to save an instance of a GlobalKey in order to call ensureVisible in onOpen.
GlobalKey<EnsureVisibleState> ensureVisibleGlobalKey = GlobalKey<EnsureVisibleState>();

// The widget in your build tree:
DescribedFeatureOverlay(
  featureId: 'list_item_feature_id',
  tapTarget: const Icon(Icons.cake),
  onOpen: () async {
    WidgetsBinding.instance.addPostFrameCallback((Duration duration) {
      ensureVisibleGlobalKey.currentState.ensureVisible();
      return true;
    });
  },
  title: Text('Cake'),
  description: Text('This is your reward for making it this far.'),
  child: EnsureVisible(
    key: ensureVisibleGlobalKey,
    child: const Icon(Icons.cake),
  ),
)

Notes #

In DescribedFeatureOverlay, tapTarget, title, and description can take any widget, but it is recommended to use an Icon for the tap target and simple Text widgets for the title and description. The package takes care of styling these widgets and having these as Widgets allows you to pass Keys, Semantics, etc.

Contributing #

If you want to start contributing to this package, it is recommended to refer to the contributing guide.

Gratitude #

Thanks to mattcarroll for their Flutter challenge about Feature Discovery on Fluttery.

0.6.0 #

  • Breaking change: Renamed ContentOrientation to ContentLocation.
  • Breaking change: Made onComplete of type Future<bool> Function() to match onOpen and onDismiss.
  • Methods completeStep and markStepComplete have been deprecated and completeCurrentStep should now be used.
  • Method clear is deprecated and dismiss should now be used.
  • Added an OverflowMode enum and the overflowMode parameter to DescribedFeatureOverlay to control how the overlay should handle content that exceeds the background's boundaries.
  • Added FeatureDiscovery.activeFeatureId, which allows you to get the feature id of the current feature discovery step.
  • Added duration, curve, and preciseAligment parameters to EnsureVisibleState.ensureVisible.
  • Deprecated EnsureVisible.duration and EnsureVisible.curve as parameters because they should be passed when calling EnsureVisibleState.ensureVisible. This is not a breaking change.
  • Made the return type of EnsureVisibleState.ensureVisible be Future<void>. This is not a breaking change because the previous return type was void, which you cannot work with.
  • Made the enablePulsingAnimation respond to rebuilds, allowing to change it after the overlay has been shown.
  • Added GIF demo of the package to the README.md file of the package and the example.
  • Updated example.
  • Added OverflowMode to README.md.
  • Added CONTRIBUTING.md and mentioned it in README.md.

0.5.0 #

  • Breaking change: Instead of the icon parameter, you now need to use the tapTarget parameter, which takes a Widget instead of IconData. Before: DescribedFeatureOverlay(icon: Icons.add, ..) After: DescribedFeatureOverlay(tapTarget: const Icon(Icons.add), ..)
  • Breaking change: title and description parameters now take a Widget.
  • Breaking change: Callbacks are now onOpen, onDismiss, and onComplete. onOpen and onDismiss need to return Future<bool> when specified to decide if the step should be open or dismissed respectively.
  • Fixed DescribedFeatureOverlay's constantly rebuilding even if they were never displayed.
  • Fixed DescribedFeatureOverlay's rebuilding after dismissing them.
  • Warning: Theme.of(context) is now used to determine text styles
  • Title and description can now be null.
  • Added option to disable pulsing animation.
  • Added parameter that is called when the overlay is dismissed.
  • Added parameters to change text color, target color, and icon color.
  • Added possibility to pass any Iterable for the steps to FeatureDiscovery.discoverFeatures.
  • Added the @required annotation to parameters that cannot be null.
  • Ensured that overlay for each step is only shown once at a time.
  • Removed unnecessary files.
  • Formatted files.
  • Updated the plugin description.

0.4.1 #

  • Fixed animation bugs.

0.4.0 #

  • Added ContentOrientation.

0.3.0 #

  • Consider landscape and portrait orientation in DescribedFeatureDiscoveryWidget.

0.2.0 #

  • Add EnsureVisible widget to scroll to target when it is in a scrollable container.

0.1.1 #

  • Applied Pub health suggestions.

0.1.0 #

  • Applied Pub health suggestions.

0.0.1 #

  • Initial release.

example/README.md

example #

Example app illustrating how feature_discovery could be used in your app.

Demo #

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  feature_discovery: ^0.6.0

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:feature_discovery/feature_discovery.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
81
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
90
Learn more about scoring.

We analyzed this package on Nov 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21
  • Flutter: 1.9.1+hotfix.6

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/src/rendering/custom_layout.dart.

Run flutter format to format lib/src/rendering/custom_layout.dart.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.2.2 <3.0.0
flutter 0.0.0
provider ^3.1.0 3.1.0+1
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.7 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
flutter_test
pedantic any