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

feat(Picker): support 'root' attribute #1442

Merged
merged 1 commit into from
Nov 28, 2024
Merged

feat(Picker): support 'root' attribute #1442

merged 1 commit into from
Nov 28, 2024

Conversation

bolchowka
Copy link
Member

@bolchowka bolchowka commented Nov 28, 2024

Description

Adds support for root property of FloatingPortal used in Picker component.

Storybook

https://feature-picker-root--613a8e945a5665003a05113b.chromatic.com

  • Self review (use this as your final check for proposed changes before requesting the review)
  • Add correct label
  • Assign pull request with the correct issue

Summary by CodeRabbit

  • New Features
    • Introduced a new optional root prop to the Picker component, allowing users to customize the portal's root element.
  • Enhancements
    • Expanded configuration options for the Picker component with the addition of the root property in the interface.

@bolchowka bolchowka added feature New feature or request documentation Documentation of any kind labels Nov 28, 2024
Copy link
Contributor

coderabbitai bot commented Nov 28, 2024

Walkthrough

The changes introduce a new optional root prop to the Picker component, allowing customization of the FloatingPortal's root element. This involves updating the Picker component's functional signature and modifying the IPickerProps interface to include the new property. The overall structure and functionality of the component remain unchanged.

Changes

File Path Change Summary
packages/react-components/src/components/Picker/Picker.tsx Added root prop to Picker component and passed it to FloatingPortal. Updated method signature.
packages/react-components/src/components/Picker/types.ts Imported FloatingPortalProps and added root property to IPickerProps interface.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Picker
    participant FloatingPortal

    User->>Picker: Render Picker
    Picker->>FloatingPortal: Pass root prop
    FloatingPortal->>FloatingPortal: Render with custom root
Loading

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

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.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 151a4d8 and 0363d48.

📒 Files selected for processing (2)
  • packages/react-components/src/components/Picker/Picker.tsx (2 hunks)
  • packages/react-components/src/components/Picker/types.ts (2 hunks)
🔇 Additional comments (3)
packages/react-components/src/components/Picker/types.ts (2)

4-4: LGTM: Clean import addition

Import is properly placed with other floating-ui imports.


136-139: LGTM: Well-documented root property

The new root property is:

  • Properly typed using FloatingPortalProps
  • Well documented with clear JSDoc
  • Correctly marked as optional
packages/react-components/src/components/Picker/Picker.tsx (1)

42-42: LGTM: Clean prop addition

The root prop is properly positioned among other portal-related props.

@@ -149,7 +150,7 @@ export const Picker: React.FC<IPickerProps> = ({
</PickerTrigger>
<FloatingNode id={nodeId}>
{isOpen && (
<FloatingPortal>
<FloatingPortal root={root}>
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Add story for custom portal root

The root prop is properly typed and implemented, but there's no story demonstrating its usage. Current stories don't cover portal behavior customization.

  • Add a new story in Picker.stories.tsx showcasing the root prop with a custom container element
  • Include examples of portal mounting to different DOM elements
🔗 Analysis chain

Verify portal behavior with custom root

The implementation looks correct. Consider adding a Storybook story that demonstrates the root prop functionality with different root elements.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if there's a corresponding story for root prop
rg -l "root.*?FloatingPortal" "packages/react-components/src/components/Picker/**/*.stories.tsx"

Length of output: 203


Script:

#!/bin/bash
# Let's first check if stories exist in the correct location
fd "stories.tsx" packages/react-components/src/components/Picker/

# Check for any stories related to Picker component
fd "stories.tsx" . | grep -i "picker"

# Let's also verify the actual implementation of FloatingPortal usage
rg "FloatingPortal" packages/react-components/src/components/Picker/

Length of output: 951


Script:

#!/bin/bash
# Let's check the content of the Picker stories to see if root prop is covered
cat packages/react-components/src/components/Picker/Picker.stories.tsx

# Also check the types file to understand root prop definition
cat packages/react-components/src/components/Picker/types.ts

Length of output: 13484

@bolchowka bolchowka merged commit 6e42a71 into main Nov 28, 2024
8 checks passed
@bolchowka bolchowka deleted the feature/picker-root branch November 28, 2024 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation of any kind feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants