Add MudBlazor docs and "BlazorUI" doc-params dimension by maliming · Pull Request #25380 · abpframework/abp

maliming · 2026-05-07T04:06:37Z

Adds a "BlazorUI" doc-params dimension (Blazorise / MudBlazor) and fills MudBlazor variants for the Blazor UI framework docs, theme docs, and book-store / todo / modular-crm tutorials.

Adds an optional DependsOn map to DocumentParameterDto so a parameter can be hidden when dependencies aren't satisfied (e.g. BlazorUI only shows when UI is one of Blazor/BlazorServer/BlazorWebApp). Visibility is evaluated on the server in the project document index page.

- Introduce a new "BlazorUI" doc-params dimension (Blazorise / MudBlazor) so Blazor docs can show MudBlazor variants of code samples next to the existing Blazorise ones - Cover framework/ui/blazor (overall, theming, basic-theme, forms-validation, submit-button, page-layout, page-header, page-toolbar-extensions, entity-action-extensions, data-table-column-extensions, error-handling, customization-overriding-components) - Cover ui-themes (index, basic-theme, lepton-x, lepton-x-lite) - Cover tutorials (book-store part 02/03/09/10, todo single-layer/layered, modular-crm part 03/05/06, book-store-with-abp-suite part-05) - Add an optional "DependsOn" map to DocumentParameterDto so a parameter can be hidden when dependencies aren't satisfied (e.g. only show BlazorUI when UI is one of Blazor/BlazorServer/BlazorWebApp). Visibility is evaluated on the server in the project document index page.

Copilot

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Adds a new BlazorUI doc parameter dimension (Blazorise vs MudBlazor), updates many docs to include MudBlazor variants, and introduces server-side evaluation for conditional doc-parameter visibility via dependsOn.

Changes:

Add DependsOn to DocumentParameterDto and propagate it into the project document preferences.
Implement server-side parameter visibility logic and hide non-applicable parameters on the project docs index page.
Update docs (themes/framework/tutorials) to include BlazorUI doc-params and MudBlazor-specific content blocks.

Reviewed changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs	Adds `IsParameterVisible` and copies `DependsOn` into saved preferences.
modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml	Hides parameter UI blocks based on server-evaluated visibility.
modules/docs/src/Volo.Docs.Application.Contracts/Volo/Docs/Documents/DocumentParameterDto.cs	Introduces `DependsOn` conditional visibility metadata on doc params.
docs/en/ui-themes/lepton-x/blazor.md	Adds `BlazorUI` param and MudBlazor variant notes for LeptonX.
docs/en/ui-themes/lepton-x-lite/blazor.md	Adds `BlazorUI` param and MudBlazor variant notes for LeptonX Lite.
docs/en/ui-themes/index.md	Documents Blazor UI library choice (Blazorise vs MudBlazor).
docs/en/ui-themes/basic-theme/index.md	Clarifies Basic Theme package names for the two Blazor UI library variants.
docs/en/tutorials/todo/single-layer/index.md	Adds `BlazorUI` param and MudBlazor alternative UI snippets.
docs/en/tutorials/todo/layered/index.md	Adds `BlazorUI` param and MudBlazor alternative UI snippets.
docs/en/tutorials/modular-crm/part-06.md	Adds `BlazorUI` param and MudBlazor UI snippet.
docs/en/tutorials/modular-crm/part-05.md	Adds `BlazorUI` param and MudBlazor UI snippet.
docs/en/tutorials/modular-crm/part-03.md	Adds `BlazorUI` param and MudBlazor UI snippet.
docs/en/tutorials/book-store/part-10.md	Adds `BlazorUI` param and MudBlazor alternatives for UI parts.
docs/en/tutorials/book-store/part-09.md	Adds `BlazorUI` param and MudBlazor alternatives for Authors UI implementation.
docs/en/tutorials/book-store/part-03.md	Adds `BlazorUI` param and MudBlazor alternatives for Books UI snippets.
docs/en/tutorials/book-store/part-02.md	Adds `BlazorUI` param and MudBlazor CRUD page variant content.
docs/en/tutorials/book-store-with-abp-suite/part-05.md	Adds `BlazorUI` param to tutorial doc-params.
docs/en/framework/ui/blazor/theming.md	Adds `BlazorUI` param and MudBlazor-specific theming guidance.
docs/en/framework/ui/blazor/page-toolbar-extensions.md	Adds `BlazorUI` param and MudBlazor examples/snippets.
docs/en/framework/ui/blazor/page-layout.md	Adds `BlazorUI` param and MudBlazor examples/snippets.
docs/en/framework/ui/blazor/page-header.md	Adds `BlazorUI` param and MudBlazor breadcrumb/toolbar examples.
docs/en/framework/ui/blazor/overall.md	Adds `BlazorUI` param and MudBlazor variant overview content.
docs/en/framework/ui/blazor/forms-validation.md	Adds `BlazorUI` param and MudBlazor validation documentation.
docs/en/framework/ui/blazor/error-handling.md	Adds `BlazorUI` param and MudBlazor error-handling examples/snippets.
docs/en/framework/ui/blazor/entity-action-extensions.md	Adds `BlazorUI` param and MudBlazor-specific `EntityAction` examples.
docs/en/framework/ui/blazor/data-table-column-extensions.md	Adds `BlazorUI` param and MudBlazor data-grid column example.
docs/en/framework/ui/blazor/customization-overriding-components.md	Adds `BlazorUI` param and MudBlazor theme-specific override guidance.
docs/en/framework/ui/blazor/components/submit-button.md	Adds `BlazorUI` param and MudBlazor alternative guidance (no `SubmitButton` wrapper).
docs/en/framework/ui/blazor/basic-theme.md	Adds `BlazorUI` param and MudBlazor variant notes for Basic Theme.
docs/en/docs-params.json	Defines new `BlazorUI` doc param with `dependsOn` gating by `UI`.

- forms-validation: drop incorrect manual _form.Validate() inside OnCreatingEntityAsync; the base CreateEntityAsync validates CreateFormRef before calling the override hook - book-store/part-03: note that MudDatePicker.@bind-Date requires DateTime? and link the abp-samples/MudBlazorSample reference

- book-store/part-02: switch the Books page from AbpMudExtensibleDataGrid to the standard MudBlazor MudDataGrid + <PropertyColumn> pattern (matches Identity.Pro SecurityLogManagement); use RowsPerPage instead of PageSize - book-store/part-03: replace the abp-internal MudDataGridEntityActionsColumn / MudEntityActions / MudEntityAction wrappers with the standard MudBlazor TemplateColumn + MudMenu + MudMenuItem so the tutorial stays approachable; drop a misleading link to the legacy abp-samples/MudBlazorSample demo; add a note that MudDatePicker.@bind-Date requires DateTime? - book-store/part-09: wrap MudDialog.ShowAsync/CloseAsync calls with InvokeAsync (matches Identity.Pro OrganizationUnitsManagement) and harden OnDataGridReadAsync against null SortBy entries

- Index.cshtml.cs: cache the rendered parameter name set so IsParameterVisible doesn't allocate a HashSet per call inside the cshtml loop; clarify per-rule semantics in comments (empty allow-list is an explicit "never show", null/unknown-key rules fail-open) - forms-validation.md: drop the inaccurate IValidationRule reference and describe MudBlazor's actual validation surface (ValidationAttribute on the Validation parameter, Func<T,string>/Func<T,IEnumerable<string>>, optional FluentValidation) - book-store/part-02.md: use {(int)context.Item.Type} for the BookType localization key to stay consistent with the rest of the tutorial

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 3 comments.

codecov · 2026-05-07T05:31:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.29%. Comparing base (d6c5fc7) to head (24bd4b0).
⚠️ Report is 327 commits behind head on rel-10.4.

Additional details and impacted files

@@             Coverage Diff              @@
##           rel-10.4   #25380      +/-   ##
============================================
- Coverage     49.30%   49.29%   -0.01%     
============================================
  Files          3667     3667              
  Lines        123171   123177       +6     
  Branches       9407     9409       +2     
============================================
- Hits          60731    60722       -9     
- Misses        60631    60645      +14     
- Partials       1809     1810       +1

☔ 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.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 2 comments.

…x page

…nd spacing

…d organization

Copilot AI review requested due to automatic review settings May 7, 2026 04:06

maliming added this to the 10.4-final milestone May 7, 2026

Copilot AI reviewed May 7, 2026

View reviewed changes

maliming added 3 commits May 7, 2026 12:10

maliming requested a review from Copilot May 7, 2026 04:57

Copilot started reviewing on behalf of maliming May 7, 2026 04:59 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml

Comment thread modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs

Comment thread modules/docs/src/Volo.Docs.Application.Contracts/Volo/Docs/Documents/DocumentParameterDto.cs

Address second-round Copilot review and fix grid layout bug

bd02c54

maliming requested a review from Copilot May 7, 2026 05:39

Copilot started reviewing on behalf of maliming May 7, 2026 05:41 View session

Copilot AI reviewed May 7, 2026

View reviewed changes

Comment thread modules/docs/src/Volo.Docs.Application.Contracts/Volo/Docs/Documents/DocumentParameterDto.cs Outdated

Comment thread modules/docs/src/Volo.Docs.Web/Pages/Documents/Project/Index.cshtml.cs

Update documentation parameters and clean up visibility logic in Inde…

5bc145c

…x page

maliming mentioned this pull request May 7, 2026

Add mudblazor documents #25378

Closed

maliming added 3 commits May 7, 2026 15:32

Refactor MudBlazor dialog forms to use MudStack for improved layout a…

737dba1

…nd spacing

Merge branch 'rel-10.4' into maliming/blazor-ui-library-docs-mud

b59415f

Refactor BlazorUI section in docs-params.json for improved clarity an…

aaa9e51

…d organization

maliming requested review from enisn and ismcagdas May 7, 2026 09:40

Merge branch 'rel-10.4' into maliming/blazor-ui-library-docs-mud

24bd4b0

ismcagdas approved these changes May 11, 2026

View reviewed changes

enisn merged commit e553a25 into rel-10.4 May 12, 2026
3 of 4 checks passed

enisn deleted the maliming/blazor-ui-library-docs-mud branch May 12, 2026 10:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MudBlazor docs and "BlazorUI" doc-params dimension#25380

Add MudBlazor docs and "BlazorUI" doc-params dimension#25380
enisn merged 10 commits into
rel-10.4from
maliming/blazor-ui-library-docs-mud

maliming commented May 7, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented May 7, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

maliming commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov Bot commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

maliming commented May 7, 2026 •

edited

Loading

codecov Bot commented May 7, 2026 •

edited

Loading