Skip to main content

LgNumericBox<TValue>

Module : Lagoon.UI
Namespace : Lagoon.UI.Components
Category: Input
Inherits from: LgInputRenderBase<TValue>

Numeric input box component.

Parameters​

ParameterTypeDescription
Decimalsint?Gets or sets decimals number input format.
DisplayFormatstringGets or sets the display format.
IncrementStepTValueIncrement step applied with increase/decrease buttons.
OnChangeDisabledboolGets or sets if the OnChange event is disabled.
OnChangingAsyncFunc<ChangingEventArgs<TValue>, Task>Gets or sets a callback called before the current value is changed.
OnFocusEventCallback<FocusEventArgs>Gets or sets a callback called on the onfocus event.
OnInputEventCallback<ChangeEventArgs>Gets or sets a callback called on each change of the text typed in the input.
OnKeyEventCallback<KeyboardEventArgs>Gets or sets a callback called on the onkey event.
ParsingErrorMessagestringGets or sets the error message used when displaying an a parsing error.
PlaceholderstringGets or sets the input placeholder
RoundValueModeMidpointRounding?Gets or sets the default round mode.

Parameters inherited from LgInputRenderBase<TValue>​

ParameterTypeDescription
PrefixstringGets or sets the input prefix.
PrefixTypeInputLabelTypeIndicate if prefix is simple text or icon from library.
SuffixstringGets or sets the input suffix.
SuffixTypeInputLabelTypeIndicate if suffix is simple text or icon from library. (Default: Text)

Parameters inherited from LgInputBase<TValue>​

ParameterTypeDescription
AdditionalAttributesIReadOnlyDictionary<string, object>Gets or sets a collection of additional attributes that will be applied to the created element.
AutoFocusboolGets or sets if the component received the focus on first render
ConfirmationMessagestringGets or sets if the component display confirmation modal with the message
ContainerIInputContainer<TValue>Used to attach a GridView cell to this input.
CssClassstringGets or sets the CSS class.
DisabledboolGets or sets the input disabled attribute
DisplayNamestringGets or sets the display name for this field. This value is used when generating error messages when the input value fails to parse correctly.
HideValidationMessageboolGet or set validator state
LabelstringGets or sets the label
LabelContentRenderFragmentGets or sets the render fragment to customize the label part
OnChangeEventCallback<ChangeEventArgs>Gets or sets a callback called after a the current value changed.
OnResetEventCallback<ChangeEventArgs>Gets or sets the call when the input is reset.
PolicyEditstringPolicy required to edit the TextBox
PolicyVisiblestringPolicy required to view the TextBox
ReadOnlyboolGets or sets the input readonly attribute
Requiredbool?Get or sets if this field is mandatory. If this parameter is null or not defined, the value is extracted from the [Required] attribute on the binding property.
ResetButtonbool?Display reset button if true
ResetTextstringReset button text
ResetTextAriaLabelstringReset button ariaLabel text
TooltipstringGets or sets the tooltip.
TooltipIsHtmlboolGets or sets if the tooltip contents use the HTML format; else, the content use a raw text format.
ValueTValueGets or sets the value of the input. This should be used with two-way binding.
ValueChangedEventCallback<TValue>Gets or sets a callback that updates the bound value.
ValueExpressionExpression<Func<TValue>>Gets or sets an expression that identifies the bound value.

Cascading parameters inherited from LgInputBase<TValue>​

ParameterTypeDescription
ParentAuthorizeViewLgAuthorizeViewPotential policies defined by an ancestor

Parameters inherited from LgAriaComponentBase​

ParameterTypeDescription
AriaLabelstringGets or sets aria label
AriaLabelledBystringGets or sets id of component for aria label