Skip to content

feat(ImageCropper): add Preview parameter #6177

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

Merged
merged 3 commits into from
Jun 7, 2025
Merged

feat(ImageCropper): add Preview parameter #6177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
063876a
refactor: bump version 9.0.2
ArgoZhang Jun 7, 2025
e990e1a
doc: 增加预览功能
ArgoZhang Jun 7, 2025
5606e80
doc: 增加文档
ArgoZhang Jun 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/BootstrapBlazor.Server/BootstrapBlazor.Server.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
<PackageReference Include="BootstrapBlazor.Html2Image" Version="9.0.2" />
<PackageReference Include="BootstrapBlazor.Html2Pdf" Version="9.0.2" />
<PackageReference Include="BootstrapBlazor.IconPark" Version="9.0.3" />
<PackageReference Include="BootstrapBlazor.ImageCropper" Version="9.0.1" />
<PackageReference Include="BootstrapBlazor.ImageCropper" Version="9.0.2" />
<PackageReference Include="BootstrapBlazor.IP2Region" Version="9.0.1" />
<PackageReference Include="BootstrapBlazor.JitsiMeet" Version="9.0.0" />
<PackageReference Include="BootstrapBlazor.JuHeIpLocatorProvider" Version="9.0.0" />
Expand Down
44 changes: 30 additions & 14 deletions src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,50 @@
<PackageTips Name="BootstrapBlazor.ImageCropper" />

<DemoBlock Title="@Localizer["ImageCropperNormalText"]" Introduction="@Localizer["ImageCropperNormalIntro"]" Name="Normal">
<ImageCropper @ref="_cropper" Url="@_images[0]"></ImageCropper>
<ImageCropper @ref="_cropper" Url="@_images[0]" Options="_roundOptions1"></ImageCropper>
<section ignore>
<BootstrapInputGroup>
<Button Text="OK" OnClick="Crop" />
<Button Text="@Localizer["ImageCropperResetText"]" OnClick="_cropper.Reset" />
<Button Text="@Localizer["ImageCropperReplaceText"]" OnClick="OnClickReplace" />
<Button Text="@Localizer["ImageCropperRotateText"]" OnClick="Rotate" />
<Button Text="@Localizer["ImageCropperEnableText"]" OnClick="_cropper.Enable" />
<Button Text="@Localizer["ImageCropperDisabledText"]" OnClick="_cropper.Disable" />
<Button Text="@Localizer["ImageCropperClearText"]" OnClick="_cropper.Clear" />
<Button Text="OK" OnClick="Crop"></Button>
<Button Text="@Localizer["ImageCropperResetText"]" OnClick="_cropper.Reset"></Button>
<Button Text="@Localizer["ImageCropperReplaceText"]" OnClick="OnClickReplace"></Button>
<Button Text="@Localizer["ImageCropperRotateText"]" OnClick="Rotate"></Button>
<Button Text="@Localizer["ImageCropperEnableText"]" OnClick="_cropper.Enable"></Button>
<Button Text="@Localizer["ImageCropperDisabledText"]" OnClick="_cropper.Disable"></Button>
<Button Text="@Localizer["ImageCropperClearText"]" OnClick="_cropper.Clear"></Button>
</BootstrapInputGroup>

<div class="d-flex mt-3" style="gap: 0.5rem;">
<div class="bb-cropper-preview bb-cropper-preview1 bb-cropper-preview-lg"></div>
<div class="bb-cropper-preview bb-cropper-preview1 bb-cropper-preview-md"></div>
<div class="bb-cropper-preview bb-cropper-preview1 bb-cropper-preview-sm"></div>
<div class="bb-cropper-preview bb-cropper-preview1 bb-cropper-preview-xs"></div>
</div>

@if (!string.IsNullOrEmpty(_base64String))
{
<img src="@_base64String" style="width: 240px;" />
<Textarea Value="@_base64String" rows="3" class="mt-3" />
<img src="@_base64String" style="width: 240px; margin-top: 1rem;" />
<Textarea Value="@_base64String" rows="3" class="mt-3"></Textarea>
}
</section>
</DemoBlock>

<DemoBlock Title="@Localizer["ImageCropperNormalText"]" Introduction="@Localizer["ImageCropperNormalIntro"]" Name="Normal">
<ImageCropper @ref="_roundCropper" Url="@_images[0]" CropperShape="ImageCropperShape.Round" Options="_roundOptions" />
<DemoBlock Title="@Localizer["ImageCropperRoundText"]" Introduction="@Localizer["ImageCropperRoundIntro"]" Name="Round">
<ImageCropper @ref="_roundCropper" Url="@_images[0]" Options="_roundOptions2"></ImageCropper>
<section ignore>
<BootstrapInputGroup>
<Button Text="OK" OnClick="RoundCrop" />
<Button Text="OK" OnClick="RoundCrop"></Button>
</BootstrapInputGroup>

<div class="d-flex mt-3" style="gap: 0.5rem;">
<div class="bb-cropper-preview bb-cropper-preview-round bb-cropper-preview-lg"></div>
<div class="bb-cropper-preview bb-cropper-preview-round bb-cropper-preview-md"></div>
<div class="bb-cropper-preview bb-cropper-preview-round bb-cropper-preview-sm"></div>
<div class="bb-cropper-preview bb-cropper-preview-round bb-cropper-preview-xs"></div>
</div>

@if (!string.IsNullOrEmpty(_base64String2))
{
<img src="@_base64String2" style="width: 240px;" />
<img src="@_base64String2" style="width: 240px; margin-top: 1rem;" />
}
</section>
</DemoBlock>
Expand Down
10 changes: 4 additions & 6 deletions src/BootstrapBlazor.Server/Components/Samples/ImageCroppers.razor.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ public partial class ImageCroppers

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

@sourcery-ai sourcery-ai bot Jun 7, 2025

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.


private readonly ImageCropperOption _roundOptions2 = new() { IsRound = true, Preview = ".bb-cropper-preview-round" };

/// <summary>
/// <inheritdoc/>
Expand Down Expand Up @@ -56,11 +58,7 @@ private async Task RoundCrop()

private Task Rotate() => _cropper.Rotate(90);

/// <summary>
/// GetAttributes
/// </summary>
/// <returns></returns>
protected AttributeItem[] GetAttributes() =>
private AttributeItem[] GetAttributes() =>
[
new()
{
Expand Down
4 changes: 3 additions & 1 deletion src/BootstrapBlazor.Server/Locales/en-US.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6679,7 +6679,9 @@
"BootstrapBlazor.Server.Components.Samples.ImageCroppers": {
"Title": "Image cropper",
"ImageCropperNormalText": "Basic usage",
"ImageCropperNormalIntro": "Url parameter setting image",
"ImageCropperNormalIntro": "The URL of the image can be set by setting the <code>Url</code> parameter. The cropping ratio can be set by setting <code>ImageCropperOption.AspectRatio=16/9f</code>. <code>1</code> is a square.",
"ImageCropperRoundText": "Round",
"ImageCropperRoundIntro": "Set the cropping mode to circular by setting the <code>IsRound</code> parameter",
"ImageCropperResetText": "Reset",
"ImageCropperReplaceText": "Replace",
"ImageCropperRotateText": "Rotate",
Expand Down
4 changes: 3 additions & 1 deletion src/BootstrapBlazor.Server/Locales/zh-CN.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6679,7 +6679,9 @@
"BootstrapBlazor.Server.Components.Samples.ImageCroppers": {
"Title": "ImageCropper 图像裁剪",
"ImageCropperNormalText": "基础用法",
"ImageCropperNormalIntro": "Url 参数设置图片",
"ImageCropperNormalIntro": "通过设置 <code>Url</code> 参数设置图片地址，可通过设置 <code>ImageCropperOption.AspectRatio=16/9f</code> 设置裁剪框比例，<code>1</code> 时为正方形",
"ImageCropperRoundText": "圆角",
"ImageCropperRoundIntro": "通过设置 <code>IsRound</code> 参数设置裁剪方式为圆形",
"ImageCropperResetText": "复位",
"ImageCropperReplaceText": "替换",
"ImageCropperRotateText": "旋转",
Expand Down