Select2MultiSelect

in namespace DotVVM.Bootstrap5.Select2.Controls

A Bootstrap 5-styled MultiSelect powered by Select2 library.

Usage & Scenarios

Extends the Bootstrap 5 MultiSelect control with the Select2 widget, which provides searchable multiple selection.

Install the DotVVM.Controls.Bootstrap5.Select2 package and register it in DotvvmStartup.cs after Bootstrap 5:

config.AddBootstrap5Configuration();
config.AddBootstrap5Select2Configuration();

The control uses the bs prefix and supports all properties of MultiSelect.

Set AllowCreateItems="true" to let users create new items while searching. This feature is disabled by default and requires DataSource and SelectedValues to be collections of strings. New items are added to DataSource and remain available after they are deselected.

Sample 1: Searchable Multiple Selection

Bind SelectedValues to a collection of item values. Users can search for and select multiple options in the Select2 widget.

page.dothtml
ViewModel.cs

<bs:Select2MultiSelect SelectedValues="{value: SelectedTechnologies}"
                        DataSource="{value: Technologies}"
                        ItemTextBinding="{value: Name}"
                        ItemValueBinding="{value: Id}" />

<p>Selected technologies: <strong>{{value: SelectedTechnologies}}</strong></p>

using DotVVM.Framework.ViewModel;
using System.Collections.Generic;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap5_select2.Select2MultiSelect.sample1
{
    public class ViewModel : DotvvmViewModelBase
    {
        public List<Technology> Technologies { get; set; } = new List<Technology>
        {
            new Technology { Id = 1, Name = "C#" },
            new Technology { Id = 2, Name = "DotVVM" },
            new Technology { Id = 3, Name = "TypeScript" },
            new Technology { Id = 4, Name = "Bootstrap" }
        };

        public List<int> SelectedTechnologies { get; set; } = new List<int> { 1, 2 };

        public class Technology
        {
            public int Id { get; set; }
            public string Name { get; set; }
        }
    }
}

Sample 2: Create new items

Set AllowCreateItems="true" to allow users to enter a new item and select it by pressing Enter or clicking the matching option. The control adds the item to both DataSource and SelectedValues. Deselecting an item removes it from SelectedValues but keeps it in DataSource, so it can be selected again without creating a duplicate.

Both collections must contain strings. Bind DataSource using a writable value binding, such as a List<string> property. Control usage validation rejects non-string data sources and resource bindings when item creation is enabled. Strings are used directly as item text and values, so ItemTextBinding and ItemValueBinding are not needed.

AllowCreateItems defaults to false and must be specified as a hard-coded value, not a binding. Without item creation, the control still supports collections of objects as shown in the first sample.

This sample handles SelectionChanged to show the data source received by the server. The new item is added before the command runs and persists through the postback. See MultiSelect for the inherited selection properties and events.

page.dothtml
ViewModel.cs

<p>Search for a technology or type a new name and press Enter to add it.</p>

<bs:Select2MultiSelect DataSource="{value: Technologies}"
                      SelectedValues="{value: SelectedTechnologies}"
                      AllowCreateItems="true"
                      SelectionChanged="{command: OnSelectionChanged()}" />

<p>Available technologies: <strong>{{value: string.Join(", ", Technologies)}}</strong></p>
<p>Selected technologies: <strong>{{value: string.Join(", ", SelectedTechnologies)}}</strong></p>
<p>Items received by the server: <strong>{{value: TechnologiesOnServer}}</strong></p>

using DotVVM.Framework.ViewModel;
using System.Collections.Generic;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap5_select2.Select2MultiSelect.sample2
{
    public class ViewModel : DotvvmViewModelBase
    {
        public List<string> Technologies { get; set; } = new List<string>
        {
            "C#", "DotVVM", "TypeScript"
        };

        public List<string> SelectedTechnologies { get; set; } = new List<string> { "DotVVM" };
        public string TechnologiesOnServer { get; set; } = "";

        public void OnSelectionChanged()
        {
            TechnologiesOnServer = string.Join(", ", Technologies);
        }
    }
}

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
AllowCreateItems	Boolean Boolean	Gets or sets whether users can create items. When used, the DataSource and SelectedValues must be collections of strings.	attribute inner element static value bindable default	False
ClientIDMode	ClientIDMode ClientIDMode	Gets or sets the client ID generation algorithm.	attribute inner element static value bindable default	Static
DataContext	Object Object	Gets or sets a data context for the control and its children. All value and command bindings are evaluated in context of this value. The DataContext is null in client-side templates.	attribute inner element static value bindable default	null
DataSource	Object Object	Gets or sets the source collection or a GridViewDataSet that contains data in the control.	attribute inner element static value bindable default	null
Enabled	Boolean Boolean	Gets or sets a value indicating whether the control is enabled and can be modified.	attribute inner element static value bindable default	True
ID	String String	Gets or sets the control client ID within its naming container.	attribute inner element static value bindable default	null
IncludeInPage	Boolean Boolean	Gets or sets whether the control is included in the DOM of the page.	attribute inner element static value bindable default	True
InnerText	String String	Gets or sets the inner text of the HTML element. Note that this property can only be used on HtmlGenericControl directly and when the control does not have any children.	attribute inner element static value bindable default	null
ItemTextBinding	IValueBinding<String> IValueBinding<String>	The expression of DataSource item that will be displayed in the control.	attribute inner element static value bindable default	null
ItemTitleBinding	IValueBinding IValueBinding	The expression of DataSource item that will be placed into html title attribute.	attribute inner element static value bindable default	null
ItemValueBinding	IValueBinding IValueBinding	The expression of DataSource item that will be passed to the SelectedValue property when the item is selected.	attribute inner element static value bindable default	null
SelectedValues	Object Object	Gets or sets the values of selected items.	attribute inner element static value bindable default	null
Visible	Boolean Boolean	Gets or sets whether the control is visible. When set to false, `style="display: none"` will be added to this control.	attribute inner element static value bindable default	True

Events

	Name	Type	Description
	SelectionChanged	Command	Gets or sets the command that will be triggered when the selection is changed.

Edit on Github

Select2MultiSelect

Usage & Scenarios

Sample 1: Searchable Multiple Selection

Sample 2: Create new items

Properties

Events

HTML produced by the control

On this page

Select2MultiSelect

Usage & Scenarios

Sample 1: Searchable Multiple Selection

Sample 2: Create new items

Properties

Events

HTML produced by the control

On this page

Information about cookies