Add animationDuration property to useTabController hook

[d-polikhranidi]

Summary by CodeRabbit

• New Features

  • Introduced an optional animationDuration parameter for the useTabController function, allowing for customizable tab transition animations.

• Improvements

  • Enhanced the TabController to accept the new animationDuration parameter for improved user experience during tab transitions.

[coderabbitai]

Walkthrough

The changes introduce an optional animationDuration parameter to the useTabController function in the tab_controller.dart file. This parameter, which defaults to kTabScrollDuration, enhances the customization of tab controller animations. The _TabControllerHook class constructor has also been updated to require this new parameter, ensuring that the animation duration can be specified when creating tab controllers. Overall, the structure of the hook and its state remains intact while providing more flexibility in animation settings.

Changes

Files	Change Summary
packages/flutter_hooks/lib/src/tab_controller.dart	Added animationDuration parameter to useTabController and updated _TabControllerHook constructor to include it.

Poem

In the meadow where tabs do play,
A new duration brightens the day.
With hops and jumps, they dance so free,
Custom animations, oh what glee!
A rabbit's joy, a coder's delight,
In fluttering dreams, everything feels right! 🐰✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)

packages/flutter_hooks/lib/src/tab_controller.dart (2)

9-9: LGTM! Consider adding documentation for the new parameter.

The addition of the animationDuration parameter is a good improvement, allowing for customization of the tab animation duration. The default value and nullable type are appropriate.

Consider adding a brief documentation comment for the animationDuration parameter to explain its purpose and default behavior. For example:

/// The duration of the tab switching animation. Defaults to [kTabScrollDuration].
Duration? animationDuration = kTabScrollDuration,

---

32-34: LGTM! Consider making animationDuration nullable in the constructor.

The changes to the _TabControllerHook class are consistent with the previous modifications. The animationDuration field is correctly added, and the constructor is updated appropriately.

For consistency with the useTabController function, consider making the animationDuration parameter nullable in the constructor:

const _TabControllerHook({
  required this.length,
  required this.vsync,
  required this.initialIndex,
  required this.animationDuration,
  super.keys,
});

final Duration? animationDuration;

This change would maintain consistency with the nullable type used in the useTabController function.

Also applies to: 39-39

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 319679b and 83f146a.

📒 Files selected for processing (1)

• packages/flutter_hooks/lib/src/tab_controller.dart (3 hunks)

🔇 Additional comments (2)

packages/flutter_hooks/lib/src/tab_controller.dart (2)

21-21: LGTM! Consistent implementation of the new parameter.

The animationDuration parameter is correctly passed to the _TabControllerHook constructor, ensuring that the custom animation duration is properly propagated to the internal implementation.

---

49-49: LGTM! Proper implementation of the custom animation duration.

The animationDuration parameter is correctly passed to the TabController constructor, ensuring that the custom animation duration is applied to the created controller.