Commit 53a92d0
authored
Enhance Ribbon API docs and add metadata attributes (#1224)
* Enhance metadata and docs for Placeholder components
Improve XML docs and add [AddedVersion], [DefaultValue], and [Description] attributes to Placeholder and PlaceholderContainer parameters. Remove redundant remarks and clarify default values. Add [ParameterTypeName] to ChildContent for better tooling and documentation support.
* Add Preload Service feature, docs, and navigation
- Added Preload Service route constants and screenshot paths for demos and docs
- Updated navigation menus to include Preload Service under Services
- Added PreloadService documentation page with screenshot and methods table
- Enhanced Preload component parameter documentation with version and default value attributes
- Documented PreloadService Show/Hide methods with XML comments and attributes
- Fixed DemoLink in BreadcrumbService documentation to correct target
* Enhance Progress/ProgressBar API docs and metadata
Improved XML documentation and added metadata attributes ([AddedVersion], [DefaultValue], [Description], [ParameterTypeName]) to parameters and methods in Progress and ProgressBar components. Updated Label to nullable string. Adjusted documentation sections to better reflect available methods and parameters. These changes improve API clarity and tooling support.
* Enhance Ribbon API docs and add metadata attributes
Add detailed XML documentation and custom metadata attributes
([AddedVersion], [DefaultValue], [Description], [ParameterTypeName])
to Ribbon, RibbonTab, RibbonGroup, RibbonItem, RibbonItemGroup,
and RibbonEventArgs. Update event and parameter docs, make
ChildContent nullable and consistent, and improve discoverability
in the documentation page. Improves API clarity and self-documentation.
* Refactor attribute access, improve type name resolution
Refactored PropertyInfoExtenstions to use Attribute.GetCustomAttribute for attribute retrieval, simplifying code. Added NullabilityInfoContext and GetFriendlyTypeName for accurate C# type name generation, including nullable and generic types. Updated GetParameterTypeName to use new logic. Renamed RibbonTab.razor.cs property ChildContent to Content.
* Improve property type name display for complex types
Enhanced type name rendering in DocxPropertyRow to accurately display tuples, generics, nullable types, and object types. Updated extension methods and constants to ensure C#-idiomatic and user-friendly type names in the UI.
* Improve type name display with nullability and generics
Refactored method and property type name extraction to use a new GetFriendlyTypeName extension based on NullabilityInfo, ensuring accurate C#-style type names (including nullability, generics, and tuples). Simplified method signature display in DocxMethodRow.razor. Removed legacy type name formatting logic and centralized type name handling in the new NullabilityInfoExtensions.cs. Attribute extraction now uses Attribute.GetCustomAttribute. These changes modernize and unify type name presentation across the documentation/demo UI.
* Remove [ParameterTypeName] from Accordion components
Removed the [ParameterTypeName] attribute from several parameters
in Accordion and AccordionItem classes. Parameters remain unchanged
and still use [Parameter], but no longer include explicit type
annotations via [ParameterTypeName].1 parent 546f030 commit 53a92d0
63 files changed
Lines changed: 467 additions & 299 deletions
File tree
- BlazorBootstrap.Demo.RCL
- Components
- Layout
- Pages/Docs
- ConfirmDialog
- Progress
- Ribbon
- Services
- BreadcrumbService
- PreloadService
- Constants
- Extensions
- blazorbootstrap
- Components
- Accordion
- Alert
- Badge
- Breadcrumb
- Button
- Callout
- Card
- Carousel
- Collapse
- ConfirmDialog
- Dropdown
- Maps
- Markdown
- Modals
- Offcanvas
- Pagination
- PdfViewer
- Placeholders
- Preload
- Progress
- Ribbon
- Constants
- EventArguments/Ribbon
- Services
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 3 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | | - | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
103 | 105 | | |
104 | 106 | | |
105 | 107 | | |
| |||
Lines changed: 2 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
75 | 75 | | |
76 | 76 | | |
77 | 77 | | |
78 | | - | |
| 78 | + | |
79 | 79 | | |
| 80 | + | |
80 | 81 | | |
81 | 82 | | |
82 | 83 | | |
| |||
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
21 | 25 | | |
22 | 26 | | |
23 | 27 | | |
| |||
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
18 | 18 | | |
19 | 19 | | |
20 | 20 | | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | 21 | | |
26 | 22 | | |
27 | 23 | | |
28 | 24 | | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
Lines changed: 4 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
29 | 33 | | |
30 | 34 | | |
31 | 35 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
11 | | - | |
| 11 | + | |
12 | 12 | | |
13 | 13 | | |
14 | 14 | | |
| |||
Lines changed: 29 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
7 | | - | |
| 6 | + | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
Lines changed: 2 additions & 8 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
| 14 | + | |
21 | 15 | | |
22 | 16 | | |
23 | 17 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
7 | | - | |
| 7 | + | |
8 | 8 | | |
9 | 9 | | |
10 | 10 | | |
| |||
0 commit comments