Name |
Type |
Default value |
Description |
---|
AriaDescription |
string? |
null |
Detailed description of the input for the benefit of screen readers. |
AriaPositionInSet |
int? |
null |
The position in the parent set (if in a set). |
AriaSetSize |
int? |
null |
The total size of the parent set (if in a set). |
AriaValueNow |
double? |
null |
Sets the control's aria-valuenow. Providing this only makes sense when using as a controlled component. |
AriaValueText |
string? |
null |
Sets the control's aria-valuetext. |
Classes |
BitSpinButtonClassStyles? |
null |
Custom CSS classes for different parts of the BitSpinButton. |
ChangeHandler |
EventCallback<BitSpinButtonAction> |
|
? |
DecrementAriaLabel |
string? |
null |
Accessible label text for the decrement button (for screen reader users). |
DecrementIconName |
string |
ChevronDownSmall |
Custom icon name for the decrement button. |
DecrementTitle |
string? |
null |
The title to show when the mouse is placed on the decrement button. |
DefaultValue |
double? |
null |
Initial value of the spin button. |
IconAriaLabel |
string |
string.Empty |
The aria label of the icon for the benefit of screen readers. |
IconName |
string? |
null |
Icon name for an icon to display alongside the spin button's label. |
IncrementAriaLabel |
string? |
null |
Accessible label text for the increment button (for screen reader users). |
IncrementIconName |
string? |
null |
Custom icon name for the increment button. |
IncrementTitle |
string |
ChevronUpSmall |
The title to show when the mouse is placed on the increment button. |
IsInputReadOnly |
bool |
false |
If true, the input is readonly. |
Label |
string |
string.Empty |
Descriptive label for the spin button, Label displayed above the spin button and read by screen readers. |
LabelPosition |
BitLabelPosition |
BitLabelPosition.Top |
The position of the label in regards to the spin button. |
LabelTemplate |
RenderFragment? |
null |
Custom Label content for spin button. |
Max |
double? |
null |
Max value of the spin button. If not provided, the spin button has max value of double type. |
Min |
double? |
null |
Min value of the spin button. If not provided, the spin button has minimum value of double type. |
Mode |
BitSpinButtonMode |
BitSpinButtonMode.Compact |
Determines how the spinning buttons should be rendered. |
OnBlur |
EventCallback<FocusEventArgs> |
|
Callback for when the control loses focus. |
OnChange |
EventCallback<double> |
|
Callback for when the spin button value change. |
OnDecrement |
EventCallback<double> |
|
Callback for when the decrement button or down arrow key is pressed. |
OnFocus |
EventCallback<FocusEventArgs> |
|
Callback for when focus moves into the input. |
OnIncrement |
EventCallback<double> |
|
Callback for when the increment button or up arrow key is pressed. |
Precision |
int? |
null |
How many decimal places the value should be rounded to. |
ShowInput |
bool |
true |
If false, the input is hidden. |
Step |
double |
1 |
Difference between two adjacent values of the spin button. |
Styles |
BitSpinButtonClassStyles? |
null |
Custom CSS styles for different parts of the BitSpinButton. |
Suffix |
string |
string.Empty |
A text is shown after the spin button value. |
Title |
string? |
null |
A more descriptive title for the control, visible on its tooltip. |
ValidationMessage |
string |
"The {DisplayName ?? FieldIdentifier.FieldName} field is not valid." |
The message format used for invalid values entered in the input. |
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. |