Skip to content

Refactor alert examples to use FwbButton #377

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
May 6, 2025
Merged

Refactor alert examples to use FwbButton #377

merged 2 commits into from
May 6, 2025

Conversation

wazeerc
Copy link
Contributor

@wazeerc wazeerc commented May 1, 2025 •
edited by coderabbitai bot
Loading

Replace standard HTML buttons with FwbButton components in alert examples for improved consistency and styling.

  1. Alert's additional-content example could use fwb-button instead of HTML one - List of random issues #236

Summary by CodeRabbit

  • Documentation
    • Updated alert component examples to use the framework's button component for improved consistency and appearance.
    • Enhanced example code to demonstrate slot-based icon insertion within buttons.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 1, 2025 •
edited
Loading

Walkthrough

The changes update the alert component documentation and its example by replacing native HTML <button> elements with the FwbButton component from the flowbite-vue library. The import statements are adjusted to include FwbButton, and button implementations are refactored to use the component's props and slot-based icon insertion. The overall structure, event handling, and user interactions remain consistent with the previous implementation.

Changes

File(s) Change Summary
docs/components/alert.md Updated usage example to replace native <button>s with fwb-button components and adjusted import statement.
docs/components/alert/examples/FwbAlertExampleCustomContent.vue Replaced native <button>s with <fwb-button> components, moved icon to slot, and updated import.

Suggested labels

🔧 enhancement

Poem

A bunny hopped through docs today,
Swapping buttons the Vue way!
With slots for icons, style anew,
Flowbite buttons shining through.
Click and dismiss, the alerts delight—
The code now sparkles, clean and bright!
🐇✨

📜 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 71ac1f0 and bf72c90.

📒 Files selected for processing (1)
  • docs/components/alert/examples/FwbAlertExampleCustomContent.vue (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/components/alert/examples/FwbAlertExampleCustomContent.vue

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

@netlify Netlify
Copy link

netlify bot commented May 1, 2025 •
edited
Loading

✅ Deploy Preview for sensational-seahorse-8635f8 ready!

Name Link
🔨 Latest commit bf72c90
🔍 Latest deploy log https://app.netlify.com/sites/sensational-seahorse-8635f8/deploys/6813259187c8200008df98a0
😎 Deploy Preview https://deploy-preview-377--sensational-seahorse-8635f8.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai[bot]
coderabbitai bot reviewed May 1, 2025
View reviewed changes
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
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8b17cf8 and 71ac1f0.

📒 Files selected for processing (2)
  • docs/components/alert.md (1 hunks)
  • docs/components/alert/examples/FwbAlertExampleCustomContent.vue (1 hunks)
🧰 Additional context used
🪛 ESLint
docs/components/alert/examples/FwbAlertExampleCustomContent.vue

[error] 62-62: Extra semicolon.

(@stylistic/semi)

🪛 GitHub Check: lint (18.x)
docs/components/alert/examples/FwbAlertExampleCustomContent.vue

[failure] 62-62:
Extra semicolon

🪛 GitHub Actions: Node.js CI
docs/components/alert/examples/FwbAlertExampleCustomContent.vue

[error] 62-62: ESLint: Extra semicolon (@stylistic/semi)

🔇 Additional comments (5)
docs/components/alert/examples/FwbAlertExampleCustomContent.vue (2)

26-45: Good replacement of HTML button with FwbButton component

The replacement of the native HTML button with the FwbButton component is well-implemented, including proper use of the #prefix slot for the SVG icon and appropriate props for styling (color="blue", size="sm").

46-54: LGTM: Proper implementation of dismiss button

The dismiss button implementation maintains all the necessary attributes (data-dismiss-target, aria-label) and event handler (@click) while properly using the FwbButton component with appropriate styling props.

docs/components/alert.md (3)

230-247: Good implementation of FwbButton with proper icon placement

The replacement of the native HTML button with the FwbButton component is well-implemented, including appropriate props (color="blue", size="sm") and proper placement of the SVG icon in the #prefix slot.

248-257: LGTM: Dismiss button correctly implemented

The dismiss button implementation properly uses the FwbButton component with appropriate styling props while maintaining all the necessary attributes and event handlers.

263-263: Import statement correctly updated

The import statement has been properly updated to include the FwbButton component alongside FwbAlert.

@Sqrcz Sqrcz self-assigned this May 2, 2025
@Sqrcz Sqrcz added the 🔧 enhancement New feature or request label May 2, 2025
Sqrcz
Sqrcz approved these changes May 6, 2025
View reviewed changes
Copy link
Collaborator

@Sqrcz Sqrcz left a comment

Choose a reason for hiding this comment

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

Thank you!

@Sqrcz Sqrcz merged commit d8aa84c into themesberg:main May 6, 2025
4 checks passed
@wazeerc wazeerc deleted the docs/update-alert_example branch May 6, 2025 16:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@Sqrcz Sqrcz Sqrcz approved these changes

Assignees

@Sqrcz Sqrcz

Labels
🔧 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@wazeerc @Sqrcz