Edit on Github

DropDownButton

in namespace DotVVM.Framework.Controls.Bootstrap4

Renders a Bootstrap dropdown button.

Usage & Scenarios

Renders a button with a drop-down menu with the data-binding support.

https://getbootstrap.com/docs/4.3/components/dropdowns/

Sample 1: Basic Usage

The Text property specified the text on the button. Alternatively, you can use the ButtonTemplate property.

The DropDirection property can specify whether the menu drops up or down.

The IsCollapsed property indicates whether the menu is open or not. You can also use it in data-binding.

Place <bs:DropDownButtonItem> controls inside the <bs:DropDownButton> control and use their NavigateUrl property to specify the link URL. You can place them inside the <Items> element, however it is not required because the Items is the default property of DropDownButton.

Because the class DropDownButtonItem inherits from the ListItem, please refer to the ListItem documentation for more information.

page.dothtml
ViewModel.cs

<bs:DropDownButton Text="Very Simple Dropdown">
  <Items>
    <bs:DropDownButtonItem NavigateUrl="https://www.google.com/">
      Google
    </bs:DropDownButtonItem>
    <bs:DropDownButtonItem NavigateUrl="https://github.com/riganti/dotvvm" Text="DotVVM" />
  </Items>
</bs:DropDownButton>

<bs:DropDownButton Text="Drop up Button" DropDirection="DropUp">
  <bs:DropDownButtonItem NavigateUrl="https://www.google.com/">
    <ButtonTemplate>
      Google is a <strong>search engine</strong>
    </ButtonTemplate>
  </bs:DropDownButtonItem>
  <bs:DropDownButtonItem NavigateUrl="https://github.com/riganti/dotvvm">
    DotVVM
  </bs:DropDownButtonItem>
</bs:DropDownButton>

<p>IsCollapsed: {{value: Collapsed}}</p>
<bs:DropDownButton IsCollapsed="{value: Collapsed}" Text="Collapse test">
  <bs:DropDownButtonItem NavigateUrl="https://www.google.com">Google</bs:DropDownButtonItem>
</bs:DropDownButton>

using DotVVM.Framework.ViewModel;

namespace DotvvmWeb.Views.Docs.Controls.bootstrap.DropDownButton.sample1
{
    public class ViewModel : DotvvmViewModelBase
    {
        public bool Collapsed { get; set; }
    }
}

Sample 2: Advanced Dropdown

The DropDownButtonItem control has the Enabled property which you can use to disable the menu item.

You can separate dropdown menu items using the bs:DropDownButtonSeparator control. You can also use the the bs:DropDownButtonHeader to specify a non-clickable title for a group of buttons.

The Type property is used to apply Bootstrap styles to DropDownButton. If you need to place a custom content on the button and not just text, use the ButtonContentTemplate.

page.dothtml

<bs:DropDownButton Text="Very Simple Dropdown with Headers" ButtonType="Button" Type="Success" >
  <bs:DropDownButtonHeader>Item 1</bs:DropDownButtonHeader>
  <bs:DropDownButtonItem NavigateUrl="https://www.google.com/">
    Google
  </bs:DropDownButtonItem>
  <bs:DropDownButtonHeader>Item 2</bs:DropDownButtonHeader>
  <bs:DropDownButtonItem NavigateUrl="https://github.com/riganti/dotvvm">
    DotVVM
  </bs:DropDownButtonItem>
</bs:DropDownButton>

<bs:DropDownButton>
  <ButtonContentTemplate>
    Very <strong>Simple Dropdown</strong> with separator and disabled value
  </ButtonContentTemplate>

  <bs:DropDownButtonItem NavigateUrl="https://www.google.com/" Enabled="false">
    Google
  </bs:DropDownButtonItem>
  <bs:DropDownButtonSeparator/>
  <bs:DropDownButtonItem NavigateUrl="https://github.com/riganti/dotvvm">
    DotVVM
  </bs:DropDownButtonItem>
</bs:DropDownButton>

Sample 3: DropDownButton Data-binding

You can also load the dropdown button items from a collection in the viewmodel using the DataSource property.

You have to specify the TextBinding which points to an appropriate property of the collection item. The URL of the item is specified using the NavigateUrlBinding property.

You can also use the IsDisabledBinding and IsSelectedBinding to specify which properties of the collection item declare the selected or disabled state of the button. The same logic applies to the ClickBinding property - use it if you want the buttons to invoke a command on the viewmodel.

page.dothtml
ViewModel.cs

<bs:DropDownButton Text="Dropdown Created From Data Source!"
                   DataSource="{value: LinksDataSet}"
                   IsEnabledBinding="{value: IsEnabled}"
                   IsSelectedBinding="{value: IsSelected}"
                   TextBinding="{value: Text}"
                   NavigateUrlBinding="{value: NavigateUrl}">
</bs:DropDownButton>

public class ViewModel : DotvvmViewModelBase
{
    public List<LinkItem> LinksDataSet { get; set; }

    private static IQueryable<LinkItem> GetData()
    {
        return new[]
        {
            new LinkItem() {  IsEnabled = true, IsSelected = false, NavigateUrl = "https://www.google.com/", Text = "Google"},
            new LinkItem() {  IsEnabled = true, IsSelected = false, NavigateUrl = "http://www.w3schools.com/html/", Text = "W3Schools"},
            new LinkItem() {  IsEnabled = true, IsSelected = true, NavigateUrl = "https://www.microsoft.com/en-us/", Text = "Microsoft"},
            new LinkItem() {  IsEnabled = false, IsSelected = false, NavigateUrl = "https://github.com/riganti/dotvvm", Text = "DotVVM Github"}
        }.AsQueryable();
    }

    public ViewModel()
    {
        LinksDataSet = new List<LinkItem>();
        foreach (LinkItem l in GetData())
        {
            LinksDataSet.Add(l);
        }
    }


}
public class LinkItem
{
    public string Text { get; set; }
    public string NavigateUrl { get; set; }
    public bool IsSelected { get; set; }
    public bool IsEnabled { get; set; }

}

Show all inherited properties

Properties

Name	Type	Description	Notes	Default Value
AllowPopupFlip	Boolean	Gets or sets whether the pop-up can flip to a different direction when it does not fit on the page.	attribute inner element static value bindable default	True
ButtonContentTemplate	ITemplate	Gets or sets the template for the button content.	attribute inner element static value bindable default	null
ButtonType	DropDownButtonType	Gets or sets the type of the button.	attribute inner element static value bindable default	Button
ClientIDMode	ClientIDMode	Gets or sets the client ID generation algorithm.	attribute inner element static value bindable default	Static
DataContext	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	Gets or sets the source collection or a GridViewDataSet that contains data in the control.	attribute inner element static value bindable default	null
DropDirection	DropDirection	Gets or sets the pop-up direction.	attribute inner element static value bindable default	DropDown
ID	String	Gets or sets the control client ID within its naming container.	attribute inner element static value bindable default	null
IncludeInPage	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	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
IsCollapsed	Boolean	Gets or sets whether the button is collapsed or not.	attribute inner element static value bindable default	True
IsEnabledBinding	IValueBinding	Gets or sets a value binding that points to a property indicating whether the item is disabled or not.	attribute inner element static value bindable default	null
IsSelectedBinding	IValueBinding	Gets or sets a value binding that points to a property indicating whether the item is selected or not.	attribute inner element static value bindable default	null
Items	List<IDropDownButtonItem>	Gets or sets a collection of items that is used when no DataSource is set.	attribute inner element static value bindable default	null
ItemsContentTemplate	ITemplate	Gets or sets the template for contents of the generated items when using the DataSource property.	attribute inner element static value bindable default	null
MenuAlignment	DropdownMenuAlignment	Gets or sets whether the pop-up will be aligned to the right of the button.	attribute inner element static value bindable default	Default
NavigateUrlBinding	IValueBinding	Gets or sets the value binding that points to a property which will be navigated to when the item is clicked.	attribute inner element static value bindable default	null
Size	Size	Gets or sets the size of the button.	attribute inner element static value bindable default	Default
Text	String	Gets or sets the button text.	attribute inner element static value bindable default
TextBinding	IValueBinding	Gets or sets the value binding that points to a property which will be used as the text of the item.	attribute inner element static value bindable default	null
Type	BootstrapButtonColor	Gets or sets the color of the button.	attribute inner element static value bindable default	Primary
Visible	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
VisualStyle	ButtonVisualStyle	Gets or sets whether the button has solid fill, or whether it is only an outline.	attribute inner element static value bindable default	SolidFill

Events

	Name	Type	Description
	ClickBinding	ICommandBinding	Gets or sets a binding which defines a click action for button items.