Skip to content

Conversation

@ArgoZhang
Copy link
Member

@ArgoZhang ArgoZhang commented Dec 6, 2024

remove IconList component

Summary of the changes (Less than 80 chars)

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

Description

fixes #4792

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

Remove the IconList component and replace its usage with direct HTML markup for displaying icon information. Fix incorrect URLs in icon information links to point directly to the icon list. Update documentation links to ensure they direct users to the correct icon list pages.

Bug Fixes:

  • Fix incorrect URLs in icon information links to point directly to the icon list.

Enhancements:

  • Replace the IconList component usage with direct HTML markup for displaying icon information.

Documentation:

  • Update documentation links to point directly to the icon list for various icon libraries.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Dec 6, 2024

Reviewer's Guide by Sourcery

This PR removes the IconList components for various icon libraries (FontAwesome, AntDesign, ElementUI, IconPark) and replaces them with direct links to the official icon documentation. The implementation simplifies the icon documentation by removing local icon listings and instead directing users to the respective icon library websites.

Class diagram for removed IconList components

classDiagram
    class FAIcons {
        - bool ShowCopyDialog
        - string DisplayText
    }

    class AntDesignIconList
    class ElementIconList
    class FAIconList
    class IconParkList

    FAIcons --> AntDesignIconList : removed
    FAIcons --> ElementIconList : removed
    FAIcons --> FAIconList : removed
    FAIcons --> IconParkList : removed

    note for FAIcons "ShowCopyDialog and DisplayText attributes removed"
    note for AntDesignIconList "Component removed"
    note for ElementIconList "Component removed"
    note for FAIconList "Component removed"
    note for IconParkList "Component removed"
Loading

File-Level Changes

Change Details Files
Remove IconList components and their associated files
  • Remove AntDesignIconList component and related files
  • Remove ElementIconList component and related files
  • Remove FAIconList component and related files
  • Remove IconParkList component and related files
src/BootstrapBlazor.Shared/Components/Samples/Icons/AntDesignIconList.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/ElementIconList.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/FAIconList.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/IconParkList.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/FAIconList.razor.cs
src/BootstrapBlazor.Shared/Components/Samples/Icons/FAIconList.razor.css
src/BootstrapBlazor.Shared/Components/Samples/Icons/FAIconList.razor.js
Update icon documentation pages to use external references
  • Add direct links to official icon documentation websites
  • Add example icon usage code snippets
  • Update localization strings for both English and Chinese
src/BootstrapBlazor.Shared/Locales/en-US.json
src/BootstrapBlazor.Shared/Locales/zh-CN.json
src/BootstrapBlazor.Shared/Components/Samples/Icons/BootstrapIcons.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/MaterialDesignIcons.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/FAIcons.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/ElementIcons.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/IconParks.razor
src/BootstrapBlazor.Shared/Components/Samples/Icons/AntDesignIcons.razor

Assessment against linked issues

Issue Objective Addressed Explanation
#4792 Remove IconList component
#4792 Add sample code for Icon 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

@bb-auto bb-auto bot added the documentation Improvements or additions to documentation label Dec 6, 2024
@bb-auto bb-auto bot added this to the v9.0.0 milestone Dec 6, 2024
@ArgoZhang ArgoZhang enabled auto-merge (squash) December 6, 2024 06:53
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 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.

@codecov
Copy link

codecov bot commented Dec 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1079c49) to head (5c47f1e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main     #4793   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          620       620           
  Lines        27425     27425           
  Branches      3925      3925           
=========================================
  Hits         27425     27425           

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

@ArgoZhang ArgoZhang merged commit 9493604 into main Dec 6, 2024
5 checks passed
@ArgoZhang ArgoZhang deleted the chore-misc branch December 6, 2024 06:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

doc(Icon): remove IconList component

2 participants