From c82f16681d323f52750002d23ec364c4aedae686 Mon Sep 17 00:00:00 2001 From: Vincent Baaij Date: Tue, 17 May 2022 12:34:09 +0200 Subject: [PATCH] Add missing xml comments --- .../Components/FluentAccordion.razor.cs | 4 +++ .../Components/FluentAccordionItem.razor.cs | 3 ++ .../Components/FluentAnchor.razor.cs | 10 ++++-- .../Components/FluentAnchoredRegion.razor.cs | 14 ++++---- .../Components/FluentBadge.razor.cs | 9 +++++ .../Components/FluentBreadcrumbItem.razor.cs | 3 ++ .../Components/FluentButton.razor.cs | 9 +++++ .../Components/FluentCheckbox.razor.cs | 9 +++++ .../Components/FluentCombobox.razor.cs | 18 ++++++++++ .../Components/FluentDataGrid.razor.cs | 23 +++++++++++-- .../Components/FluentDataGridCell.razor.cs | 8 ++++- .../Components/FluentDataGridRow.razor.cs | 19 +++++++++-- .../Components/FluentDialog.razor.cs | 6 ++++ .../Components/FluentFlipper.razor.cs | 7 ++++ .../Components/FluentListbox.razor.cs | 3 ++ .../Components/FluentMenuItem.razor.cs | 6 ++++ .../Components/FluentOption.razor.cs | 6 ++++ .../Components/FluentProgress.razor.cs | 12 +++++++ .../Components/FluentProgressRing.razor.cs | 12 +++++++ .../Components/FluentRadio.razor.cs | 15 +++++++++ .../Components/FluentRadioGroup.razor.cs | 9 +++++ .../Components/FluentSelect.razor.cs | 12 +++++++ .../Components/FluentSkeleton.razor.cs | 9 +++++ .../Components/FluentSlider.razor.cs | 18 ++++++++++ .../Components/FluentSliderLabel.razor.cs | 6 ++++ .../Components/FluentSwitch.razor.cs | 9 +++++ .../Components/FluentTabs.razor.cs | 6 ++++ .../Components/FluentTextArea.razor.cs | 22 +++++++++++++ .../Components/FluentTextField.razor.cs | 33 +++++++++++++++++++ .../Components/FluentToolbar.razor.cs | 3 ++ .../Components/FluentTooltip.razor.cs | 21 ++++++++++++ .../Components/FluentTreeItem.razor.cs | 9 +++++ .../Components/FluentTreeView.razor.cs | 3 ++ 33 files changed, 342 insertions(+), 14 deletions(-) diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordion.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordion.razor.cs index 26bc0a8130..942510f41e 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordion.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordion.razor.cs @@ -4,6 +4,10 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentAccordion : FluentComponentBase { + + /// + /// Controls the expand mode of the Accordion, either allowing single or multiple item expansion . + /// [Parameter] public ExpandMode? ExpandMode { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordionItem.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordionItem.razor.cs index 89968b36fa..299ed87e5d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordionItem.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAccordionItem.razor.cs @@ -4,6 +4,9 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentAccordionItem : FluentComponentBase { + /// + /// Expands or collapses the item. + /// [Parameter] public bool? Expanded { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchor.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchor.razor.cs index ae10b580a1..bf619e93af 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchor.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchor.razor.cs @@ -3,13 +3,19 @@ namespace Microsoft.Fast.Components.FluentUI; -public partial class FluentAnchor : FluentComponentBase +public partial class FluentAnchor : FluentComponentBase { + /// + /// The URL this item references. + /// [Parameter] public string? Href { get; set; } + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } - + } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchoredRegion.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchoredRegion.razor.cs index fcecf3e070..cb57b86a9c 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchoredRegion.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentAnchoredRegion.razor.cs @@ -16,13 +16,13 @@ public partial class FluentAnchoredRegion : FluentComponentBase public string? Viewport { get; set; } /// - /// Default is 'uncontrolled'. + /// Default is 'uncontrolled'. See /// [Parameter] public Positioning? HorizontalPositioningMode { get; set; } = Positioning.Uncontrolled; /// - /// Default is 'unset' + /// Default is 'unset'. See /// [Parameter] public HorizontalPosition? HorizontalDefaultPosition { get; set; } = HorizontalPosition.Unset; @@ -40,19 +40,19 @@ public partial class FluentAnchoredRegion : FluentComponentBase public int HorizontalThreshold { get; set; } /// - /// Default is "Content" + /// Default is "Content". See /// [Parameter] public Scaling? HorizontalScaling { get; set; } = Scaling.Content; /// - /// Default is "Uncontrolled" + /// Default is "Uncontrolled". See /// [Parameter] public Positioning? VerticalPositioningMode { get; set; } = Positioning.Uncontrolled; /// - /// Default is "Unset" + /// Default is "Unset".See /// [Parameter] public VerticalPosition? VerticalDefaultPosition { get; set; } = VerticalPosition.Unset; @@ -70,13 +70,13 @@ public partial class FluentAnchoredRegion : FluentComponentBase public int VerticalThreshold { get; set; } /// - /// Default is "Content" + /// Default is "Content". See /// [Parameter] public Scaling? VerticalScaling { get; set; } = Scaling.Content; /// - /// Default is "Anchor". In 'anchor' mode only anchor resizes and attribute changes will provoke an update. In 'auto' mode the component also updates because of - any scroll event on the document, window resizes and viewport resizes + /// Default is "Anchor". In 'anchor' mode only anchor resizes and attribute changes will provoke an update. In 'auto' mode the component also updates because of - any scroll event on the document, window resizes and viewport resizes. See /// [Parameter] public UpdateMode? AutoUpdateMode { get; set; } = UpdateMode.Anchor; diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentBadge.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentBadge.razor.cs index efcbd00d44..0a44b1e163 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentBadge.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentBadge.razor.cs @@ -3,12 +3,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentBadge : FluentComponentBase { + /// + /// Gets or sets the color + /// [Parameter] public Color? Color { get; set; } + /// + /// Gets or sets the background color + /// [Parameter] public Fill? Fill { get; set; } + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentBreadcrumbItem.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentBreadcrumbItem.razor.cs index c566ea6cfa..db21ae531d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentBreadcrumbItem.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentBreadcrumbItem.razor.cs @@ -3,6 +3,9 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentBreadcrumbItem : FluentComponentBase { + /// + /// The URL this item references. + /// [Parameter] public string? Href { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentButton.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentButton.razor.cs index 6f0f8d8b92..18798f60bb 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentButton.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentButton.razor.cs @@ -3,12 +3,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentButton : FluentComponentBase { + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } + /// + /// Gets or sets if the button is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Determines if the element should receive document focus on page load. + /// [Parameter] public bool? Autofocus { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentCheckbox.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentCheckbox.razor.cs index 774b77d2d8..536e1c181d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentCheckbox.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentCheckbox.razor.cs @@ -5,12 +5,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentCheckbox : FluentInputBase { + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the element is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets if the element is readonly + /// [Parameter] public bool? Readonly { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentCombobox.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentCombobox.razor.cs index 8f42aa762f..f0dae186b5 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentCombobox.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentCombobox.razor.cs @@ -14,21 +14,39 @@ public partial class FluentCombobox : FluentInputBase [Parameter] public string? Name { get; set; } + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the element is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets if the element is auto completes + /// [Parameter] public Autocomplete? Autocomplete { get; set; } + /// + /// Gets or sets if the position of the element. See + /// [Parameter] public Position? Position { get; set; } + /// + /// Gets or set the list of items + /// [Parameter] public IEnumerable>? Items { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGrid.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGrid.razor.cs index beae53744c..5348a0644e 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGrid.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGrid.razor.cs @@ -3,20 +3,39 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentDataGrid : FluentComponentBase { - // FAST Attributes + /// + /// Gets or sets the + /// [Parameter] public GenerateHeaderOptions? GenerateHeader { get; set; } = GenerateHeaderOptions.Default; + + /// + /// Gets or sets the value that gets applied to the css gridTemplateColumns attribute of child rows + /// [Parameter] public string? GridTemplateColumns { get; set; } = ""; - //FAST Properties + + /// + /// Gets or sets the rows data + /// [Parameter] public List? RowsData { get; set; } + /// + /// Gets or sets the column definitions. See + /// [Parameter] public IEnumerable>? ColumnDefinitions { get; set; } + /// + /// Gets or sets the header cell template. See + /// [Parameter] public RenderFragment>? HeaderCellTemplate { get; set; } = null; + + /// + /// Gets or sets the row item template + /// [Parameter] public RenderFragment? RowItemTemplate { get; set; } = null; } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridCell.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridCell.razor.cs index 4ab6c4c7b1..9f29dc039d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridCell.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridCell.razor.cs @@ -3,9 +3,15 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentDataGridCell : FluentComponentBase { - // FAST Attributes + /// + /// Gets or sets the cell type. See + /// [Parameter] public DataGridCellType? CellType { get; set; } = DataGridCellType.Default; + + /// + /// Gets or sets the column where the cell should be displayed in + /// [Parameter] public int GridColumn { get; set; } } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridRow.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridRow.razor.cs index f221c6882c..3ac7d04879 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridRow.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDataGridRow.razor.cs @@ -4,18 +4,33 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentDataGridRow : FluentComponentBase { - // FAST Attributes + /// + /// Gets or sets the index of this row + /// [Parameter] public int? RowIndex { get; set; } + /// + /// Gets or sets the value that gets applied to the css gridTemplateColumns attribute of child rows + /// [Parameter] public string? GridTemplateColumns { get; set; } = null; + + /// + /// Gets or sets the type of row. Se + /// [Parameter] public DataGridRowType? RowType { get; set; } = DataGridRowType.Default; - // FAST Properties + + /// + /// Gets or sets the row data + /// [Parameter] public TItem? RowData { get; set; } + /// + /// Gets or sets the column definitions for the row. See + /// [Parameter] public IEnumerable>? ColumnDefinitions { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDialog.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDialog.razor.cs index 44404e6d88..436b690c9b 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentDialog.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentDialog.razor.cs @@ -4,9 +4,15 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentDialog : FluentComponentBase { + /// + /// Gets or sets if the dialog is shown modal + /// [Parameter] public bool? Modal { get; set; } + /// + /// Gets or sets if the dialog is hidden + /// [Parameter] public bool Hidden { get; set; } = false; diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentFlipper.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentFlipper.razor.cs index 87e0c8e67e..aec083239d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentFlipper.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentFlipper.razor.cs @@ -4,9 +4,16 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentFlipper : FluentComponentBase { + /// + /// Gets or set if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets the direction. See + /// + [Parameter] public Direction? Direction { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentListbox.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentListbox.razor.cs index f0a1057775..2a0e172833 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentListbox.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentListbox.razor.cs @@ -14,6 +14,9 @@ public partial class FluentListbox : FluentInputBase [Parameter] public string? Name { get; set; } + /// + /// Gets or sets the list of items. See + /// [Parameter] public IEnumerable>? Items { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentMenuItem.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentMenuItem.razor.cs index fb5c2cc526..fc0fbf0018 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentMenuItem.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentMenuItem.razor.cs @@ -4,9 +4,15 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentMenuItem : FluentComponentBase { + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the element is checked + /// [Parameter] public bool? Checked { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentOption.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentOption.razor.cs index 3848b11285..f5d2cb729d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentOption.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentOption.razor.cs @@ -6,6 +6,9 @@ public partial class FluentOption : FluentComponentBase { internal FluentOptionContext? Context { get; private set; } + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } @@ -21,6 +24,9 @@ public partial class FluentOption : FluentComponentBase /// [Parameter] public string? Name { get; set; } + /// + /// Gets or sets if the element is selected + /// [Parameter] public bool? Selected { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgress.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgress.razor.cs index 752f281dca..23269153e5 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgress.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgress.razor.cs @@ -4,15 +4,27 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentProgress : FluentComponentBase { + /// + /// Gets or sets the minimum value + /// [Parameter] public int? Min { get; set; } + /// + /// Gets or sets the maximum value + /// [Parameter] public int? Max { get; set; } + /// + /// Gets or sets the current value + /// [Parameter] public string? Value { get; set; } + /// + /// Gets or sets if the progress element is paused + /// [Parameter] public bool? Paused { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgressRing.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgressRing.razor.cs index 00dc95a582..f575da5478 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgressRing.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentProgressRing.razor.cs @@ -4,15 +4,27 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentProgressRing : FluentComponentBase { + /// + /// Gets or sets the minimum value + /// [Parameter] public int? Min { get; set; } + /// + /// Gets or sets the maximum value + /// [Parameter] public int? Max { get; set; } + /// + /// Gets or sets the current value + /// [Parameter] public string? Value { get; set; } + /// + /// Gets or sets if the progress element is paused + /// [Parameter] public bool? Paused { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadio.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadio.razor.cs index 1811bfbd3c..8a64205528 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadio.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadio.razor.cs @@ -4,18 +4,33 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentRadio : FluentComponentBase { + /// + /// Gets or sets the current value + /// [Parameter] public string? Value { get; set; } + /// + /// Gets or sets if the element is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the element is readonly + /// [Parameter] public bool? Readonly { get; set; } + /// + /// Gets or sets if the element is checked + /// [Parameter] public bool? Checked { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadioGroup.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadioGroup.razor.cs index 793bc50bf0..2cc9ceb44d 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadioGroup.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentRadioGroup.razor.cs @@ -6,12 +6,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentRadioGroup : FluentInputBase { + /// + /// Gets or sets the name of the group + /// [Parameter] public string? Name { get; set; } + /// + /// Gets or sets if the group is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets the orentation of the group. See + /// [Parameter] public Orientation? Orientation { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSelect.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSelect.razor.cs index 00dc310de7..bfb4acaf06 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSelect.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSelect.razor.cs @@ -14,15 +14,27 @@ public partial class FluentSelect : FluentInputBase [Parameter] public string? Name { get; set; } + /// + /// Gets or sets if the element is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } + /// + /// Gets or sets the position. See + /// [Parameter] public Position? Position { get; set; } + /// + /// Gets or sets the list of items. See + /// [Parameter] public IEnumerable>? Items { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSkeleton.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSkeleton.razor.cs index 190e1c860b..b18bcf6701 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSkeleton.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSkeleton.razor.cs @@ -4,12 +4,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentSkeleton : FluentComponentBase { + /// + /// Gets or sets the shape of the skeleton. See + /// [Parameter] public Shape? Shape { get; set; } + /// + /// Gets or sets if the skeleton is shimmered + /// [Parameter] public bool? Shimmer { get; set; } + /// + /// Gets or sets the skeleton pattern + /// [Parameter] public string? Pattern { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSlider.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSlider.razor.cs index 709a299049..e1c55ba30e 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSlider.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSlider.razor.cs @@ -7,21 +7,39 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentSlider : FluentInputBase { + /// + /// Gets or sets the orentation of the slider. See + /// [Parameter] public Orientation? Orientation { get; set; } + /// + /// Gets or sets the slider's minimal value + /// [Parameter] public int? Min { get; set; } + /// + /// Gets or sets the slider's maximum value + /// [Parameter] public int? Max { get; set; } + /// + /// Gets or sets the slider's step value + /// [Parameter] public int? Step { get; set; } + /// + /// Gets or sets if the slider is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the slider is readonly + /// [Parameter] public bool? Readonly { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSliderLabel.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSliderLabel.razor.cs index 275572755a..4ccc6b92ce 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSliderLabel.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSliderLabel.razor.cs @@ -4,9 +4,15 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentSliderLabel : FluentComponentBase { + /// + /// Gets or sets the slider's label position + /// [Parameter] public int? Position { get; set; } + /// + /// Gets or sets if marks are hidden + /// [Parameter] public bool? HideMark { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSwitch.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSwitch.razor.cs index 3b98a5bcc2..61772ca4fd 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentSwitch.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentSwitch.razor.cs @@ -5,12 +5,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentSwitch : FluentInputBase { + /// + /// Gets or sets if the switch is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the switch is checked + /// [Parameter] public bool? Checked { get; set; } + /// + /// Gets or sets if the switch is required + /// [Parameter] public bool? Required { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTabs.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTabs.razor.cs index 28087bee90..b8471d55a7 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTabs.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTabs.razor.cs @@ -4,9 +4,15 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTabs : FluentComponentBase { + /// + /// Gets or sets if the tab is active + /// [Parameter] public bool? ActiveIndicator { get; set; } + /// + /// Gets or sets the tab's orentation. See + /// [Parameter] public Orientation? Orientation { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextArea.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextArea.razor.cs index b56a2d2ad2..93c3047ddd 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextArea.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextArea.razor.cs @@ -6,24 +6,46 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTextArea : FluentInputBase { + /// + /// Gets or sets if the text area is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the text area is readonly + /// [Parameter] public bool? Readonly { get; set; } + /// + /// Gets or sets if the text area is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets if the text area is auto focussed + /// [Parameter] public bool? Autofocus { get; set; } + /// + /// Gets or sets if the text area is resizeable. See + /// [Parameter] public Resize? Resize { get; set; } + + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } + /// + /// Gets or sets the placholder text + /// [Parameter] public string? Placeholder { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextField.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextField.razor.cs index 67f8df4722..396f2cfac1 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextField.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTextField.razor.cs @@ -5,36 +5,69 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTextField : FluentInputBase { + /// + /// Gets or sets if the text area is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the text area is readonly + /// [Parameter] public bool? Readonly { get; set; } + /// + /// Gets or sets if the text area is required + /// [Parameter] public bool? Required { get; set; } + /// + /// Gets or sets if the text area is auto focussed + /// [Parameter] public bool? Autofocus { get; set; } + /// + /// Gets or sets the size of the text field + /// [Parameter] public int? Size { get; set; } + /// + /// Gets or sets the visual appearance. See + /// [Parameter] public Appearance? Appearance { get; set; } + /// + /// Gets or sets the text filed type. See + /// [Parameter] public TextFieldType? TextFieldType { get; set; } + /// + /// Gets or sets the placholder text + /// [Parameter] public string? Placeholder { get; set; } + /// + /// Gets or sets the minimum length + /// [Parameter] public int? MinLength { get; set; } + /// + /// Gets or sets the maximum length + /// [Parameter] public int? MaxLength { get; set; } + /// + /// Gets or sets the if spellcheck should be used + /// [Parameter] public bool? Spellcheck { get; set; } diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentToolbar.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentToolbar.razor.cs index 3a8585940a..8d4c3341a5 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentToolbar.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentToolbar.razor.cs @@ -4,6 +4,9 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentToolbar : FluentComponentBase { + /// + /// Gets or sets the toolbar's orentation. See + /// [Parameter] public Orientation? Orientation { get; set; } = FluentUI.Orientation.Horizontal; } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTooltip.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTooltip.razor.cs index 960ecb9781..42460ad8ad 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTooltip.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTooltip.razor.cs @@ -4,18 +4,39 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTooltip : FluentComponentBase { + /// + /// Gets or sets the anchor + /// [Parameter] public string? Anchor { get; set; } + /// + /// Gets or sets the tooltip's position. See + /// [Parameter] public TooltipPosition? Position { get; set; } + /// + /// Gets or sets the delay (in miliseconds) + /// [Parameter] public int? Delay { get; set; } = 300; + + /// + /// Gets or sets if the tooltip is visible + /// [Parameter] public bool? Visible { get; set; } = false; + + /// + /// Gets or sets wether the horizontal viewport is locked + /// [Parameter] public bool? HorizontalViewportLock { get; set; } = false; + + /// + /// Gets or sets wether the vertical viewport is locked + /// [Parameter] public bool? VerticalViewportLock { get; set; } = false; } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeItem.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeItem.razor.cs index b702f3f5fd..d7c079819a 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeItem.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeItem.razor.cs @@ -4,12 +4,21 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTreeItem : FluentComponentBase { + /// + /// Gets or sets if the tree item is disabled + /// [Parameter] public bool? Disabled { get; set; } + /// + /// Gets or sets if the tree item is selected + /// [Parameter] public bool? Selected { get; set; } + /// + /// Gets or sets if the tree item is expanded + /// [Parameter] public bool? Expanded { get; set; } } \ No newline at end of file diff --git a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeView.razor.cs b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeView.razor.cs index 905e0637a6..4615942ba5 100644 --- a/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeView.razor.cs +++ b/src/Microsoft.Fast.Components.FluentUI/Components/FluentTreeView.razor.cs @@ -4,6 +4,9 @@ namespace Microsoft.Fast.Components.FluentUI; public partial class FluentTreeView : FluentComponentBase { + /// + /// Gets or sets wether to render collapsed nodes + /// [Parameter] public bool? RenderCollapsedNodes { get; set; } } \ No newline at end of file