Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Jun 7, 2025

Link issues

fixes #6176

Summary By Copilot

Regression?

  • Yes
  • No

Risk

  • High
  • Medium
  • Low

Verification

  • Manual (required)
  • Automated

Packaging changes reviewed?

  • Yes
  • No
  • N/A

☑️ Self Check before Merge

⚠️ Please check all items below before review. ⚠️

  • Doc is updated/provided or not needed
  • Demo is updated/provided or not needed
  • Merge the latest code from the main branch

Summary by Sourcery

Introduce a Preview option in the ImageCropper component and enhance the sample page to showcase dynamic preview panels for both rectangular and round cropping.

New Features:

  • Add Preview parameter to ImageCropperOption to support live preview elements.

Enhancements:

  • Update ImageCroppers sample to demonstrate previews in multiple sizes for both rectangular and round cropping modes.
  • Refactor sample code-behind with separate ImageCropperOption instances (_roundOptions1, _roundOptions2) for different aspect ratios and shapes.

@bb-auto bb-auto bot added the enhancement New feature or request label Jun 7, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 7, 2025

Reviewer's Guide

The PR adds real-time preview support to the ImageCropper component by introducing a Preview parameter in the options and updating the ImageCroppers demo to leverage this feature, while also cleaning up markup and refactoring sample variables.

Sequence Diagram for Real-time Crop Preview Update

sequenceDiagram
    actor User
    participant ImageCropperComponent
    participant PreviewDOMElements

    User->>ImageCropperComponent: Adjusts crop selection (e.g., drag, resize)
    activate ImageCropperComponent
    ImageCropperComponent->>ImageCropperComponent: Processes crop data change
    Note over ImageCropperComponent: Uses Options.Preview CSS selector
    ImageCropperComponent->>PreviewDOMElements: Update preview image/style
    activate PreviewDOMElements
    PreviewDOMElements-->>User: Display updated real-time preview
    deactivate PreviewDOMElements
    deactivate ImageCropperComponent
Loading

Class Diagram for ImageCropperOption Update

classDiagram
    class ImageCropperOption {
        +AspectRatio: float
        +IsRound: bool
        +Preview: string #40;new#41;
        #40;...other existing properties...#41;
    }
Loading

File-Level Changes

Change Details Files
Enable crop preview via new Preview option in ImageCropperOption
  • Define Preview selectors in sample option instances
  • Pass Options parameter to ImageCropper components
  • Inject preview panels in demo with various sizes and shapes
src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor
src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor.cs
Standardize component markup and spacing
  • Convert self-closing tags (, <Textarea/>) to explicit closing tags
  • Add margin-top styling to result elements
  • Remove redundant documentation comments in code-behind
src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor
src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor.cs
Refactor sample option variables
  • Rename _roundOptions to _roundOptions1 and introduce _roundOptions2
  • Adjust aspect ratio and remove Radius on circular option
  • Initialize options with appropriate Preview selectors
src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#6176 Add a Preview parameter to the ImageCropper component.

Possibly linked issues


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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

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

@bb-auto bb-auto bot added this to the 9.7.0 milestone Jun 7, 2025
@codecov
Copy link

codecov bot commented Jun 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2e6e63c) to head (5606e80).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #6177   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          704       704           
  Lines        31099     31099           
  Branches      4394      4394           
=========================================
  Hits         31099     31099           
Flag Coverage Δ
BB 100.00% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ArgoZhang ArgoZhang merged commit 9a88fa6 into main Jun 7, 2025
3 checks passed
@ArgoZhang ArgoZhang deleted the feat-cropper branch June 7, 2025 04:27
Copy link
Contributor

@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 @ArgoZhang - I've reviewed your changes - here's some feedback:

  • Consider renaming _roundOptions1 and _roundOptions2 to more descriptive names (e.g. _rectPreviewOptions and _roundPreviewOptions) to clarify their intended use.
  • The demo repeats nearly identical preview <div>s; extracting that into a loop or a small reusable component would reduce duplication and make future size/style changes easier.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue 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.

private string? _base64String2;

private readonly ImageCropperOption _roundOptions = new() { IsRound = true, Radius = "50%", AspectRatio = 3/4f };
private readonly ImageCropperOption _roundOptions1 = new() { AspectRatio = 16 / 9f, Preview = ".bb-cropper-preview1" };
Copy link
Contributor

Choose a reason for hiding this comment

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

suggestion: Rename _roundOptions1 to better reflect its use

Since this object is for the standard cropper, a name like _normalOptions would improve clarity.

Suggested implementation:

    private readonly ImageCropperOption _normalOptions = new() { AspectRatio = 16 / 9f, Preview = ".bb-cropper-preview1" };

If there are any usages of _roundOptions1 elsewhere in this file (or in the corresponding .razor file), they should also be renamed to _normalOptions for consistency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(ImageCropper): add Preview parameter

2 participants