Skip to content

Conversation

@PooriaKazemirad
Copy link
Contributor

@PooriaKazemirad PooriaKazemirad commented Feb 25, 2025

Summary by CodeRabbit

  • New Features

    • Introduced an interactive showcase for the Attachment component with distinct display variations.
  • Style

    • Updated background styling for a more consistent and polished visual experience.
    • Streamlined file name presentation and adjusted button sizing for enhanced clarity.
    • Refined text layout for improved readability in the thumbnail display.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 25, 2025

Walkthrough

This PR introduces a new Storybook file for the Attachment component with three stories—Dashboard, Landing, and Thumbnail—each wrapped in an ApiProvider. Additionally, it updates styling in the AttachmentAdmin and AttachmentThumbnail components by replacing a hard-coded color class with a shared utility class and exports the AttachmentThumbnailProps interface. The AttachmentItem component has its button styling and file name display simplified, and a console log statement has been added in the useAttachment hook to output allowed types. These changes are primarily cosmetic and for interactive component testing.

Changes

File(s) Change Summary
apps/storybook/.../Attachment.stories.tsx New Storybook file with three stories (Dashboard, Landing, Thumbnail) for the Attachment component; defines metadata, argTypes, and uses ApiProvider for wrapping components.
packages/ui/.../attachmentAdmin/attachmentAdmin.tsx
packages/ui/.../attachmentThumbnail/attachmentThumbnail.tsx
Updated Card component styling (replacing bg-[#26262666] with bg-card); in attachmentThumbnail, the AttachmentThumbnailProps interface is now exported and Typography formatting is adjusted.
packages/ui/.../attachmentItem/attachmentItem.tsx Modified button CSS to include min-w-auto and simplified file name display by replacing multiple <span> elements with a single <Typography> component; streamlined class attributes.
packages/ui/.../useAttachment.ts Added a console log statement in the getUploadFiles function to debug the allowedTypes variable.

Sequence Diagram(s)

sequenceDiagram
    participant SB as Storybook
    participant AP as ApiProvider
    participant AC as Attachment Component
    participant C as Console
    SB->>AP: Render Dashboard / Landing / Thumbnail story
    AP->>AC: Render corresponding Attachment component (Admin, Landing, or Thumbnail)
    AC->>C: Invoke onChange event (log file IDs)
Loading

Possibly related PRs

Suggested reviewers

  • mrbadri

Poem

I'm Bunny, hopping through code so fine,
Crafting stories where components align.
With logs and styles, my paths are clear,
Each change a carrot, bringing joyful cheer.
In this garden of code, I dance with delight,
Celebrating updates in bytes and light!
🐰✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

Scope: all 2 workspace projects
Progress: resolved 1, reused 0, downloaded 0, added 0
 ERR_PNPM_FETCH_404  GET http://10.0.0.28:4873/@repo%2Feslint-config: Not Found - 404

This error happened while installing a direct dependency of /tmp/eslint

@repo/eslint-config is not in the npm registry, or you have no permission to fetch it.

No authorization header was set for the request.

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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: 0

🧹 Nitpick comments (1)
apps/storybook/src/stories/Attachment.stories.tsx (1)

44-44: Remove irrelevant comment.

The comment "✅ Individual Button Stories" seems out of place in an Attachment component story file.

-// ✅ **Individual Button Stories**
+// Attachment component stories
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d60b808 and f6431e4.

📒 Files selected for processing (5)
  • apps/storybook/src/stories/Attachment.stories.tsx (1 hunks)
  • packages/ui/src/components/molecules/attachment/attachmentAdmin/attachmentAdmin.tsx (2 hunks)
  • packages/ui/src/components/molecules/attachment/attachmentAdmin/attachmentItem/attachmentItem.tsx (2 hunks)
  • packages/ui/src/components/molecules/attachment/attachmentThumbnail/attachmentThumbnail.tsx (3 hunks)
  • packages/ui/src/components/molecules/attachment/useAttachment.ts (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • packages/ui/src/components/molecules/attachment/attachmentAdmin/attachmentAdmin.tsx
  • packages/ui/src/components/molecules/attachment/useAttachment.ts
🔇 Additional comments (7)
packages/ui/src/components/molecules/attachment/attachmentThumbnail/attachmentThumbnail.tsx (3)

12-12: Good improvement for component reusability.

Exporting the interface makes it accessible outside this module, which facilitates its use in the new Storybook file.


41-41: Improved styling consistency.

Replacing the hard-coded color value bg-[#26262666] with the utility class bg-card enhances theme consistency across components and improves maintainability.


158-160: LGTM!

The multi-line formatting of the Typography component improves code readability while maintaining the same functionality.

packages/ui/src/components/molecules/attachment/attachmentAdmin/attachmentItem/attachmentItem.tsx (2)

37-37: Button styling improvement.

Adding min-w-auto to the className ensures the button maintains appropriate sizing, improving UI consistency.


54-57: Simplified file name display structure.

The markup for displaying the file name has been simplified by using a single Typography component instead of multiple nested spans, improving readability and maintainability while preserving the truncation behavior.

apps/storybook/src/stories/Attachment.stories.tsx (2)

1-43: Good Storybook configuration.

The meta configuration is well-structured with appropriate controls for all component props and sensible default values.


44-109: Well-structured component stories.

All three stories (Dashboard, Landing, and Thumbnail) are properly implemented with:

  • Appropriate props
  • ApiProvider wrapper
  • Consistent onChange handlers

This provides a good foundation for interactive testing of the components.

@mrbadri mrbadri self-requested a review February 26, 2025 17:22
@mrbadri mrbadri merged commit 61ed7ee into main Feb 26, 2025
2 of 6 checks passed
@mrbadri mrbadri deleted the feat/#261-Storybook-Attachment branch February 26, 2025 17:22
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.

3 participants