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

feat(IFrame): update default style #4556

Merged
merged 8 commits into from
Oct 27, 2024
Merged

feat(IFrame): update default style #4556

merged 8 commits into from
Oct 27, 2024

Conversation

ArgoZhang
Copy link
Collaborator

@ArgoZhang ArgoZhang commented Oct 27, 2024

update default style

Summary of the changes (Less than 80 chars)

简单描述你更改了什么, 不超过80个字符;如果有关联 Issue 请在下方填写相关编号

Description

fixes #4555

Regression?

  • Yes
  • No

[If yes, specify the version the behavior has regressed from]

[是否影响老版本]

Risk

  • High
  • Medium
  • Low

[Justify the selection above]

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

Update the default style of the IFrame component and add a new sample demonstrating its usage. Enhance the component's documentation with detailed descriptions and examples in multiple languages.

New Features:

  • Introduce a new IFrame component sample that demonstrates embedding documents, videos, and interactive media within a page.

Enhancements:

  • Update the default style of the IFrame component to have a full height and width.

Documentation:

  • Add user-facing documentation for the new IFrame component, including descriptions and usage examples in both English and Chinese.

@bb-auto bb-auto bot added the enhancement New feature or request label Oct 27, 2024
@bb-auto bb-auto bot added this to the v8.10.0 milestone Oct 27, 2024
Copy link

sourcery-ai bot commented Oct 27, 2024

Reviewer's Guide by Sourcery

This PR introduces a new IFrame component with updated styling and documentation. The implementation includes adding the component to the navigation menu, creating sample pages with documentation, and updating localization files for both English and Chinese languages.

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

File-Level Changes

Change Details Files
Update IFrame component styling
  • Remove 8px height reduction from frame calculation
  • Set frame to use 100% of available height
src/BootstrapBlazor/Components/IFrame/IFrame.razor.scss
Add IFrame component documentation and examples
  • Create new sample page with basic IFrame usage
  • Add attribute documentation for Src, Data, and OnPostDataAsync properties
  • Include demo block with example using pro.blazor.zone URL
src/BootstrapBlazor.Server/Components/Samples/IFrames.razor
src/BootstrapBlazor.Server/Components/Samples/IFrames.razor.cs
Update localization resources
  • Add IFrame-related translations for English and Chinese
  • Include descriptions, titles, and attribute explanations in both languages
src/BootstrapBlazor.Server/Locales/en-US.json
src/BootstrapBlazor.Server/Locales/zh-CN.json
Add IFrame to navigation menu
  • Insert IFrame menu item in the component navigation list
src/BootstrapBlazor.Server/Extensions/MenusLocalizerExtensions.cs

Assessment against linked issues

Issue Objective Addressed Explanation
#4555 Update the default style of the IFrame 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.
  • 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 @ArgoZhang - I've reviewed your changes and found some issues that need to be addressed.

Blocking issues:

  • Consider adding validation and sanitization for the Height parameter to prevent CSS injection (link)

Overall Comments:

  • Consider adding documentation about security considerations when using IFrames, particularly around the same-origin policy and potential risks of embedding external content.
  • Documentation contains mixed Chinese and English content. Please standardize to use a single language or provide complete translations for both languages.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🔴 Security: 1 blocking issue
  • 🟢 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.

Copy link

codecov bot commented Oct 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (c069a65) to head (373b0f4).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4556   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          622       622           
  Lines        26936     26936           
  Branches      3923      3923           
=========================================
  Hits         26936     26936           

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

@ArgoZhang
Copy link
Collaborator Author

@sourcery-ai review

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 @ArgoZhang - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 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.

@ArgoZhang ArgoZhang enabled auto-merge (squash) October 27, 2024 02:55
@ArgoZhang ArgoZhang merged commit 39ba47c into main Oct 27, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the refactor-iframe branch October 27, 2024 02:55
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(IFrame): update default style
1 participant