CompoundButton
CompoundButton is a button containing a secondary text describing the main action of the button.
Usage
Basic
Style & Class
Visibility
ARIA
Link button
Button Type
Template
ClassStyles
Implementation
BitCompoundButton parameters
Name |
Type |
Default value |
Description |
---|---|---|---|
AllowDisabledFocus | bool | true | Whether the BitCompoundButton can have focus in disabled mode. |
AriaDescription | string? | null | Detailed description of the BitCompoundButton for the benefit of screen readers. |
AriaHidden | bool | false | If true, adds an aria-hidden attribute instructing screen readers to ignore the element. |
ButtonStyle | BitButtonStyle | BitButtonStyle.Primary | The style of the BitCompoundButton. |
ButtonType | BitButtonType | null | The value of the type attribute of the button rendered by the BitCompoundButton. |
ChildContent | RenderFragment? | null | The content of primary section of the BitCompoundButton. |
ClassStyles | BitCompoundButtonClassStyles? | null | Custom CSS classes/styles for different parts of the BitCompoundButton. |
Href | string? | null | The value of the href attribute of the link rendered by the BitCompoundButton. If provided, the component will be rendered as an anchor. |
OnClick | EventCallback<MouseEventArgs> | The callback for the click event of the BitCompoundButton. | |
PrimaryTemplate | RenderFragment? | null | The content of primary section of the BitCompoundButton (alias of the ChildContent). |
SecondaryText | string? | null | The text of the secondary section of the BitCompoundButton. |
SecondaryTemplate | RenderFragment? | null | The RenderFragment for the secondary section of the BitCompoundButton. |
Target | string? | null | Specifies target attribute of the link when the BitComponentButton renders as an anchor. |
Title | string? | null | The tooltip to show when the mouse is placed on the button. |
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. |
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. |
BitCompoundButtonClassStyles properties
Name |
Type |
Default value |
Description |
---|---|---|---|
Container | BitClassStylePair? | Custom CSS classes/styles for the internal container of the BitCompoundButton. | |
Primary | BitClassStylePair? | Custom CSS classes/styles for the primary section of the BitCompoundButton. | |
Secondary | BitClassStylePair? | Custom CSS classes/styles for the secondary section of the BitCompoundButton. |
BitClassStylePair properties
Name |
Type |
Default value |
Description |
---|---|---|---|
Class | string? | Custom CSS classes. | |
Style | string? | Custom CSS styles. |
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). |