Better Variant Workflow for Buttons + Button docs

[kotAPI]

Summary by CodeRabbit

• New Features

  • Added documentation for Button component variants and sizes
  • Introduced new Button component styles with multiple variants and sizes
  • Enhanced ComponentHero with optional title support

• Documentation

  • Updated Button component documentation with comprehensive examples
  • Added source code references for Button variants and sizes

• Refactor

  • Improved Button component type flexibility
  • Updated styling approach for Button variants and sizes

[coderabbitai]

Caution

Review failed

The pull request is closed.

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.

docs/app/docs/components/button/docs/sizeCodeUsage.js

Oops! Something went wrong! :(

ESLint: 8.56.0

ESLint couldn't find the config "next/core-web-vitals" to extend from. Please check that the name of the config is correct.

The config "next/core-web-vitals" was referenced from the config file in "/docs/.eslintrc.json".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

This pull request introduces comprehensive updates to the Button component across multiple files. The changes include expanding the Button's variant and size type definitions, updating Storybook stories to provide more detailed button representations, modifying the component's styling in SCSS, and adding new example components to demonstrate button variants and sizes. The modifications aim to enhance the flexibility and documentation of the Button component while providing more comprehensive visual examples.

Changes

File	Change Summary
docs/app/docs/components/button/...	Added new documentation files for button variants and sizes, including sizeCodeUsage.js, variantCodeUsage.js, ButtonSizes.tsx, and ButtonVariants.tsx
docs/app/docs/components/button/page.js	Updated imports and added new sections for button variants and sizes in documentation
src/components/ui/Button/Button.tsx	Modified ButtonProps to use generic string types for variants and sizes
src/components/ui/Button/stories/Button.stories.js	Reordered variants and restructured size rendering in Storybook
styles/themes/components/button.scss	Enhanced button styling with new variant and size data attributes

Possibly related issues

• Separate variant and size stories in Storybook for Buttons #372: This PR directly addresses the issue of separating button variants and sizes in Storybook, providing more comprehensive and organized stories for button components.

Possibly related PRs

• Tabs Improvements and Refactor #521: Relates to UI component modifications and state management
• Added tests for Accordion component #700 #708: Involves component testing and structural improvements

Suggested labels

automerge, component/button, documentation, storybook

Poem

🐰 Hop, hop, button delight!
Variants dancing left and right
Sizes stretching, colors bright
Our UI component takes its flight
A rabbit's code, pure and tight! 🎨

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0bf9025 and 70f9d14.

📒 Files selected for processing (13)

• docs/app/docs/components/accordion/docs/codeUsage.js (0 hunks)
• docs/app/docs/components/button/docs/sizeCodeUsage.js (1 hunks)
• docs/app/docs/components/button/docs/variantCodeUsage.js (1 hunks)
• docs/app/docs/components/button/examples/ButtonSizes.tsx (1 hunks)
• docs/app/docs/components/button/examples/ButtonVariants.tsx (1 hunks)
• docs/app/docs/components/button/page.js (2 hunks)
• docs/components/layout/Documentation/helpers/ComponentHero/ComponentHero.js (2 hunks)
• src/components/ui/Accordion/fragments/AccordionContent.tsx (1 hunks)
• src/components/ui/Accordion/tests/Accordion.test.tsx (2 hunks)
• src/components/ui/AvatarGroup/tests/AvatarGroup.test.js (4 hunks)
• src/components/ui/Button/Button.tsx (1 hunks)
• src/components/ui/Button/stories/Button.stories.js (2 hunks)
• styles/themes/components/button.scss (2 hunks)

---

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
• Mastodon
• Reddit
• LinkedIn

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