feat(blazorui): add missing xml docs to all components #9575 (#9641)

src/BlazorUI/Bit.BlazorUI.Extras/Components/AppShell/BitAppShell.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitAppShell is an advanced container to handle the nuances of a cross-platform layout.
+/// </summary>
 public partial class BitAppShell : BitComponentBase
 {
     private ElementReference _containerRef = default!;

src/BlazorUI/Bit.BlazorUI.Extras/Components/Chart/BitChart.razor.cs

@@ -5,7 +5,7 @@
 namespace Bit.BlazorUI;
 
 /// <summary>
-/// Represents a Chart.js chart.
+/// Simple and flexible charting component for data visualization, which supports eight chart types: bar, line, area, pie, bubble, radar, polar, and scatter.
 /// </summary>
 public partial class BitChart : IAsyncDisposable
 {

src/BlazorUI/Bit.BlazorUI.Extras/Components/DataGrid/BitDataGrid.razor.cs

@@ -1,7 +1,7 @@
 namespace Bit.BlazorUI;
 
 /// <summary>
-/// A component that displays a grid.
+/// BitDataGrid is a robust way to display an information-rich collection of items, and allow people to sort, and filter the content.
 /// </summary>
 /// <typeparam name="TGridItem">The type of data represented by each row in the grid.</typeparam>
 [CascadingTypeParameter(nameof(TGridItem))]

src/BlazorUI/Bit.BlazorUI.Extras/Components/ErrorBoundary/BitErrorBoundary.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitErrorBoundary is a simple error boundary to handle exceptions happening in its children.
+/// </summary>
 public partial class BitErrorBoundary : ErrorBoundaryBase
 {
     [Inject] private NavigationManager _navigationManager { get; set; } = default!;

src/BlazorUI/Bit.BlazorUI.Extras/Components/MessageBox/BitMessageBox.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitMessageBox is a pre-implemented box for showing messages with title and body.
+/// </summary>
 public partial class BitMessageBox
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI.Extras/Components/NavPanel/BitNavPanel.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitNavPanel is a navigation component specialized to be rendered in a vertical panel.
+/// </summary>
 public partial class BitNavPanel<TItem> : BitComponentBase, IDisposable where TItem : class
 {
     private bool _disposed;

src/BlazorUI/Bit.BlazorUI.Extras/Components/PdfReader/BitPdfReader.razor.cs

@@ -2,16 +2,19 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitPdfReader is a simple pdf renderer utilizing the pdfjs library to bring pdf reading feature into Blazor world.
+/// </summary>
 public partial class BitPdfReader
 {
-    private int _currentPageNumber = 1;
     private bool _allPageRendered;
     private int _numberOfPages = 1;
+    private int _currentPageNumber = 1;
     private bool _parametersInitialized;
 
 
 
-    [Inject] private IJSRuntime _js { get; set; }
+    [Inject] private IJSRuntime _js { get; set; } = default!;
 
 
 

src/BlazorUI/Bit.BlazorUI.Extras/Components/ProPanel/BitProPanel.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// ProPanel is an advanced version of normal Panel with additional features that tailored to more usual use-cases.
+/// </summary>
 public partial class BitProPanel : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Buttons/BitActionButton/BitActionButton.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// ActionButton is a special type of button with a specific set of visual styles and properties.
+/// </summary>
 public partial class BitActionButton : BitComponentBase
 {
     private string? _rel;

src/BlazorUI/Bit.BlazorUI/Components/Buttons/BitButton/BitButton.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Buttons enable users to take actions with a single tap. They're commonly used in forms, dialog panels, and specialized for tasks like navigation or repeated actions.
+/// </summary>
 public partial class BitButton : BitComponentBase
 {
     private string? _rel;

src/BlazorUI/Bit.BlazorUI/Components/Buttons/BitButtonGroup/BitButtonGroup.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The ButtonGroup component can be used to group related buttons.
+/// </summary>
 public partial class BitButtonGroup<TItem> : BitComponentBase where TItem : class
 {
     private TItem? _toggleItem;

src/BlazorUI/Bit.BlazorUI/Components/Buttons/BitMenuButton/BitMenuButton.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A menu button is a menu item that displays a word or phrase that the user can click to initiate an operation.
+/// </summary>
 public partial class BitMenuButton<TItem> : BitComponentBase, IAsyncDisposable where TItem : class
 {
     private bool _disposed;

src/BlazorUI/Bit.BlazorUI/Components/Buttons/BitToggleButton/BitToggleButton.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// ToggleButton is a type of button that stores and shows a status representing the toggle state of the component.
+/// </summary>
 public partial class BitToggleButton : BitComponentBase
 {
     private int? _tabIndex;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Calendar/BitCalendar.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The calendar control lets people select and view a single date or a range of dates in their calendar. It’s made up of 3 separate views: the month view, year view, and decade view.
+/// </summary>
 public partial class BitCalendar : BitInputBase<DateTimeOffset?>
 {
     private const int DEFAULT_WEEK_COUNT = 6;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Checkbox/BitCheckbox.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitCheckbox is a component that permits the user to make a binary choice, a choice between one of two possible mutually exclusive options.
+/// </summary>
 public partial class BitCheckbox : BitInputBase<bool>, IDisposable
 {
     private string _inputId = string.Empty;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/ChoiceGroup/BitChoiceGroup.razor.cs

@@ -3,6 +3,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// ChoiceGroup let people select a single option from two or more choices.
+/// </summary>
 public partial class BitChoiceGroup<TItem, TValue> : BitInputBase<TValue> where TItem : class
 {
     private List<TItem> _items = [];

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Dropdown/BitDropdown.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A dropdown is a list in which the selected item is always visible while other items are visible on demand by clicking a dropdown button. Dropdowns are typically used for forms.
+/// </summary>
 public partial class BitDropdown<TItem, TValue> : BitInputBase<TValue>, IAsyncDisposable where TItem : class, new()
 {
     private bool _disposed;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/FileUpload/BitFileUpload.razor.cs

@@ -4,7 +4,7 @@
 namespace Bit.BlazorUI;
 
 /// <summary>
-/// A component that wraps the HTML file input element and uploads them.
+/// BitFileUpload component wraps the HTML file input element(s) and uploads them to a given URL. The files can be removed by specifying the URL they have been uploaded.
 /// </summary>
 public partial class BitFileUpload : BitComponentBase, IAsyncDisposable
 {

src/BlazorUI/Bit.BlazorUI/Components/Inputs/NumberField/BitNumberField.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A NumberField allows you to enter any number type and format you want. It could be a decimal number or integer number with a suffix and so on.
+/// </summary>
 public partial class BitNumberField<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TValue> : BitTextInputBase<TValue>
 {
     private bool _hasFocus;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/OtpInput/BitOtpInput.razor.cs

@@ -3,6 +3,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The OTP input is used for MFA procedure of authenticating users by a one-time password.
+/// </summary>
 public partial class BitOtpInput : BitInputBase<string?>
 {
     private string _labelId = default!;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Rating/BitRating.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Ratings show people’s opinions of a product, helping others make more informed purchasing decisions.
+/// </summary>
 public partial class BitRating : BitInputBase<double>
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Inputs/SearchBox/BitSearchBox.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A search box (SearchBox) provides an input field for searching content within a site or app to find specific items.
+/// </summary>
 public partial class BitSearchBox : BitTextInputBase<string?>, IAsyncDisposable
 {
     private bool _isOpen;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Slider/BitSlider.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A slider provides a visual indication of adjustable content, as well as the current setting in the total range of content.
+/// </summary>
 public partial class BitSlider : BitComponentBase
 {
     private int _inputHeight;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/SpinButton/BitSpinButton.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A spin button (SpinButton) allows someone to incrementally adjust a value in small steps. It’s mainly used for numeric values, but other values are supported too.
+/// </summary>
 public partial class BitSpinButton : BitInputBase<double>
 {
     private double _min;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/TextField/BitTextField.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Text fields give people a way to enter and edit text. They’re used in forms, modal dialogs, tables, and other surfaces where text input is required.
+/// </summary>
 public partial class BitTextField : BitTextInputBase<string?>
 {
     private bool _hasFocus;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/Toggle/BitToggle.razor.cs

@@ -3,6 +3,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A toggle represents a physical switch that allows someone to choose between two mutually exclusive options.  For example, “On/Off”, “Show/Hide”.
+/// </summary>
 public partial class BitToggle : BitInputBase<bool>
 {
     private string? _labelId;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/CircularTimePicker/BitCircularTimePicker.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A BitCircularTimePicker offers a drop-down control that’s optimized for picking a single time from a clock view where contextual information like the day of the week or fullness of the calendar is important.
+/// </summary>
 public partial class BitCircularTimePicker : BitInputBase<TimeSpan?>, IAsyncDisposable
 {
     private int? _hour;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/ColorPicker/BitColorPicker.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The color picker (ColorPicker) is used to browse through and select colors. By default, it lets people navigate through colors on a color spectrum, or specify a color in either Red-Green-Blue (RGB), or alpha color code; or Hexadecimal textboxes.
+/// </summary>
 public partial class BitColorPicker : BitComponentBase, IAsyncDisposable
 {
     private bool _disposed;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DatePicker/BitDatePicker.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A BitDatePicker offers a drop-down control that’s optimized for picking a single date from a calendar view where contextual information like the day of the week or fullness of the calendar is important.
+/// </summary>
 public partial class BitDatePicker : BitInputBase<DateTimeOffset?>, IAsyncDisposable
 {
     private const int MAX_WIDTH = 470;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/DateRangePicker/BitDateRangePicker.razor.cs

@@ -4,6 +4,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A BitDateRangePicker offers a drop-down control that’s optimized for picking two dates from a calendar view where contextual information like the day of the week or fullness of the calendar is important.
+/// </summary>
 public partial class BitDateRangePicker : BitInputBase<BitDateRangePickerValue?>, IAsyncDisposable
 {
     private const int MAX_WIDTH = 470;

src/BlazorUI/Bit.BlazorUI/Components/Inputs/_Pickers/TimePicker/BitTimePicker.razor.cs

@@ -3,6 +3,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A BitTimePicker offers a drop-down control that’s optimized for picking a single time from a clock view where contextual information like the day of the week or fullness of the calendar is important.
+/// </summary>
 public partial class BitTimePicker : BitInputBase<TimeSpan?>, IAsyncDisposable
 {
     private bool _hasFocus;

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Footer/BitFooter.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The BitFooter component is used to display a colored bar (with text and possibly other components) at the bottom of a site or application.
+/// </summary>
 public partial class BitFooter : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Grid/BitGrid.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The BitGrid component is a flexible and customizable grid layout, offering responsive columns and alignment flexibility for structured content presentation.
+/// </summary>
 public partial class BitGrid : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Header/BitHeader.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The BitHeader component is used to display a title (and possibly other components) in a colored bar at the top of a site or application.
+/// </summary>
 public partial class BitHeader : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Layout/BitLayout.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Layout can be used to create a base UI structure for an application.
+/// </summary>
 public partial class BitLayout : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Spacer/BitSpacer.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// The purpose of the BitSpacer is to generate space between other components. You can either create a space with a set width (in number of pixels) or create a space with a flexible width.
+/// </summary>
 public partial class BitSpacer : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Layouts/Stack/BitStack.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// A Stack is a container-type component that abstracts the implementation of a flexbox in order to define the layout of its children components.
+/// </summary>
 public partial class BitStack : BitComponentBase
 {
     /// <summary>

src/BlazorUI/Bit.BlazorUI/Components/Lists/BasicList/BitBasicList.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// BitBasicList provides a base component for rendering large sets of items. It’s agnostic of layout, the tile component used, and selection management.
+/// </summary>
 public partial class BitBasicList<TItem> : BitComponentBase
 {
     private _BitBasicListVirtualize<TItem>? _bitBasicListVirtualizeRef;

src/BlazorUI/Bit.BlazorUI/Components/Lists/Carousel/BitCarousel.razor.cs

@@ -1,5 +1,8 @@
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Carousel (Carousel slide-show) let people show their items in seperate slides from two or more items.
+/// </summary>
 public partial class BitCarousel : BitComponentBase, IAsyncDisposable
 {
     private bool _disposed;

src/BlazorUI/Bit.BlazorUI/Components/Lists/Swiper/BitSwiper.razor.cs

@@ -2,6 +2,9 @@
 
 namespace Bit.BlazorUI;
 
+/// <summary>
+/// Swipers (touch slider) let people show their slides in a swiping row.
+/// </summary>
 public partial class BitSwiper : BitComponentBase, IAsyncDisposable
 {
     private double _lastX;