Home Docs

ButtonGroup

The ButtonGroup component can be used to group related buttons.

Notes

The BitButtonGroupGroup is a Multi-API component which can accept the list of Items in 3 different ways: BitButtonGroupGroupItem class, a custom Generic class, and BitButtonGroupGroupOption component.

Usage

API

BitButtonGroup parameters
Name
Type
Default value
Description
ChildContent RenderFragment? null The content of the BitButtonGroup, that are BitButtonGroupOption components.
IconOnly bool false Determines that only the icon should be rendered.
Classes BitButtonGroupClassStyles? null Custom CSS classes for different parts of the ButtonGroup.
Color BitColor? null The general color of the button group.
FullWidth bool false Expand the ButtonGroup width to 100% of the available width.
Items IEnumerable<TItem> new List<TItem>() List of Item, each of which can be a Button with different action in the ButtonGroup.
ItemTemplate RenderFragment<TItem>? null The content inside the item can be customized.
NameSelectors BitButtonGroupNameSelectors<TItem>? null Names and selectors of the custom input type properties.
OnItemClick EventCallback<TItem> The callback that is called when a button is clicked.
Options RenderFragment? null Alias of ChildContent.
Toggle bool false Display ButtonGroup with toggle mode enabled for each button.
Size BitSize null The size of ButtonGroup, Possible values: Small | Medium | Large.
Styles BitButtonGroupClassStyles? null Custom CSS styles for different parts of the ButtonGroup.
Variant BitVariant? null The visual variant of the button group.
Vertical bool false Defines whether to render ButtonGroup children vertically.
BitComponentBase parameters
Name
Type
Default value
Description
AriaLabel string? null The aria-label of the control for the benefit of screen readers.
Class string? null Custom CSS class for the root element of the component.
Dir BitDir? null Determines the component direction.
HtmlAttributes Dictionary<string, object> new Dictionary<string, object>() Capture and render additional attributes in addition to the component's parameters.
Id string? null Custom id attribute for the root element. if null the UniqueId will be used instead.
IsEnabled bool true Whether or not the component is enabled.
Style string? null Custom CSS style for the root element of the component.
Visibility BitVisibility BitVisibility.Visible Whether the component is visible, hidden or collapsed.
BitComponentBase public members
Name
Type
Default value
Description
UniqueId Guid Guid.NewGuid() The readonly unique id of the root element. it will be assigned to a new Guid at component instance construction.
RootElement ElementReference The ElementReference of the root element.
BitButtonGroupItem properties
Name
Type
Default value
Description
Class string? null The custom CSS classes of the item.
IconName string? null Name of an icon to render next to the item text.
IsEnabled bool true Whether or not the item is enabled.
Key string? null A unique value to use as a Key of the item.
OffIconName string? null The icon of the item when it is not checked in toggle mode.
OffText string? null The text of the item when it is not checked in toggle mode.
OffTitle string? null The title of the item when it is not checked in toggle mode.
OnIconName string? null The icon of the item when it is checked in toggle mode.
OnText string? null The text of the item when it is checked in toggle mode.
OnTitle string? null The title of the item when it is checked in toggle mode.
OnClick EventCallback Click event handler of the item.
ReversedIcon bool false Reverses the positions of the icon and the main content of the item.
Style string? null The custom value for the style attribute of the item.
Template RenderFragment<BitButtonGroupItem>? null The custom template for the item.
Text string? null Text to render in the item.
Title string? null Title to render in the item.
BitButtonGroupOption properties
Name
Type
Default value
Description
Class string? null The custom CSS classes of the option.
IconName string? null Name of an icon to render next to the option text.
IsEnabled bool true Whether or not the option is enabled.
Key string? null A unique value to use as a key of the option.
OffIconName string? null The icon of the option when it is not checked in toggle mode.
OffText string? null The text of the option when it is not checked in toggle mode.
OffTitle string? null The title of the option when it is not checked in toggle mode.
OnIconName string? null The icon of the option when it is checked in toggle mode.
OnText string? null The text of the option when it is checked in toggle mode.
OnTitle string? null The title of the option when it is checked in toggle mode.
OnClick EventCallback Click event handler of the option.
ReversedIcon bool false Reverses the positions of the icon and the main content of the option.
Style string? null The custom value for the style attribute of the option.
Template RenderFragment<BitButtonGroupOption>? null The custom template for the option.
Text string? null Text to render in the option.
Title string? null Title to render in the option.
BitButtonGroupClassStyles properties
Name
Type
Default value
Description
Root string? null Custom CSS classes/styles for the root element of the BitButtonGroup.
Button string? null Custom CSS classes/styles for the internal button of the BitButtonGroup.
Icon string? null Custom CSS classes/styles for the icon of the BitButtonGroup.
Text string? null Custom CSS classes/styles for the text of the BitButtonGroup.
ToggledButton string? null Custom CSS classes/styles for the button when in toggle mode of the BitButtonGroup.
BitButtonGroupNameSelectors properties
Name
Type
Default value
Description
Class BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.Class)) The CSS Class field name and selector of the custom input class.
IconName BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.IconName)) IconName field name and selector of the custom input class.
IsEnabled BitNameSelectorPair<TItem, bool> new(nameof(BitButtonGroupItem.IsEnabled)) IsEnabled field name and selector of the custom input class.
Key BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.Key)) Key field name and selector of the custom input class.
OffIconName BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OffIconName)) OffIconName field name and selector of the custom input class.
OffText BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OffText)) OffText field name and selector of the custom input class.
OffTitle BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OffTitle)) OffTitle field name and selector of the custom input class.
OnIconName BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OnIconName)) OnIconName field name and selector of the custom input class.
OnText BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OnText)) OnText field name and selector of the custom input class.
OnTitle BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.OnTitle)) OnTitle field name and selector of the custom input class.
OnClick BitNameSelectorPair<TItem, Action<TItem>?> new(nameof(BitButtonGroupItem.OnClick)) OnClick field name and selector of the custom input class.
ReversedIcon BitNameSelectorPair<TItem, bool> new(nameof(BitButtonGroupItem.ReversedIcon)) ReversedIcon field name and selector of the custom input class.
Style BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.Style)) Style field name and selector of the custom input class.
Template BitNameSelectorPair<TItem, RenderFragment?> new(nameof(BitButtonGroupItem.Template)) Template field name and selector of the custom input class.
Text BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.Text)) Text field name and selector of the custom input class.
Title BitNameSelectorPair<TItem, string?> new(nameof(BitButtonGroupItem.Title)) Title field name and selector of the custom input class.
BitNameSelectorPair properties
Name
Type
Default value
Description
Name string Custom class property name.
Selector Func<TItem, TProp?>? Custom class property selector.
BitVariant enum
Name
Value
Description
Fill 0 Fill styled variant.
Outline 1 Outline styled variant.
Text 2 Text styled variant.
BitColor enum
Name
Value
Description
Primary 0 Primary general color.
Secondary 1 Secondary general color.
Tertiary 2 Tertiary general color.
Info 3 Info general color.
Success 4 Success general color.
Warning 5 Warning general color.
SevereWarning 6 Severe Warning general color.
Error 7 Error general color.
PrimaryBackground 8 Primary background color.
SecondaryBackground 9 Secondary background color.
TertiaryBackground 10 Tertiary background color.
PrimaryForeground 11 Primary foreground color.
SecondaryForeground 12 Secondary foreground color.
TertiaryForeground 13 Tertiary foreground color.
PrimaryBorder 14 Primary border color.
SecondaryBorder 15 Secondary border color.
TertiaryBorder 16 Tertiary border color.
BitSize enum
Name
Value
Description
Small 0 The small size button.
Medium 1 The medium size button.
Large 2 The large size button.
BitButtonType enum
Name
Value
Description
Button 0 The button is a clickable button.
Submit 1 The button is a submit button (submits form-data).
Reset 2 The button is a reset button (resets the form-data to its initial values).
BitVisibility enum
Name
Value
Description
Visible 0 The content of the component is visible.
Hidden 1 The content of the component is hidden, but the space it takes on the page remains (visibility:hidden).
Collapsed 2 The component is hidden (display:none).
BitDir enum
Name
Value
Description
Ltr 0 Ltr (left to right) is to be used for languages that are written from the left to the right (like English).
Rtl 1 Rtl (right to left) is to be used for languages that are written from the right to the left (like Arabic).
Auto 2 Auto lets the user agent decide. It uses a basic algorithm as it parses the characters inside the element until it finds a character with a strong directionality, then applies that directionality to the whole element.
  • On this page