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

WIP Implement sidebar component #83

Merged
merged 21 commits into from
Nov 23, 2024
Merged

WIP Implement sidebar component #83

merged 21 commits into from
Nov 23, 2024

Conversation

bluzky
Copy link
Owner

@bluzky bluzky commented Nov 11, 2024

Summary by Sourcery

Add a new sidebar component with customizable attributes and a function for building variant classes to enhance UI flexibility.

New Features:

  • Introduce a new sidebar component with various customizable attributes such as side, variant, collapsible, and state, allowing for flexible UI configurations.

Enhancements:

  • Add a common function for building variant classes, improving the flexibility and reusability of CSS class generation.

Copy link

sourcery-ai bot commented Nov 11, 2024

Reviewer's Guide by Sourcery

This PR introduces a new sidebar component implementation with various customization options and subcomponents. The changes include a new variant class helper function and a comprehensive sidebar module with multiple rendering options and styling configurations.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new variant class helper function for handling component variants and their default values
  • Implemented a function to process variant configurations with default fallbacks
  • Added support for multiple variant types (e.g., size, variant) in a single configuration
  • Included comprehensive documentation with examples
lib/salad_ui/helpers.ex
Implemented a new sidebar component with multiple rendering modes and configurations
  • Created base sidebar component with offcanvas, icon, and static modes
  • Added mobile-specific rendering with sheet component integration
  • Implemented sidebar subcomponents (trigger, rail, header, footer, etc.)
  • Added support for group organization with labels and actions
  • Implemented menu system with customizable items and actions
  • Added tooltip integration for collapsed state
lib/salad_ui/slidebar.ex
Bumped package version
  • Incremented version from 0.13.0 to 0.13.1
mix.exs

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @bluzky - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The assigns function appears to be missing its name and implementation - should this be sidebar_footer?
  • The new file is named 'slidebar.ex' but should be 'sidebar.ex' to match the module name
Here's what I looked at during the review
  • 🟡 General issues: 3 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

lib/salad_ui/helpers.ex Show resolved Hide resolved
lib/salad_ui/slidebar.ex Outdated Show resolved Hide resolved
lib/salad_ui/slidebar.ex Outdated Show resolved Hide resolved
@bluzky bluzky changed the title WIP start sidebar WIP Implement sidebar component Nov 14, 2024
@bluzky bluzky merged commit 4a67653 into main Nov 23, 2024
1 of 2 checks passed
@bluzky bluzky deleted the feature/sidebar branch November 23, 2024 07:02
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