NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
pub.dev · #5194 most downloaded on pub.dev
A Flutter package that implements Material Design Feature discovery to show a description of specific features to new users. See https://tinyurl.com/FeatureDiscovery
Last release 2 years ago
no release in 18 months
Ships unpredictably
gaps range from 2 weeks to 3.0 years
Nearly every release is documented
notes for 22 of 24 stable releases
Nothing withdrawn
no release was ever pulled
7 years old
24 releases · first in 2019
Updated All Dependencies versions
* Updated Provider version # Changelog
One column per quarter.
* Migrated to null safety
Introduce a PersistenceProvider interface for storing step completion in any mechanism the user wants.
* Clear Preferences issue fixed
Nothing published for this version
Nothing published for this version
Breaking change: isDisplayed is replaced by hasPreviouslyCompleted.
isDisplayed is replaced by hasPreviouslyCompleted.onComplete returned value will no longer be ignored, and the next overlay won't show if this function returns false.FeatureDiscovery.completeCurrentStep will force complete the current step and not execute the onComplete function.FeatureDiscovery have been removed.recordStepsInSharedPreferences in FeatureDiscovery to prevent step completions to be recorded in Shared Preferences.sharedPreferencesPrefix in FeatureDiscovery.Fixes a null pointer exception.
Fixes FeatureDiscovery position issue
Added FeatureDiscovery.isDisplayed method to check status of feature
FeatureDiscovery.isDisplayed method to check status of featureopenDuration flag that controls open animation duration.pulseDuration flag that controls tap target pulse animation duration.completeDuration flag that controls complete animation duration.dismissDuration flag that controls dismiss animation duration.Added barrierDismissible flag which decides whether the overlay should dismiss on touching outside or not.
barrierDismissible flag which decides whether the overlay should dismiss
on touching outside or not.Breaking change: FeatureDiscovery.completeCurrentStep is async now.
FeatureDiscovery.completeCurrentStep is async now.FeatureDiscovery.clearPreferencesBreaking change: removed deprecated static methods in FeatureDiscovery.
FeatureDiscovery.EnsureVisible constructor.FeatureDiscovery.dismissAll.activeFeatureId; replaced by currentFeatureIdOf to emphasize that this is a getter.FeatureDiscovery.dismiss; replaced by dismissAll to indicate that no next step
will be shown.assert to require at least one step to be passed to FeatureDiscovery.discoverFeatures.FeatureDiscovery has been updated.FeatureDiscovery widget is clearer.onDismiss returned Future<false> has been fixed.Update version constraint to ^4.0.1 for provider dependency.
^4.0.1 for provider dependency.Breaking change: Renamed ContentOrientation to ContentLocation.
ContentOrientation to ContentLocation.onComplete of type Future<bool> Function() to match onOpen
and onDismiss.completeStep and markStepComplete have been deprecated
and completeCurrentStep should now be used.clear is deprecated and dismiss should now be used.OverflowMode enum and the overflowMode parameter to DescribedFeatureOverlay
to control how the overlay should handle content that exceeds the background's boundaries.FeatureDiscovery.activeFeatureId, which allows you to get the feature id of the
current feature discovery step.duration, curve, and preciseAligment parameters to EnsureVisibleState.ensureVisible.EnsureVisible.duration and EnsureVisible.curve as parameters because they should
be passed when calling EnsureVisibleState.ensureVisible. This is not a breaking change.EnsureVisibleState.ensureVisible be Future<void>. This is not
a breaking change because the previous return type was void, which you cannot work with.enablePulsingAnimation respond to rebuilds, allowing to change it
after the overlay has been shown.README.md file of the package and the example.OverflowMode to README.md.CONTRIBUTING.md and mentioned it in README.md.Breaking change: Instead of the icon parameter, you now need to use the tapTarget parameter, which takes a Widget instead of IconData. Before: Describ…
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), ..)title and description parameters now take a Widget.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.DescribedFeatureOverlay's constantly rebuilding even if they were never displayed.DescribedFeatureOverlay's rebuilding after dismissing them.Theme.of(context) is now used to determine text stylesIterable for the steps to FeatureDiscovery.discoverFeatures.@required annotation to parameters that cannot be null.* Fixed animation bugs.
* Added ContentOrientation.
ContentOrientation.Consider landscape and portrait orientation in DescribedFeatureDiscoveryWidget.
DescribedFeatureDiscoveryWidget.Add EnsureVisible widget to scroll to target when it is in a scrollable container.
EnsureVisible widget to scroll to target when it is in a scrollable container.Applied Pub health suggestions.
Applied Pub health suggestions.
* Initial release.
Your coding agent can read these notes before it upgrades. Set up the MCP server →