Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/sup/rel-1.7/xml-comments-autogen…
Browse files Browse the repository at this point in the history
…' into sup/rel-1.7/xml-comments-autogen
  • Loading branch information
tesar-tech committed Nov 26, 2024
2 parents 85a51a9 + 18561fb commit 4bd7901
Show file tree
Hide file tree
Showing 13 changed files with 46 additions and 49 deletions.
10 changes: 6 additions & 4 deletions Documentation/Blazorise.Docs/Blazorise.Docs.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

<Import Project="..\..\Build\Blazorise.Docs.props" />

<PropertyGroup>
<LangVersion>latest</LangVersion>
</PropertyGroup>

<ItemGroup>
<SupportedPlatform Include="browser" />
</ItemGroup>
Expand Down Expand Up @@ -41,13 +45,11 @@
<PackageReference Include="MimeKit" Version="4.8.0" />
<PackageReference Include="Blazored.LocalStorage" Version="4.5.0" />
<ProjectReference Include="..\..\Source\SourceGenerators\Blazorise.ApiDocsDtos\Blazorise.ApiDocsDtos.csproj" />

</ItemGroup>
</ItemGroup>

<!--Binary path for the code generator-->
<!--Binary path for the code generator-->
<PropertyGroup>
<BinDocsCompiler>..\..\Documentation/Blazorise.Docs.Compiler/bin/Debug/net9.0/Blazorise.Docs.Compiler.dll</BinDocsCompiler>
<LangVersion>latest</LangVersion>
</PropertyGroup>

<!--Project path for code generator-->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,4 @@
</Alert>
</Paragraph>

<ComponentApiDocs ComponentTypes="[typeof(Accordion), typeof(AccordionToggle), typeof(AccordionItem), typeof(AccordionHeader), typeof(AccordionBody)]" />


<ComponentApiDocs ComponentTypes="[typeof(Accordion), typeof(AccordionToggle), typeof(AccordionItem), typeof(AccordionHeader), typeof(AccordionBody)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -112,4 +112,4 @@
<DocsPageSectionSource Code="AlertUseProgrammaticallyExample" />
</DocsPageSection>

<ComponentApiDocs ComponentTypes="[ typeof(Alert)]" />
<ComponentApiDocs ComponentTypes="[typeof(Alert)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,4 @@
Placement, language, shape, and color can all help mitigate any confusion. First, badges should not be labeled with active verbs. This is because they are not actions but relatively static text/content. Second, avoid placing badges directly next to Buttons, in particular, if they are using similar themes. The pill theme variant may aid in making badges and Buttons more distinct from one another.
</DocsPageParagraph>

<ComponentApiDocs ComponentTypes="[ typeof(Badge)]" />
<ComponentApiDocs ComponentTypes="[typeof(Badge)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -224,4 +224,4 @@
</DocsPageSectionHeader>
</DocsPageSection>

<ComponentApiDocs ComponentTypes="[typeof(Bar), typeof(BarLink)]" />
<ComponentApiDocs ComponentTypes="[typeof(Bar), typeof(BarLink)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,4 @@
<DocsPageSectionSource Code="BreadcrumbAutoExample" />
</DocsPageSection>

<ComponentApiDocs ComponentTypes="[typeof(Breadcrumb), typeof(BreadcrumbItem),typeof(BreadcrumbLink)]" />
<ComponentApiDocs ComponentTypes="[typeof(Breadcrumb), typeof(BreadcrumbItem), typeof(BreadcrumbLink)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -265,4 +265,4 @@
<DocsPageSectionSource Code="ButtonInDialogsBestPracticeExample" />
</DocsPageSection>

<ComponentApiDocs ComponentTypes="[typeof(Button)]" />
<ComponentApiDocs ComponentTypes="[typeof(Button)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,4 @@
</DocsPageSection>


<ComponentApiDocs ComponentTypes="[typeof(Card), typeof(CardText),typeof(CardTitle),typeof(CardSubtitle),typeof(CardLink),typeof(CardImage)]" />
<ComponentApiDocs ComponentTypes="[typeof(Card), typeof(CardText), typeof(CardTitle), typeof(CardSubtitle), typeof(CardLink), typeof(CardImage)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,4 @@
<DocsPageSectionSource Code="ColorEditDisabledExample" />
</DocsPageSection>


<ComponentApiDocs ComponentTypes="[typeof(ColorEdit)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,4 @@
<DocsPageSectionSource Code="ColorPickerShowHueExample" />
</DocsPageSection>


<ComponentApiDocs ComponentTypes="[typeof(ColorPicker)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -79,5 +79,4 @@
<DocsPageSectionSource Code="DateEditShowPickerExample" />
</DocsPageSection>


<ComponentApiDocs ComponentTypes="[typeof(DateEdit<>)]" />
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,4 @@
<DocsPageSectionSource Code="TextContentDividerExample" />
</DocsPageSection>

<ComponentApiDocs ComponentTypes="[typeof(Divider)]" />

<ComponentApiDocs ComponentTypes="[typeof(Divider)]" />
63 changes: 32 additions & 31 deletions Source/Blazorise/Base/BaseComponent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -383,7 +383,7 @@ protected static void DisposeDotNetObjectRef<T>( DotNetObjectReference<T> value
[Inject] internal BlazoriseLicenseChecker LicenseChecker { get; set; }

/// <summary>
/// Custom css class name.
/// Custom CSS class name to apply to the component.
/// </summary>
[Parameter]
public string Class
Expand All @@ -398,7 +398,7 @@ public string Class
}

/// <summary>
/// Custom html style.
/// Custom inline styles to apply to the component.
/// </summary>
[Parameter]
public string Style
Expand All @@ -413,7 +413,7 @@ public string Style
}

/// <summary>
/// Floats an element to the defined side.
/// Specifies how an element should float within its containing block.
/// </summary>
[Parameter]
public Float Float
Expand All @@ -428,7 +428,7 @@ public Float Float
}

/// <summary>
/// Fixes an element's floating children.
/// Determines whether to apply clearfix to manage floating children.
/// </summary>
[Parameter]
public bool Clearfix
Expand All @@ -443,7 +443,7 @@ public bool Clearfix
}

/// <summary>
/// Controls the visibility, without modifying the display, of elements with visibility utilities.
/// Controls the visibility of an element without altering its layout.
/// </summary>
[Parameter]
public Visibility Visibility
Expand All @@ -461,7 +461,7 @@ public Visibility Visibility
}

/// <summary>
/// Defined the sizing for the element width attribute(s).
/// Defines the width of the component using responsive sizing utilities.
/// </summary>
[Parameter]
public IFluentSizing Width
Expand All @@ -479,7 +479,7 @@ public IFluentSizing Width
}

/// <summary>
/// Defined the sizing for the element height attribute(s).
/// Defines the height of the component using responsive sizing utilities.
/// </summary>
[Parameter]
public IFluentSizing Height
Expand All @@ -497,7 +497,7 @@ public IFluentSizing Height
}

/// <summary>
/// Defines the element margin spacing.
/// Configures the margin spacing for the component.
/// </summary>
[Parameter]
public IFluentSpacing Margin
Expand All @@ -515,7 +515,7 @@ public IFluentSpacing Margin
}

/// <summary>
/// Defines the element padding spacing.
/// Configures the padding spacing for the component.
/// </summary>
[Parameter]
public IFluentSpacing Padding
Expand All @@ -533,7 +533,7 @@ public IFluentSpacing Padding
}

/// <summary>
/// Defines the element gap spacing.
/// Configures the gap spacing between child elements of the component.
/// </summary>
[Parameter]
public IFluentGap Gap
Expand All @@ -551,7 +551,7 @@ public IFluentGap Gap
}

/// <summary>
/// Specifies the display behavior of an element.
/// Specifies the display behavior (e.g., block, inline, flex) of the component.
/// </summary>
[Parameter]
public IFluentDisplay Display
Expand All @@ -569,7 +569,7 @@ public IFluentDisplay Display
}

/// <summary>
/// Specifies the border of an element.
/// Configures the border properties of the component.
/// </summary>
[Parameter]
public IFluentBorder Border
Expand All @@ -587,7 +587,7 @@ public IFluentBorder Border
}

/// <summary>
/// Specifies flexbox properties of an element.
/// Configures the flexbox properties of the component.
/// </summary>
[Parameter]
public IFluentFlex Flex
Expand All @@ -605,7 +605,7 @@ public IFluentFlex Flex
}

/// <summary>
/// The position property specifies the type of positioning method used for an element (static, relative, fixed, absolute or sticky).
/// Specifies the positioning method for the component (static, relative, absolute, etc.).
/// </summary>
[Parameter]
public IFluentPosition Position
Expand All @@ -623,7 +623,7 @@ public IFluentPosition Position
}

/// <summary>
/// The overflow property controls what happens to content that is too big to fit into an area.
/// Configures the overflow behavior when content exceeds the component's bounds.
/// </summary>
[Parameter]
public IFluentOverflow Overflow
Expand All @@ -641,7 +641,7 @@ public IFluentOverflow Overflow
}

/// <summary>
/// Changes the character casing of a element.
/// Specifies the text casing transformation (e.g., uppercase, lowercase).
/// </summary>
[Parameter]
public CharacterCasing Casing
Expand All @@ -656,7 +656,7 @@ public CharacterCasing Casing
}

/// <summary>
/// Gets or sets the text color.
/// Defines the text color of the component.
/// </summary>
[Parameter]
public TextColor TextColor
Expand All @@ -671,7 +671,7 @@ public TextColor TextColor
}

/// <summary>
/// Gets or sets the text alignment.
/// Configures the horizontal alignment of text within the component.
/// </summary>
[Parameter]
public TextAlignment TextAlignment
Expand All @@ -686,7 +686,7 @@ public TextAlignment TextAlignment
}

/// <summary>
/// Gets or sets the text transformation.
/// Configures the text transformation (e.g., capitalize, none) of the component.
/// </summary>
[Parameter]
public TextTransform TextTransform
Expand All @@ -701,7 +701,7 @@ public TextTransform TextTransform
}

/// <summary>
/// Gets or sets the text decoration.
/// Defines the text decoration style (e.g., underline, none) for the component.
/// </summary>
[Parameter]
public TextDecoration TextDecoration
Expand All @@ -719,7 +719,7 @@ public TextDecoration TextDecoration
}

/// <summary>
/// Gets or sets the text weight.
/// Specifies the font weight of text in the component (e.g., bold, normal).
/// </summary>
[Parameter]
public TextWeight TextWeight
Expand All @@ -734,7 +734,7 @@ public TextWeight TextWeight
}

/// <summary>
/// Determines how the text will behave when it is larger than a parent container.
/// Configures how text behaves when it overflows its container.
/// </summary>
[Parameter]
public TextOverflow TextOverflow
Expand All @@ -749,7 +749,7 @@ public TextOverflow TextOverflow
}

/// <summary>
/// Determines the font size of an element.
/// Sets the font size of the text in the component.
/// </summary>
[Parameter]
public IFluentTextSize TextSize
Expand All @@ -767,11 +767,8 @@ public IFluentTextSize TextSize
}

/// <summary>
/// Gets or sets the object fit configuration, which specifies how an object should fit within its container.
/// Configures the object-fit property, which determines how content is resized within its container.
/// </summary>
/// <remarks>
/// Changing this property will update the CSS classes related to object fit styling.
/// </remarks>
[Parameter]
public IFluentObjectFit ObjectFit
{
Expand All @@ -788,7 +785,7 @@ public IFluentObjectFit ObjectFit
}

/// <summary>
/// Changes the vertical alignment of inline, inline-block, inline-table, and table cell elements.
/// Specifies the vertical alignment of inline or table-cell elements.
/// </summary>
[Parameter]
public VerticalAlignment VerticalAlignment
Expand All @@ -803,7 +800,7 @@ public VerticalAlignment VerticalAlignment
}

/// <summary>
/// Gets or sets the component background color.
/// Sets the background color of the component.
/// </summary>
[Parameter]
public Background Background
Expand All @@ -818,7 +815,7 @@ public Background Background
}

/// <summary>
/// Gets or sets the component shadow box.
/// Configures the shadow effect of the component.
/// </summary>
[Parameter]
public Shadow Shadow
Expand All @@ -833,10 +830,14 @@ public Shadow Shadow
}

/// <summary>
/// Captures all the custom attribute that are not part of Blazorise component.
/// Captures unmatched HTML attributes for customization.
/// </summary>
/// <remarks>
/// These attributes are applied directly to the component's root HTML element.
/// </remarks>
[Parameter( CaptureUnmatchedValues = true )]
public Dictionary<string, object> Attributes { get; set; }


#endregion
}

0 comments on commit 4bd7901

Please sign in to comment.