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(Card): adding prop "compact" #463

Merged
merged 1 commit into from
Apr 6, 2024
Merged

Conversation

aversini
Copy link
Collaborator

@aversini aversini commented Apr 6, 2024

Summary by CodeRabbit

  • New Features
    • Introduced a compact option for Card components to allow for smaller card rendering.
  • Refactor
    • Updated the Card component to use a custom class for styling instead of default classes.
    • Changed the header element in the Custom component from <h3> to <h2>.
  • Tests
    • Added tests for the new compact feature in Card components.

Copy link

coderabbitai bot commented Apr 6, 2024

Walkthrough

The recent update introduces a compact property to the Card component, allowing for a more flexible design with smaller card options. This change involved adding the compact prop across various files to ensure consistency in functionality and appearance. Additionally, the header element in the Custom component was upgraded for better semantic structure, and the default styling was modified to accommodate the new compact design. This enhancement aims to provide a more versatile and customizable card component within the UI library.

Changes

File(s) Summary
.../Card.stories.tsx, .../Card/Card.tsx, .../Card/CardTypes.d.ts, .../Card/__tests__/Card.test.tsx, .../Card/utilities.ts Added a compact property with a default value of false. Updated styling and tests to support compact cards. Changed the header element from <h3> to <h2> in the Custom component. Removed specific default styling classes in favor of a custom class for compact cards.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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/coderabbit-overrides.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

github-actions bot commented Apr 6, 2024

Bundle Size (components)

Status File Size (Gzip) Limits
style.css 6.91 KB 8 KB
index.js 8.28 KB (+21 B +0.25%) 20 KB
vendor.js 65.07 KB 67 KB

Overall bundle size: 80.26 KB (+21 B +0.03%)
Overall status: ✅

Bundle Size (form components)

Status File Size (Gzip) Limits
index.js 4.74 KB (+8 B +0.17%) 20 KB
vendor.js 44.49 KB 67 KB

Overall bundle size: 49.23 KB (+8 B +0.02%)
Overall status: ✅

Bundle Size (system)

Status File Size (Gzip) Limits
style.css 7.25 KB 8 KB
index.js 1.74 KB 3 KB
vendor.js 44.49 KB 46 KB

Overall bundle size: 53.48 KB
Overall status: ✅

Copy link

@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

Review Status

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between 636e5a8 and 7719e82.
Files selected for processing (5)
  • packages/documentation/src/Components/Card.stories.tsx (2 hunks)
  • packages/ui-components/src/components/Card/Card.tsx (2 hunks)
  • packages/ui-components/src/components/Card/CardTypes.d.ts (2 hunks)
  • packages/ui-components/src/components/Card/tests/Card.test.tsx (2 hunks)
  • packages/ui-components/src/components/Card/utilities.ts (2 hunks)
Additional comments not posted (6)
packages/ui-components/src/components/Card/CardTypes.d.ts (1)

24-24: Consider adding documentation for the compact property to explain its effect on the Card component.

packages/documentation/src/Components/Card.stories.tsx (2)

11-11: The addition of the compact property with a default value of false is correctly implemented.


67-67: Changing the header element from <h3> to <h2> in the Custom component is a good practice for semantic HTML and accessibility.

packages/ui-components/src/components/Card/utilities.ts (1)

10-10: The addition of the compact parameter to the getCardClasses function is correctly implemented for dynamic styling adjustments.

packages/ui-components/src/components/Card/Card.tsx (1)

42-42: The addition of the compact prop with a default value of false is correctly implemented and used effectively within the component.

packages/ui-components/src/components/Card/__tests__/Card.test.tsx (1)

78-93: The new test case for rendering a default compact card is correctly implemented, ensuring the feature's functionality is preserved across updates.

@aversini aversini merged commit 1f65900 into main Apr 6, 2024
5 checks passed
@aversini aversini deleted the feat(Card)-adding-prop-compact- branch April 6, 2024 15:28
@aversini aversini mentioned this pull request Apr 6, 2024
aversini added a commit that referenced this pull request Apr 6, 2024
🤖 I have created a release *beep* *boop*
---


<details><summary>ui-components: 5.12.0</summary>

##
[5.12.0](ui-components-v5.11.1...ui-components-v5.12.0)
(2024-04-06)


### Features

* **Card:** adding prop "compact"
([#463](#463))
([1f65900](1f65900))
</details>

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

---------

Co-authored-by: aversini <[email protected]>
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.

1 participant