BlazorInputTags 8.0.4

There is a newer version of this package available.
See the version list below for details.
dotnet add package BlazorInputTags --version 8.0.4                
NuGet\Install-Package BlazorInputTags -Version 8.0.4                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BlazorInputTags" Version="8.0.4" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlazorInputTags --version 8.0.4                
#r "nuget: BlazorInputTags, 8.0.4"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlazorInputTags as a Cake Addin
#addin nuget:?package=BlazorInputTags&version=8.0.4

// Install BlazorInputTags as a Cake Tool
#tool nuget:?package=BlazorInputTags&version=8.0.4                

BlazorInputTags

A simple to use blazor component for both Blazor Server and WebAssembly which adds a basic tag editor to your app.

See a live demo right here on github.

BlazorInputTags Demo

Installation

You can install from Nuget using the following command:

Install-Package BlazorInputTags

Or via the Visual Studio package manger.

Basic usage

Start by adding the using statement to your _Imports.razor

@using BlazorInputTags

You can either use an existing List<string> and provide it to the component

<InputTags Value="Tags" />

@code {
	public List<string> Tags { get; set; } = new();
}

Or you can do manage the list by yourself.

<InputTags OnTagAdded="OnTagAddedAsync" OnTagRemoved="OnTagRemovedAsync"/>

@code {
	private Task OnTagAddedAsync(string tag) {
		// Do something with the tag
		return Task.CompletedTask;
	}

	private Task OnTagRemovedAsync(string tag) {
		// Do something with the tag
		return Task.CompletedTask;
	}
}

Providing options

You can pass an InputTagOptions instance to the component to override some core logic and behaviour.

Option Type Default Description
WrapperClass string blazor-tag-wrapper Sets the CSS class name for the tag wrapper
TagListClass string blazor-tag-list Sets the CSS class name for the tag list
TagClass string blazor-tag Sets the CSS class name for the tag
InputClass string blazor-tag-input Sets the CSS class name for the input field
LabelClass string blazor-tag-label Sets the CSS class name for the label
RemoveButtonTooltip string Remove Sets the text for delete tooltip button
InputPlaceholder string Enter tag, add with Enter Sets the placeholder text for the input field
DisplayLabel bool true Enabling the label of the component
MinLength int 0 Sets the minimum length for a tag. 0 = no minimum
MaxLength int 0 Sets the maximum length for a tag. 0 = no maximum

Custom validation

The component provides you with a parameter to do some custom validation before adding the tag to the list. This can be achieved like this:

<InputTags Value="Tags" ValidateTag="ValidateTagAsync" />

@code {
    public List<string> Tags { get; set; } = new();
    private List<string> _notAllowedTags = new()
    {
        "Cat",
        "Horse",
        "Dolphin"
    };

    private Task<bool> ValidateTagAsync(string tag)
    {
        bool result = !_notAllowedTags.Any(x => x.Equals(tag, StringComparison.OrdinalIgnoreCase));
        return Task.FromResult(result);
    }
}

Note: When changing the class names to something different, you'll need to add the CSS by yourself.

Customizing design

The component uses custom CSS variables which can be overwritten within any public CSS file.

Variable Affects
--blazor-tag-wrapper-background-color .blazor-tag-wrapper
--blazor-tag-wrapper-border-radius .blazor-tag-wrapper
--blazor-tag-wrapper-border .blazor-tag-wrapper
--blazor-tag-background-color .blazor-tag
--blazor-tag-padding .blazor-tag
--blazor-tag-margin .blazor-tag
--blazor-tag-border-radius .blazor-tag
--blazor-tag-button-color .blazor-tag button
--blazor-tag-button-hover-background-color .blazor-tag button:hover
--blazor-tag-button-hover-color .blazor-tag button:hover
--blazor-tag-button-focus-border-color .blazor-tag button:focus

In addition you can overwrite or add any CSS using the corresponding selectors.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.0.0 243 11/14/2024
8.0.4 3,175 4/25/2024
8.0.1 2,845 1/3/2024
8.0.0 321 11/20/2023
7.1.1 395 6/30/2023
7.1.0 220 4/6/2023
7.0.0 233 3/15/2023