Version: 2.0 |

Badge

in namespace DotVVM.Framework.Controls.Bootstrap4

Renders a Bootstrap badge widget.

Properties

Name Type Description Notes Default Value
Enabled Boolean Gets or sets whether this item is enabled.
attribute
inner element
static value
bindable
default
True
NavigateUrl String Gets or sets of the navigate URL of the link.
attribute
inner element
static value
bindable
default
RouteName String Gets or sets the name of the route for the item hyperlink.
attribute
inner element
static value
bindable
default
Text String Gets or sets the text inside the badge.
attribute
inner element
static value
bindable
default
Type BootstrapColor Gets or sets of the type of the badge.
attribute
inner element
static value
bindable
default
Primary
UrlSuffix String Gets or sets the suffix that will be appended to the generated URL.
attribute
inner element
static value
bindable
default
VisualStyle BadgeVisualStyle Gets or sets whether the badge is rendered as a classic badge or as a pill.
attribute
inner element
static value
bindable
default
Default

Events

Name Type Description
Click Command Gets or sets the command that will be triggered when the button is clicked.

Usage & Scenarios

Renders a Boostrap badge component.

https://getbootstrap.com/docs/4.1/components/badge/

HTML Rendered by the Control

Sample 1: Basic Badge

Place the contents of the Badge inside the control, or use the Text property.

The Type property specifies the color category of the badge.

You can use the Shape to specify, whether the badge should have a normal shape, or whether it should be rendered as a pill.

<bs:Badge Text="100"/>

<bs:Badge>
  <h1>9000+</h1>
</bs:Badge>

<bs:Badge Type="Primary" Shape="Pill" />

Sample 2: Badge in a Button

If you need to use the Badge inside the button, don't forget to set the ButtonTagName to Button.

Otherwise, the button would be rendered as <input type="button"> which supports only a text values.

<bs:Button Click="{command: Increment()}" ButtonTagName="button">
  Number of clicks: <bs:Badge Text="{value: Clicks}"/>
</bs:Button>
public class ViewModel : DotvvmViewModelBase
{
    public int Clicks { get; set; } = 0;

    public void Increment()
    {
        Clicks++;
    }
}

Sample 3: Badge as Link or Button

The Badge control can work as a button or a link.

  • You may set NavigateUrl to make the badge to link to a specific URL.
  • The Click event can be used to invoke a command in the viewmodel.
  • You may also use RouteName, Param-*, Query-* and UrlSuffix properties to build a link from a route table. See RouteLink for details.
<bs:Badge Text="NavigateUrl" 
          NavigateUrl="https://google.com" />

<bs:Badge Text="Click" 
          Click="{command: ChangeText()}" />

<bs:Badge Text="Route" 
          RouteName="Badge_Link" 
          Param-Id="1"
          Query-Page="10"
          UrlSuffix="#table" />
public class ViewModel : DotvvmViewModelBase
{
    public int Clicks { get; set; } = 0;

    public void Increment()
    {
        Clicks++;
    }
}

Suggestions


Help & Contribute

The documentation is maintained on GitHub.
We'll be happy if you edit the page and create a pull request.

Send message