rad-ui / ui

Rad UI is an open-source, headless UI component library for building modern, fast, performant, accessible React applications
http://rad-ui.com
MIT License
9 stars 11 forks source link

colorsTemplate refactor #357

Closed G-Joe closed 3 days ago

G-Joe commented 5 days ago

This change resolves #344 by storing all the colors classes in an array and mapping through the array

Before

Screenshot 2024-06-28 at 1 20 03 PM

After

Screenshot 2024-06-29 at 11 01 52 AM

Summary by CodeRabbit

coderabbitai[bot] commented 5 days ago

Walkthrough

The primary change involves refactoring the ColorsTemplate component in the ColorsTemplate.js file. The hard-coded list of color classes is replaced with a dynamically generated array, enhancing maintainability by using a data-driven approach. Additionally, the npm run lint command in the .husky/pre-commit script has been commented out.

Changes

Files Change Summary
.husky/pre-commit Commented out the npm run lint command.
src/examples/Colors/ColorsTemplate.js Replaced hard-coded color classes with a dynamically generated list of color classes to render the ColorBubble component.

Assessment against linked issues

Objective Addressed Explanation
#344: Refactor to improve maintainability.

Poem

Amid the code, where colors bloom,
A refactor sweeps away the gloom.
Dynamic hues now take their place,
In tidy arrays, with elegant grace.
No longer static, they fluidly flow,
Our ColorsTemplate, let brilliance show. 🌈


[!TIP]

Early access features - OpenAI `gpt-4o` model for reviews and chat. Note: - You can disable early access features from the CodeRabbit UI or by setting `early_access: false` in the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are always opted into early access features.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
kotAPI commented 4 days ago

Can you attach screenshots of the storybook that uses this file? The before and after please?

G-Joe commented 4 days ago

Before:

Screenshot 2024-06-28 at 1 20 03 PM

After

Screenshot 2024-06-28 at 1 20 56 PM
G-Joe commented 4 days ago

when I undo the spread operator, when I create an array inisde the function, like the code, below, it displays just fine, do we stick with the spread operator method or this works

const ColorsTemplate = () => {

    const colorGroups = [
        gray,
        mauve,
        slate,
        sage,
        olive,
        sand,
        tomato,
        // Add other color groups here...
      ];

  return (
     <div className="p-4 space-y-0.5">
      {colorGroups.map((group, groupIndex) => (
        <div key={groupIndex} className="flex flex-wrap">
          {group.map((colorClass, index) => (
            <ColorBubble key={index} colorClass={colorClass} />
          ))}
        </div>
      ))}
    </div>
  )
}

see screnshot

Screenshot 2024-06-28 at 1 44 18 PM
kotAPI commented 4 days ago

when I undo the spread operator, when I create an array inisde the function, like the code, below, it displays just fine, do we stick with the spread operator method or this works

const ColorsTemplate = () => {

    const colorGroups = [
        gray,
        mauve,
        slate,
        sage,
        olive,
        sand,
        tomato,
        // Add other color groups here...
      ];

  return (
     <div className="p-4 space-y-0.5">
      {colorGroups.map((group, groupIndex) => (
        <div key={groupIndex} className="flex flex-wrap">
          {group.map((colorClass, index) => (
            <ColorBubble key={index} colorClass={colorClass} />
          ))}
        </div>
      ))}
    </div>
  )
}

see screnshot Screenshot 2024-06-28 at 1 44 18 PM

We'll need a 2 dimensional array or an object

G-Joe commented 4 days ago

stored the array in an object and mapped through it, this looks good from my end, let me know

kotAPI commented 3 days ago

stored the array in an object and mapped through it, this looks good from my end, let me know

Looks good from the code, left a comment about reverting husky file change

also can you edit the description and attach before and after screenshot?

G-Joe commented 3 days ago

For the husky file, just to clarify, the npm run lint is still commented out, you want it to be uncommmented?

kotAPI commented 3 days ago

For the husky file, just to clarify, the npm run lint is still commented out, you want it to be uncommmented?

Correct, when you check your PR on GitHub - that change shouldn't be visible

G-Joe commented 3 days ago

Done, pls confirm from your end

kotAPI commented 3 days ago

Merging, thanks for the PR @G-Joe