Enhance API docs and metadata for Offcanvas, Pagination, PdfViewer #1223
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added [AddedVersion], [DefaultValue], [Description], and [ParameterTypeName] attributes to Offcanvas and Pagination components for improved API clarity and tooling support. Updated XML docs to clarify default values and usage. Refactored fields and properties to use nullable types where appropriate, and removed obsolete or redundant code. These changes improve maintainability, usability, and self-documentation of the components.
Enhanced the XML documentation for FirstLinkText, LastLinkText, NextLinkText, and PreviousLinkText properties in the Pagination component by wrapping property and icon names in <b> tags for better emphasis and clarity. No changes to component logic or behavior.
Refactored PdfViewer to use nullable injection for PdfViewerJsInterop and applied the null-forgiving operator for null-safety. Added metadata attributes ([AddedVersion], [Description], [DefaultValue], [ParameterTypeName]) to several parameters and improved XML documentation. No changes to component logic; updates focus on safety and documentation.
Changed the Url property in password-protected PDF demo components to use a parent-relative path ("../static-assets/docs/...") instead of a direct relative path. This ensures correct file loading after directory structure changes.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.