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

Add ToggleGroup Component - Pass 1 #259

Merged
merged 5 commits into from
Jun 28, 2024
Merged

Conversation

kotAPI
Copy link
Collaborator

@kotAPI kotAPI commented Feb 17, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a new ToggleGroup component for grouped toggle functionality.
    • Added support for both single and multiple toggle configurations.
    • Included a MoveIcon component for enhanced visual representation.
    • Provided context management for toggling states within the group.
    • Implemented ToggleGroupRoot and ToggleItem components to manage active toggles and handle toggling logic.

Copy link
Contributor

coderabbitai bot commented Feb 17, 2024

Warning

Review failed

The pull request is closed.

Walkthrough

The introduced files collectively implement a ToggleGroup component in React, designed to handle both single and multiple toggle configurations. This feature includes managing active toggles via context, creating a toggle group root, and individual toggle items. The added stories help demonstrate the component's usage, including visual examples for both single and multiple toggles.

Changes

Files Change Summaries
.../ToggleGroup.stories.js Introduced stories for ToggleGroup component, including templates for multiple and single toggle configurations.
.../ToggleGroup.tsx Created the main ToggleGroup component with Root and Item properties referencing subcomponents.
.../contexts/toggleContext.tsx Added a context for managing toggle functionalities.
.../shards/ToggleGroupRoot.tsx Added ToggleGroupRoot component for managing groups of toggles with state management for active toggles.
.../shards/ToggleItem.tsx Introduced ToggleItem component to handle individual toggle logic based on context-defined type ('single' or 'multiple').

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ToggleGroup
    participant ToggleGroupRoot
    participant ToggleItem
    participant ToggleContext
    User ->> ToggleGroup: Render Multiple Configuration
    ToggleGroup ->> ToggleGroupRoot: Create Root Component
    ToggleGroupRoot ->> ToggleItem: Create Items with Context
    ToggleItem ->> ToggleContext: Update Active States
    User ->> ToggleGroup: Toggle an Item
    ToggleGroup ->> ToggleItem: Handle Toggle Action
    ToggleItem ->> ToggleContext: Update Active States
Loading

Poem

In the garden of code, toggles dance,
With multiple ways to give them a chance.
Single or many, you choose the way,
To turn them on and off, and make them sway.
With stories to guide, and context to share,
Your toggles bloom with a rabbit's care. 🐇💻


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
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.

@kotAPI kotAPI linked an issue Feb 17, 2024 that may be closed by this pull request
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 5

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between a890708 and 8575591.
Files selected for processing (5)
  • src/components/ui/ToggleGroup/ToggleGroup.stories.js (1 hunks)
  • src/components/ui/ToggleGroup/ToggleGroup.tsx (1 hunks)
  • src/components/ui/ToggleGroup/contexts/toggleContext.tsx (1 hunks)
  • src/components/ui/ToggleGroup/shards/ToggleGroupRoot.tsx (1 hunks)
  • src/components/ui/ToggleGroup/shards/ToggleItem.tsx (1 hunks)
Additional comments: 1
src/components/ui/ToggleGroup/ToggleGroup.stories.js (1)
  • 14-26: The story setup for ToggleGroup looks good and demonstrates the component's functionality well. Ensure that the SandboxEditor component and the custom MoveIcon are integrated and function as expected in the broader context of the application.

src/components/ui/ToggleGroup/contexts/toggleContext.tsx Outdated Show resolved Hide resolved
src/components/ui/ToggleGroup/shards/ToggleItem.tsx Outdated Show resolved Hide resolved
src/components/ui/ToggleGroup/shards/ToggleItem.tsx Outdated Show resolved Hide resolved
src/components/ui/ToggleGroup/ToggleGroup.tsx Outdated Show resolved Hide resolved
src/components/ui/ToggleGroup/shards/ToggleGroupRoot.tsx Outdated Show resolved Hide resolved
Copy link

codecov bot commented Feb 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.64%. Comparing base (1f00675) to head (92df1e7).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #259      +/-   ##
==========================================
+ Coverage   92.00%   94.64%   +2.64%     
==========================================
  Files           4       10       +6     
  Lines          25       56      +31     
  Branches        7        9       +2     
==========================================
+ Hits           23       53      +30     
- Misses          2        3       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@kotAPI kotAPI marked this pull request as draft February 17, 2024 07:05
@kotAPI kotAPI marked this pull request as ready for review June 28, 2024 02:40
@kotAPI kotAPI merged commit 8230c45 into main Jun 28, 2024
6 checks passed
@kotAPI kotAPI deleted the pranay/add-toggle-group-component branch June 28, 2024 02:40
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.

ToggleGroup Component - Pass 1
1 participant