Asp.Net Core razor自定义taghelper

<p>又一个新的名词(taghelper),通过taghelper是可以操作html标签、条件输出、更是自由添加内外元素。当然也内置了挺多的asp-开头的taghelper。</p>

<p>下面文章中也简单的带大家实现一个taghelper;</p>

<blockquote>

<p>创建自定义html元素</p>

</blockquote>

<p>创建一个类ButtonTagHelper</p>

<p>tagName为标签名称,下面创建一个button标签</p>

<pre><code>using Microsoft.AspNetCore.Razor.TagHelpers;

namespace Ctrl.Core.Tag.Controls.Button

{

[HtmlTargetElement("test-button")]

public class ButtonTagHelper:TagHelper

{

    public override void Process(TagHelperContext context, TagHelperOutput output)

    {

        output.TagName = "button";

        base.Process(context, output);

    }

}

}

</code></pre>

<blockquote>

<p>注册taghelper</p>

</blockquote>

<p>创建完后可没法执行使用哦,在.cshtml通过某个标签比如form标签输入asp-,下面立刻就出现了一个列表 asp-.... ,这些是怎么做到的呢？因为在_ViewImports在我们创建项目工程时,已经提前引入了taghelper默认引入的是微软已经为我们写好的taghelper类库Microsoft.AspNetCore.Mvc.TagHelpers;</p>

<p>我们自定义的话也需要按照这个方式引入自定义的taghelper,下面我自己创建了一个类库名字为"Ctrl.Core.Tag",我这个类库下面要存放所有的taghelper 我直接引入命名空间</p>

<pre><code>@addTagHelper *,Ctrl.Core.Tag

</code></pre>

<p>如果想引入特定的taghelper如下</p>

<pre><code>@addTagHelper 你的TagHelper , 命名空间

</code></pre>

<p>然后我们测试一下是否可用了,先生成一下项目,然后找个cshtml视图,输入刚才的前缀test会出来刚才定义的标签</p>

<p>添加上并运行项目查看刚才创建的button标签是否存在</p>

<blockquote>

<p>添加自定义属性</p>

</blockquote>

<p>上面需求是满足不了我们日常需求的,下面我们再定义一个元素属性</p>

<pre><code> output.Attributes.SetAttribute("class", "btn btn-primary");

</code></pre>

<p>然后再打开页面看效果就会看到class元素已经给加上了.</p>

<pre><code>using Microsoft.AspNetCore.Razor.TagHelpers;

namespace Ctrl.Core.Tag.Controls.Button

{

[HtmlTargetElement("test-button")]

public class ButtonTagHelper:TagHelper

{

    public override void Process(TagHelperContext context, TagHelperOutput output)

    {

        output.TagName = "button";

        output.Attributes.SetAttribute("class", "btn btn-primary");

        base.Process(context, output);

    }

}

}

</code></pre>

<blockquote>

<p>通过vs感知匹配按钮类型</p>

</blockquote>

<p>上面能满足我们自定义标签了,但是可能使用起来有局限性,下面我给大家提供一个场景思路,后面大家可以自己进行扩展.</p>

<p>我创建一个枚举类为 CtrlButtonType</p>

<pre><code>namespace Ctrl.Core.Tag.Controls.Button

{

/// <summary>

///     按钮类型

/// </summary>

public enum CtrlButtonType

{

    /// <summary>

    ///  默认样式

    /// </summary>

    Default,

    /// <summary>

    ///     首选项

    /// </summary>

    Primary,

    /// <summary>

    ///      成功

    /// </summary>

    Success,

    /// <summary>

    ///  一般信息

    /// </summary>

    Info,

    /// <summary>

    ///  警告

    /// </summary>

    Warning,

    /// <summary>

    ///  危险

    /// </summary>

    Danger

}

}

</code></pre>

<p>在buttonTagHelper类中增加一个属性</p>

<pre><code>public CtrlButtonType ButtonType { get; set; }

</code></pre>

<p>到cshtml中添加刚才那个页面的属性,会发现有提示,以及可以看到刚才枚举中定义的.这样通过vs感知以及通过类型指定我们刚才按钮的类型是不是很方面了.</p>

<pre><code data-language="usingMicrosoft.AspNetCore.Razor.TagHelpers;" class="lang-using">

namespace Ctrl.Core.Tag.Controls.Button

{

[HtmlTargetElement("test-button")]

public class ButtonTagHelper:TagHelper

{

    public CtrlButtonType ButtonType  { get; set; }

    public override void Process(TagHelperContext context, TagHelperOutput output)

    {

        output.TagName = "button";

        output.Attributes.SetAttribute("class", "btn btn-"+ButtonType.ToString().ToLower());

        base.Process(context, output);

    }

}

}

</code></pre>

<pre><code> &lt;test-button button-type="Success"&gt;&lt;/test-button&gt;

</code></pre>