Add option to disable scrolling for custom layout

[hareshgediya]

A new functionality that allows to users to disable scrolling for the custom layout.

Summary by CodeRabbit

• New Features
  • Added an allowScrolling option to customize scrolling behavior in the swiper widget.
• Improvements
  • Enhanced gesture handling in custom layout to respect the allowScrolling setting, allowing for more flexible user interactions.

[coderabbitai]

Walkthrough

The changes introduce a new allowScrolling parameter to the Swiper widget and its related classes. This parameter conditionally allows or disables scrolling interactions within the widget and is propagated through different components, affecting the functionality of gesture detectors and constructors.

Changes

File Path	Change Summary
lib/src/custom_layout.dart	Introduced _allowScrolling getter and updated gesture callbacks based on its value. Added allowScrolling parameter to _CustomLayoutSwiper constructor.
lib/src/swiper.dart	Added allowScrolling parameter to the Swiper class and its methods, affecting various aspects of the Swiper widget's behavior.

Sequence Diagram(s)

sequenceDiagram
    actor User
    User->>Swiper: Interacts with Swiper
    Swiper->>_SwiperState: Initialize with allowScrolling
    _SwiperState->>_CustomLayoutSwiper: Constructor with allowScrolling
    alt allowScrolling is true
        _CustomLayoutSwiper->>GestureDetector: Enable onPanStart, onPanEnd, onPanUpdate
        GestureDetector-->>Swiper: Handle gestures as usual
    else allowScrolling is false
        _CustomLayoutSwiper-->>GestureDetector: Disable onPanStart, onPanEnd, onPanUpdate
        GestureDetector-->>User: Scrolling disabled
    end
    Swiper-->>User: Display Swiper with updated scrolling behavior

Loading

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b9b4ea1 and 863b2e2.

Files selected for processing (2)

• lib/src/custom_layout.dart (3 hunks)
• lib/src/swiper.dart (9 hunks)

Additional comments not posted (6)

lib/src/custom_layout.dart (2)

10-10: LGTM!

The new getter _allowScrolling correctly derives its value from widget.allowScrolling.

---

124-126: LGTM!

The GestureDetector callbacks are correctly updated to conditionally execute based on _allowScrolling.

lib/src/swiper.dart (4)

75-75: LGTM!

The new parameter allowScrolling is correctly added to the Swiper constructor with a default value of true.

---

122-122: LGTM!

The new parameter allowScrolling is correctly added to the Swiper.children factory constructor with a default value of true.

---

253-254: LGTM!

The new final field allowScrolling is correctly added to the Swiper class and initialized in the constructor.

---

288-288: LGTM!

The new parameter allowScrolling is correctly added to the Swiper.list factory constructor with a default value of true.

[opensourcekam]

Merge this