features_tour 0.6.2

features_tour: ^0.6.2 copied to clipboard

• Fixed the overlay level mismatch that blocked FeaturesTour button interactions.

• Use fvm to control the flutter version to make the code works as expected.
• Fix some code that only works in the newer flutter version.

• BREADKING CHANGE: Remove all deprecated methods.
• Bump version of dart sdk to ^3.7.0 and flutter to >=3.29.0.

• Bump very_good_analysis to v10.0.0.
• Release to stable.

• Adds FeaturesTourPadding to add a padding while introducing specific indexes.

• Fixes an issue where logging did not function as expected.

• Deprecates debugLog in the FeaturesTourController.start(debugLog) in favor of FeaturesTourController(debugLog).

• Adds onState callback to FeaturesTourController.start to receive [TourState] update during the tour lifecycle.

• Adds IntroduceConfig.builder so we can decor the introduce widget easily and globally.

• Adds RoundedRectIntroduceConfig that make the introducion looks better.

• Deprecates Predialog and predialog in favor of PreDialog and preDialog accoss the code base.

• Deprecates FeaturesTour.canPop in favor of FeaturesTourController.start(popToSkip).

• Deprecates PreDialogConfig.modifiedDialogResult in favor of PreDialogConfig.customDialogBuilder.

• Deprecates:

  • PreDialogConfig.applyToAllPagesText in favor of PreDialogConfig.applyToAllCheckboxLabel.
  • PreDialogConfig.applyToAllPagesTextColor in favor of PreDialogConfig.applyToAllCheckboxLabelStyle.
  • PreDialogConfig.acceptButtonText in favor of PreDialogConfig.acceptButtonLabel.
  • PreDialogConfig.laterButtonText in favor of PreDialogConfig.laterButtonLabel.
  • PreDialogConfig.dismissButtonText in favor of PreDialogConfig.dismissButtonLabel.

• Deprecates

  • ChildConfig.child in favor of ChildConfig.builder.
  • NextConfig.child in favor of NextConfig.builder.
  • SkipConfig.child in favor of SkipConfig.builder.
  • DoneConfig.child in favor of DoneConfig.builder.

• Reverses the order of the action buttons in the pre-dialog.

• Changes the PreDialogConfig.acceptTextLabel default text from Okay to Start Tour.

• Changes to use DefaultTextStyle.merge instead of DefaultTextStyle.

• Improves TYPO and grammar in logs.

• Changes to use very_good_analysis lints.

• Adds many base tests and many logic improvements while creating tests :).

This is a significant change with many deprecations, but I believe it’s worth it. Please let me know if there’s anything I should avoid changing.

• Enhance state update logic to check if the globalKey context is mounted in FeaturesChild.
• Refactor FeaturesTourController to manage cached states and improve state registration/unregistration logic.
• Refactor FeaturesTour to convert from StatelessWidget to StatefulWidget and manage registration/unregistration of the controller.
• Add a restart tour button to the example.

• Fix the issue that the enableAnimation is not applied correctly
• Fix the issue that makes the child scale even when the animation is disabled.

• Used the AnimationController instead of Timer.perodic.
• Improved the way to handle the nextIndex.
• Improved the way to handle the transition state.

• Deprecations:

  • Deprecated the waitForFirstIndex parameter in FeaturesTourController. Use firstIndex instead for improved clarity and consistency.
  • Deprecated the waitForFirstTimeout parameter in FeaturesTourController. Use firstIndexTimeout for better alignment with naming conventions.
  • Deprecated the waitForIndex parameter in FeaturesTour. Replaced with nextIndex for a more intuitive understanding.
  • Deprecated the waitForTimeout parameter in FeaturesTour. Use nextIndexTimeout for a clearer and more descriptive alternative.

• Updates:

  • Added a new "Flow" section to the README to provide a comprehensive overview of the FeaturesTour workflow, making it easier for users to understand and implement.
  • Enhanced the example.

• Deprecations:

  • Remove all old deprecated parameters (FeaturesTour.onPressed and SkipConfig.isCallOnPressed).

• Updates:

  • Enhanced the example.
  • Enhanced the README.

• Features:

  • BREAKING CHANGE: Automatically adapts to the app's dark/light theme.
  • Waits for the drawer animation to finish before proceeding.
  • Introduced onBeforeIntroduce and onAfterIntroduce parameters for enhanced control.

• Fixes:

  • Resolved the issue where waitForIndex would still activate even after users tapped the SKIP button.

• Deprecations:

  • Remove all old deprecated methods.

  • Deprecated the onPressed parameter in FeaturesTour in favor of onAfterIntroduce.

  • Deprecated the isCallOnPressed parameter in SkipConfig in favor of onAfterIntroduce(IntroduceResult):

    // This code
    FeaturesTour(
      skipConfig: SkipConfig(
        // We don't want to `doSomething` when users press the SKIP button
        isCallOnPressed: false,
      ),
      onPressed: () => doSomething(),
    )
    
    // Will become
    FeaturesTour(
      onAfterIntroduce: (result) {
        // We only want to `doSomething` when users press the NEXT or DONE buttons
        if (result == IntroduceResult.next || result == IntroduceResult.done) {
          doSomething();
        }
      }
    )
    

• Updates:

  • Enhanced the example for better clarity.
  • Updated the README to reflect the latest changes.

• Add debugLog parameter to the tourController.start method to enable or disable debug logging.
• Prevent screen flashing during the transition between two FeaturesTour instances by maintaining the background color.
• Fix the issue that makes the buttons (Next, Skip and Done) appear under the keyboard.
• Update the introduction video.

• Add canPop parameter to the FeaturesTour to control the PopScope.
• Add applyToAllPagesTextColor parameter to PredialogConfig to set the color for the Apply to all pages text.
• Improve the style of the pre-dialog checkbox and label.

• FeaturesTour is now a const.
• It's safe to wrap FeaturesTours with a FeaturesTour (It had the duplicated GlobalKey issue before).
• Add onAcceptButtonPressed, onLaterButtonPressed and onDismissButtonPressed to the Predialog to handle those button pressed callbacks.
• Refactor internal code.

• [Feat] Add an ability to show on top of all Overlays.
• [Refactor] Improve comments.

• Fixed the issue that make the package keeps introduce a widget even when waitForTimeout is reached.

• Fixed the issue that the tours run incorrectly when force is set to true.

• Add the enableAnimation to the ChildConfig to make it easier to enable/disable the animation.
• Update the topics.

• Improve the pub score.
• Small update for the example.

• The shapeBorder of the ChildConfig now works correctly.
• Auto apply the dark theme to the introduce widget with the applyDarkTheme parameter in the IntroduceConfig.
• Add a border to the outter child widget.

• Replace the showDialog with the Overlay to avoid hiding the keyboard.

• Rename and mark the old one as deprecated:
  • PredialogConfig.copyWith to PredialogConfig.
  • ChildConfig.copyWith to ChildConfig.
  • IntroduceConfig.copyWith to IntroduceConfig.
  • NextConfig.copyWith to NextConfig.
  • SkipConfig.copyWith to SkipConfig.
  • DoneConfig.copyWith to DoneConfig.
• Improve the way to print the debug log.
• Fix some TYPO.

• Fixed an issue caused barrierDismissible in the ChildConfig doesn't work properly.

• Avoid text overflowing for the applyToAllPagesText in the pre-dialog by using FittedBox.

• Update example.
• Add a demo website using the example on README.

• Fix: README typo. (Thanks @ashwinkey04)

• The Done button doesn't show correctly when it's called by a waitForIndex introduction.
• Automatically calculate the position of the introduce widget in QuadrantAlignment.top and bottom, so the introduce widget is always at the top/bottom center comparing to its child.
• Update example.

• Change to BSD 3-Clause License.
• Release to stable.

• Improves the Done button behavior when there is a new FeaturesTour is added.

• Add Done button to show on the last introduction (Next and Skip button will be hidden).
• index in FeaturesTour is required since this version.

• Fixes issue that the last state is not removed.

• Release to stable.

• Fix an issue related to enabled parameter.

• Caches the GlobalKey better.

• Avoid creating unnecessary new GlobalKey that causes issues (needs double taps to trigger a function).
• Avoid duplicating an introduction.

• Only add GlobalKey to the enabled FeaturesTour.

• Move waitForFirstIndex and waitForFirstTimeout from FeaturesTourController to start method.

• Change the context parameter in the start method from named to positioned parameter.

• Change to use StatelessWidget for FeaturesTour.

• Ignore the unmounted Widget correctly.

• Able to adapt with the transition of the Widget like the Drawer.

• Add an effective way to control the list of states to avoid the duplicated state issue.

• Migration:

  • Before:

  final tourController = FeaturesTourController(
    'Page', 
    waitForFirstIndex: 1.0,
    waitForFirstTimeout: const Duration(seconds: 4),
  );
  
  tourController.start(context: context);
  

  • Now:

  final tourController = FeaturesTourController('Page');
  
  tourController.start(
    context,
    waitForFirstIndex: 1.0,
    waitForFirstTimeout: const Duration(seconds: 3),
  );
  

• Fixes issue that the rect accept the null value causes infinity loading.

• Bump Dart min sdk to 3.0.0.

• The parameter child inside the ChildConfig is now passed with the "real" child, so we can easily modify the child widget.

  • Before:

  ChildConfig.copyWith(
    child: YourFakeChildWidget(),
  ),
  

  • Now:

  ChildConfig.copyWith(
    child: (child) {
      return YourFakeWidget(
        child: child,
      );
    },
  ),
  

• The Next button and Skip button are changed to ElevatedButton by default.

• The Next button text is changed to NEXT and Skip button text is changed to SKIP.

• The NextConfig and SkipConfig button have a child parameter to create your own button.

• The introduce alignment is automaticaly calculated denpens on the position of the child widget.

• Add dismissible parameter to ChildConfig, so users can tap anywhere to move to the next introduce (can be a replacement for the Next button).
• Update dependencies.

• Update comments.
• Update homepage URL.

• Add waitForFirstIndex and waitForFirstTimeout to FeaturesTourController.
• Pre-Dialog:
  • Add dismiss button to dismiss the current page, the tour will not shows again even when a new one is added.
  • Add acceptButtonStyle, laterButtonStyle and dismissButtonStyle.
  • Change button text type from String to Text.
• Improve README.

• [BREAKING CHANGE BUG] Not completely renamed from yesButtonText and noButtonText to acceptButtonText and cancelButtonText in the PredialogConfig.
• [BUG] SkipButton get a wrong text color from NextButton.

• Add border to the Skip and Next button by default (with color of text color).
• Add textStyle and buttonStyle parameters to SkipConfig and NextConfig to modify the Next and Skip button style.

• Rename doNotAskAgainText to applyToAllPagesText in PredialogConfig to make it easier to understand. Also changed from Do not ask again this time to Apply to all pages.
• Resize the predialog text and checkbox.
• Using sdk: ">=2.18.0 <4.0.0" and flutter: ">=3.3.0".
• Add debugLog parameter to setGlobalConfig to allow disabling the debug logs.

• Update dependencies.
• Improve pub score.

• Improve pub score.

• Add waitForIndex and waitForTimeout to able to wait for a next specific index. The screen will be freesed when waiting for the next index.
• The tours is now respect the force parameter correctly:
  • null (default): only show when needed.
  • true: force to show all the tours, including pre-dialogs.
  • false: force to not show all the tours and pre-dialogs.
• Add example for the new parameters.

• Allow using your own pre-dialog by using modifiedDialogResult parameter in PredialogConfig.
• Slightly reduce the default pre-dialog content bottom padding.
• Update README.

• onPressed is now can use as Future method. The next widget of the tour will be only called when this Future is completed.
• The tours now will sort the new added states (some states need time to appear).
• Add isAnimateChild and borderSizeInflate to ChildConfig:
  • isAnimateChild is allow it to be animated along with the border.
  • borderSizeInflate is alow to set it to be bigger than the child widget. So the border widget is now bigger than the child widget 3 delta.
• Add isCallOnPressed to ChildConfig to allow the onPressed method to be called when user presses the Skip button.
• Avoid onPressed is called multiple times when it needs time to be completed.

• Improves loading and update behavior.

• Initial release.