在 ASP.NET Core MVC 中嵌套 TagHelper

Question

ASP.NET Core TagHelper documentation 给出了以下示例：

public class WebsiteContext
{
    public Version Version { get; set; }
    public int CopyrightYear { get; set; }
    public bool Approved { get; set; }
    public int TagsToShow { get; set; }
}

[TargetElement("website-information")]
public class WebsiteInformationTagHelper : TagHelper
{
    public WebsiteContext Info { get; set; }

    public override void Process(TagHelperContext context, TagHelperOutput output)
    {
        output.TagName = "section";
        output.Content.SetContent(
            $@"<ul><li><strong>Version:</strong> {Info.Version}</li>
            <li><strong>Copyright Year:</strong> {Info.CopyrightYear}</li>
            <li><strong>Approved:</strong> {Info.Approved}</li>
            <li><strong>Number of tags to show:</strong> {Info.TagsToShow}</li></ul>");
        output.TagMode = TagMode.StartTagAndEndTag;
    }
}

这可以在你的 Razor .cshtml 中使用，如下所示：

<website-information info="new WebsiteContext {
    Version = new Version(1, 3),
    CopyrightYear = 1790,
    Approved = true,
    TagsToShow = 131 }"/>

这将生成以下 HTML：

<section>
    <ul>
        <li><strong>Version:</strong> 1.3</li>
        <li><strong>Copyright Year:</strong> 1790</li>
        <li><strong>Approved:</strong> true</li>
        <li><strong>Number of tags to show:</strong> 131 </li>
    </ul>
</section>

这是非常难看的标签助手语法。有没有办法嵌套另一个标签助手并获得完整的智能感知，以便网站信息的唯一允许的孩子可以是上下文？请参见下面的示例：

<website-information>
    <context version="1.3" copyright="1790" approved tags-to-show="131"/>
</website-information>

在我的用例中，网站信息元素已经有很多属性，我想添加一个或多个单独的嵌套元素。

更新

我在 ASP.NET GitHub 页面上提出了this 建议，为 TagHelpers 实现此功能。

Answer 1

您当然可以嵌套标签助手，尽管视图组件、部分视图或显示模板等其他选项可能更适合 OP 描述的场景。

这可能是一个非常简单的 child 标签助手：

[HtmlTargetElement("child-tag", ParentTag="parent-tag")]
public class ChildTagHelper : TagHelper
{
    public string Message { get; set; }

    public override void Process(TagHelperContext context, TagHelperOutput output)
    {
        // Create parent div
        output.TagName = "span";
        output.Content.SetContent(Message);
        output.TagMode = TagMode.StartTagAndEndTag;     
    }
}

这也可以是另一个简单的 parent 标签助手：

[HtmlTargetElement("parent-tag")]
[RestrictChildren("child-tag")]
public class ParentTagHelper: TagHelper
{
    public string Title { get; set; }

    public override async Task ProcessAsync(TagHelperContext context, TagHelperOutput output)
    {            
        output.TagName = "div";

        // Add some specific parent helper html
        var header = new TagBuilder("h1");
        header.Attributes.Add("class", "parent-title");
        header.InnerHtml.Append(this.Title);
        output.PreContent.SetContent(header);

        // Set the inner contents of this helper(Will process any nested tag helpers or any other piece of razor code)
        output.Content.SetContent(await output.GetChildContentAsync());            
    }
}

在剃刀视图中，您可以编写以下内容：

<parent-tag title="My Title">
    <child-tag message="This is the nested tag helper" />
</parent-tag>

这将被呈现为：

<div>
    <h1 class="parent-title">My Title</h1>
    <span>This is the nested tag helper</span>
</div>

您可以选择性地强制标签助手以特定方式嵌套：

• 在父标签助手中使用[RestrictChildren("child-tag", "another-tag")] 来限制允许的嵌套标签助手
• 在声明子标签助手时使用ParentTag参数强制标签嵌套在特定父标签[HtmlTargetElement("child-tag", ParentTag = "parent-tag")]中

Answer 2

我没有在网上找到一个很好的多嵌套标签助手的例子；所以，我在MultiplyNestedTagHelpers GitHub Repository 创建了一个。

当使用多于一层的嵌套标签助手时，为每个可以包含子标签的标签设置一个“上下文”类是很重要的。子标签使用这些上下文类来编写它们的输出。上下文类是一个常规的 POCO 类，每个子标签都有一个属性。属性可能是字符串，但我使用 StringBuilder。例如，

public class MyTableContext{
    public StringBuilder TableHeaderBuilder { get; set; } = new StringBuilder();
    public StringBuilder TableBodyBuilder { get; set; } = new StringBuilder();
}
public class MyTableHeaderContext {
    public StringBuilder RowBuilder { get; set; } = new StringBuilder();
}
//...etc.

在每个父标签的 Process 方法中，需要实例化父标签关联的上下文类，并将这个新对象添加到 TagHelperContext 对象的 Items 集合中。例如：

    //create context for this tag helper
    var tableContext = new MyTableContext();
    context.Items.Add(typeof(MyTableContext), tableContext);

在子标签的 Process 方法中，你可以这样写到父标签注册的上下文对象中：

    //get reference to parent context, and append content to the relevant builder
    var tableContext = context.Items[typeof(MyTableContext)] as MyTableContext;
    tableContext.TableHeaderBuilder.Append(sb.ToString());

    //suppress output (for any tag with a parent tag)
    output.SuppressOutput();

回到父标签的 Process 方法，你收到子标签的输出如下：

    //you can use a StringBuilder to build output 
    //    or just write to output.Content.AppendHtml() for top-level tags
    var sb = new StringBuilder();
    //...      

    //retrieve the child output and append it to sb
    await output.GetChildContentAsync();
    sb.Append(tableHeaderContext.RowBuilder.ToString());
    //...

    //write to TagHelperOutput for top-level tags      
    output.Content.AppendHtml(sb.ToString());