Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BottomSheet component #9

Merged
merged 7 commits into from
Feb 4, 2025

Conversation

ahmadtaimoor-deriv
Copy link
Contributor

@ahmadtaimoor-deriv ahmadtaimoor-deriv commented Feb 4, 2025

Summary by Sourcery

Introduce the BottomSheet component for displaying trade contracts.

New Features:

  • A BottomSheet component is added to display contract details.

Tests:

  • Added tests for the BottomSheet component.

Copy link

sourcery-ai bot commented Feb 4, 2025

Reviewer's Guide by Sourcery

This pull request introduces a BottomSheet component using Zustand for state management and Radix UI for dialog and presence. It also includes configuration for different bottom sheet contents.

Sequence diagram for BottomSheet interaction flow

sequenceDiagram
    actor User
    participant TB as TradeButton
    participant BS as BottomSheet
    participant BSS as BottomSheetStore

    User->>TB: Clicks Rise button
    TB->>BSS: setBottomSheet(true, 'rise-contract')
    BSS->>BS: Updates state
    BS->>BS: Renders overlay and sheet

    Note over BS: User can dismiss by:

    alt Swipe down
        User->>BS: Swipes down
        BS->>BS: Tracks touch movement
        BS->>BSS: setBottomSheet(false)
    else Tap overlay
        User->>BS: Taps overlay
        BS->>BSS: setBottomSheet(false)
    end
Loading

Class diagram for BottomSheet component structure

classDiagram
    class BottomSheet {
        +useRef() sheetRef
        +useRef() dragStartY
        +useRef() currentY
        +useRef() isDragging
        +handleTouchStart()
        +handleTouchMove()
        +handleTouchEnd()
        +render()
    }

    class BottomSheetStore {
        +boolean showBottomSheet
        +string|null key
        +string height
        +setBottomSheet(show, key?, height?)
    }

    class BottomSheetConfig {
        +ReactNode body
    }

    BottomSheet ..> BottomSheetStore : uses
    BottomSheet ..> BottomSheetConfig : uses
Loading

State diagram for BottomSheet component

stateDiagram-v2
    [*] --> Hidden
    Hidden --> Visible: setBottomSheet(true)

    state Visible {
        [*] --> Idle
        Idle --> Dragging: Touch Start
        Dragging --> Idle: Touch End (deltaY < 100)
        Dragging --> Hidden: Touch End (deltaY > 100)
    }

    Visible --> Hidden: setBottomSheet(false)
Loading

File-Level Changes

Change Details Files
Implemented the BottomSheet component with drag functionality and overlay.
  • Added touch event handlers for dragging.
  • Implemented logic to dismiss the bottom sheet on drag.
  • Added overlay for background dimming.
  • Used Radix UI for dialog and presence
src/components/BottomSheet/BottomSheet.tsx
Created a store for managing the bottom sheet state.
  • Defined a Zustand store for bottom sheet visibility, key, and height.
  • Added a setter function to update the store's state.
src/stores/bottomSheetStore.ts
Added bottom sheet configuration.
  • Created a configuration file to define the content for different bottom sheets.
  • Added a sample 'rise-contract' configuration.
src/config/bottomSheetConfig.tsx
Integrated the BottomSheet component into the TradePage.
  • Imported and rendered the BottomSheet component.
  • Added a button to trigger the 'rise-contract' bottom sheet.
src/screens/TradePage/TradePage.tsx
Added Radix UI dependencies.
  • Added @radix-ui/react-dialog and @radix-ui/react-presence as dependencies.
package.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @ahmadtaimoor-deriv - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the touch gesture logic into a custom hook (e.g. useBottomSheetGestures) to improve reusability and testability
  • The touch gesture handling could be more robust by handling edge cases like interrupted animations and rapid successive gestures
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

src/components/BottomSheet/BottomSheet.tsx Show resolved Hide resolved
@shafin-deriv
Copy link
Contributor

@ahmadtaimoor-deriv let's generate/update docs for these changes

@shafin-deriv shafin-deriv merged commit acc9126 into deriv-com:master Feb 4, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants