From f65326ff694f31419cebba2cab18e33cb01f8106 Mon Sep 17 00:00:00 2001 From: Zhou Zihao Date: Tue, 8 Aug 2023 11:03:11 +0800 Subject: [PATCH] =?UTF-8?q?=E5=B8=83=E5=B1=80=E6=A8=A1=E5=9D=97=E7=9A=84?= =?UTF-8?q?=E6=96=87=E6=A1=A3=E9=87=8D=E6=9E=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../Pages/Components/Layout/DividerPage.razor | 11 ++++------- .../Pages/Components/Layout/GridPage.razor | 19 +++++++++++-------- .../Pages/Components/Layout/LayoutPage.razor | 8 +++----- .../Pages/Components/Layout/SpacePage.razor | 18 ++++++++++-------- src/TDesign/Components/Grid/TColumn.cs | 8 +++++++- src/TDesign/Components/Grid/TRow.cs | 6 +++++- src/TDesign/Components/Space/TSpace.cs | 6 +++++- src/TDesign/Components/Space/TSpaceItem.cs | 3 ++- src/TDesign/Components/TDivider.cs | 8 ++++++-- src/TDesign/Components/TLayout.cs | 7 ++++++- 10 files changed, 59 insertions(+), 35 deletions(-) diff --git a/doc/TDesign.Docs.Shared/Pages/Components/Layout/DividerPage.razor b/doc/TDesign.Docs.Shared/Pages/Components/Layout/DividerPage.razor index 42332715..742d53a8 100644 --- a/doc/TDesign.Docs.Shared/Pages/Components/Layout/DividerPage.razor +++ b/doc/TDesign.Docs.Shared/Pages/Components/Layout/DividerPage.razor @@ -1,8 +1,6 @@ @page "/components/divider" - - - 分割线是一个呈线状的轻量化组件，起到分割、组织、细化的作用，用于有逻辑的组织元素内容和页面结构。 - + 水平分割线常用来对不同元素内容进行分割。 @@ -95,6 +93,5 @@ ``` ") -
- - \ No newline at end of file + + \ No newline at end of file diff --git a/doc/TDesign.Docs.Shared/Pages/Components/Layout/GridPage.razor b/doc/TDesign.Docs.Shared/Pages/Components/Layout/GridPage.razor index faf4b8ee..d1071726 100644 --- a/doc/TDesign.Docs.Shared/Pages/Components/Layout/GridPage.razor +++ b/doc/TDesign.Docs.Shared/Pages/Components/Layout/GridPage.razor @@ -1,8 +1,7 @@ @page "/components/grid" - - - 栅格是以规则的网格阵列来指导和规范网页中的版面布局以及信息分布，提高界面内布局的一致性，节约成本。 - + + @@ -423,7 +422,11 @@ ``` ") -
- - - \ No newline at end of file + + + + + + + + \ No newline at end of file diff --git a/doc/TDesign.Docs.Shared/Pages/Components/Layout/LayoutPage.razor b/doc/TDesign.Docs.Shared/Pages/Components/Layout/LayoutPage.razor index a418c5df..5a25d5b5 100644 --- a/doc/TDesign.Docs.Shared/Pages/Components/Layout/LayoutPage.razor +++ b/doc/TDesign.Docs.Shared/Pages/Components/Layout/LayoutPage.razor @@ -1,6 +1,6 @@ @page "/components/layout" - -用于组织网页的框架结构。 + @@ -59,6 +59,4 @@ ") -
- - \ No newline at end of file + \ No newline at end of file diff --git a/doc/TDesign.Docs.Shared/Pages/Components/Layout/SpacePage.razor b/doc/TDesign.Docs.Shared/Pages/Components/Layout/SpacePage.razor index 05836449..b9015cc2 100644 --- a/doc/TDesign.Docs.Shared/Pages/Components/Layout/SpacePage.razor +++ b/doc/TDesign.Docs.Shared/Pages/Components/Layout/SpacePage.razor @@ -1,8 +1,7 @@ @page "/components/space" - - - 控制组件之间的间距。 - + + 默认为横向排列，控制相邻组件水平间距 @@ -182,7 +181,10 @@ ``` ") -
- - - \ No newline at end of file + + + + + + + \ No newline at end of file diff --git a/src/TDesign/Components/Grid/TColumn.cs b/src/TDesign/Components/Grid/TColumn.cs index 065b1123..8b61a4b1 100644 --- a/src/TDesign/Components/Grid/TColumn.cs +++ b/src/TDesign/Components/Grid/TColumn.cs @@ -7,7 +7,7 @@ namespace TDesign; /// [ChildComponent(typeof(TRow))] [CssClass("t-col")] -public class TColumn : TDesignComponentBase, IHasChildContent +public class TColumn : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// 获取或设置父组件 的级联参数的值。 @@ -16,26 +16,32 @@ public class TColumn : TDesignComponentBase, IHasChildContent /// /// 获取或设置栅格的宽度。 /// + [ParameterApiDoc("栅格的宽度", Value ="Is1")] [Parameter][CssClass("t-col-")] public ColumnSpan Span { get; set; } = ColumnSpan.Is1; /// /// 获取或设置栅格的偏移量。 /// + [ParameterApiDoc("栅格的偏移量")] [Parameter][CssClass("t-col-offset-")] public ColumnSpan? Offset { get; set; } /// /// 获取或设置向左边拉动的单元格宽度。 /// + [ParameterApiDoc("向左边拉动的单元格宽度")] [Parameter][CssClass("t-col-pull-")] public ColumnSpan? Pull { get; set; } /// /// 获取或设置向右边推动的单元格宽度。 /// + [ParameterApiDoc("向右边推动的单元格宽度")] [Parameter][CssClass("t-col-push-")] public ColumnSpan? Push { get; set; } /// /// 获取或设置单元格的排序。 /// + [ParameterApiDoc("单元格的排序")] [Parameter][CssClass("t-col-order-")] public ColumnSpan? Order { get; set; } /// /// /// + [ParameterApiDoc("任意的内容")] [Parameter] public RenderFragment? ChildContent { get; set; } diff --git a/src/TDesign/Components/Grid/TRow.cs b/src/TDesign/Components/Grid/TRow.cs index f2d9fadb..61e909ae 100644 --- a/src/TDesign/Components/Grid/TRow.cs +++ b/src/TDesign/Components/Grid/TRow.cs @@ -5,23 +5,27 @@ /// [CssClass("t-row")] [ParentComponent] -public class TRow : TDesignComponentBase, IHasChildContent +public class TRow : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// 间隔，单位 px。 /// + [ParameterApiDoc("行间隔，单位 px")] [Parameter] public int? Gutter { get; set; } /// /// 水平对齐方式。 /// + [ParameterApiDoc("水平对齐方式", Value = "Start")] [Parameter][CssClass("t-row--")] public JustifyContent HorizontalAlignment { get; set; } = JustifyContent.Start; /// /// 垂直对齐方式。 /// + [ParameterApiDoc("垂直对齐方式", Value = "Top")] [Parameter][CssClass("t-row--")] public VerticalAlignment VerticalAlignment { get; set; } = VerticalAlignment.Top; /// /// /// + [ParameterApiDoc($"装载 {nameof(TColumn)} 组件的内容")] [Parameter] public RenderFragment? ChildContent { get; set; } protected override void BuildStyle(IStyleBuilder builder) diff --git a/src/TDesign/Components/Space/TSpace.cs b/src/TDesign/Components/Space/TSpace.cs index bf07d494..710245a5 100644 --- a/src/TDesign/Components/Space/TSpace.cs +++ b/src/TDesign/Components/Space/TSpace.cs @@ -5,23 +5,27 @@ /// [ParentComponent] [CssClass("t-space")] -public class TSpace : TDesignComponentBase, IHasChildContent +public class TSpace : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// /// + [ParameterApiDoc($"装载 {nameof(TSpaceItem)} 组件的内容")] [Parameter] public RenderFragment? ChildContent { get; set; } /// /// 是否为竖向排列。 /// + [ParameterApiDoc($"是否为竖向排列")] [Parameter][BooleanCssClass("t-space-vertical", "t-space-horizontal")] public bool Vertical { get; set; } /// /// 之间的间距。 /// + [ParameterApiDoc($"每一个 {nameof(TSpaceItem)} 的间距", Value ="16px")] [Parameter] public string? Gap { get; set; } = "16px"; /// /// 水平排列时是否可以被自动换行。 /// + [ParameterApiDoc($"水平排列时是否可以被自动换行")] [Parameter] public bool BreakLine { get; set; } protected override void BuildStyle(IStyleBuilder builder) diff --git a/src/TDesign/Components/Space/TSpaceItem.cs b/src/TDesign/Components/Space/TSpaceItem.cs index 0c13f8fe..89a7d5c0 100644 --- a/src/TDesign/Components/Space/TSpaceItem.cs +++ b/src/TDesign/Components/Space/TSpaceItem.cs @@ -5,10 +5,11 @@ /// [ChildComponent(typeof(TSpace))] [CssClass("t-space-item")] -public class TSpaceItem : TDesignComponentBase, IHasChildContent +public class TSpaceItem : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// /// + [ParameterApiDoc("间距内的任意内容")] [Parameter] public RenderFragment? ChildContent { get; set; } } diff --git a/src/TDesign/Components/TDivider.cs b/src/TDesign/Components/TDivider.cs index 83717fc9..539cd927 100644 --- a/src/TDesign/Components/TDivider.cs +++ b/src/TDesign/Components/TDivider.cs @@ -7,26 +7,30 @@ namespace TDesign; /// 分割线。 /// [CssClass("t-divider")] -public class TDivider : TDesignComponentBase, IHasChildContent +public class TDivider : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// 分割线的文本。 /// + [ParameterApiDoc("分割线的任意内容")] [Parameter] public RenderFragment? ChildContent { get; set; } /// - /// 垂直分割线。 + /// 是否垂直分割线。 /// + [ParameterApiDoc("是否为垂直分割线")] [Parameter][CssClass("t-divider--vertical")] public bool Vertical { get; set; } /// /// 是否为虚线。 /// + [ParameterApiDoc("是否为虚线")] [Parameter][CssClass("t-divider--dashed")] public bool Dashed { get; set; } /// /// 文字对齐方式。 /// + [ParameterApiDoc("文字对齐方式", Value = "Center")] [Parameter][CssClass("t-divider--with-text-")] public HorizontalAlignment Alignment { get; set; } = HorizontalAlignment.Center; protected override void AddContent(RenderTreeBuilder builder, int sequence) diff --git a/src/TDesign/Components/TLayout.cs b/src/TDesign/Components/TLayout.cs index 2c03b726..b801205f 100644 --- a/src/TDesign/Components/TLayout.cs +++ b/src/TDesign/Components/TLayout.cs @@ -8,27 +8,32 @@ namespace TDesign; [CssClass("t-layout")] [HtmlTag("section")] [ParentComponent] -public class TLayout : TDesignComponentBase, IHasChildContent +public class TLayout : TDesignAdditionParameterComponentBase, IHasChildContent { /// /// 布局的顶部内容。 /// + [ParameterApiDoc("布局的顶部内容")] [Parameter] public RenderFragment? HeaderContent { get; set; } /// /// 布局的右侧内容。 /// + [ParameterApiDoc("布局的右侧内容")] [Parameter] public RenderFragment? LeftSideContent { get; set; } /// /// 布局的左侧部分。 /// + [ParameterApiDoc("布局的左侧部分")] [Parameter] public RenderFragment? RightSideContent { get; set; } /// /// 布局的底部部分。 /// + [ParameterApiDoc("布局的底部部分")] [Parameter] public RenderFragment? FooterContent { get; set; } /// /// 布局的主体部分。 /// + [ParameterApiDoc("布局的主体部分")] [Parameter] public RenderFragment? ChildContent { get; set; } protected override void AddContent(RenderTreeBuilder builder, int sequence)