LgCheckBox<TValue>

Module : Lagoon.UI
Namespace : Lagoon.UI.Components
Category: CheckBox
Inherits from: LgInputBase<TValue>

A checkbox component.

Parameters

Parameter	Type	Description
AllowIndeterminateState	bool	Gets or sets if the user can set the indeterminate state.
CheckBoxKind	CheckBoxKind	Gets or sets the checkbox type.
Item	object	Gets or sets an object that contains data about the control.
OnChangingAsync	Func<ChangingItemEventArgs<TValue>, Task>	Gets or sets a callback called before the value is changed.
Text	string	Gets or sets the text.
TextPosition	CheckBoxTextPosition	Gets or sets the label's position.

Parameters inherited from LgInputBase<TValue>

Parameter	Type	Description
AdditionalAttributes	IReadOnlyDictionary<string, object>	Gets or sets a collection of additional attributes that will be applied to the created element.
AutoFocus	bool	Gets or sets if the component received the focus on first render
ConfirmationMessage	string	Gets or sets if the component display confirmation modal with the message
Container	IInputContainer<TValue>	Used to attach a GridView cell to this input.
CssClass	string	Gets or sets the CSS class.
Disabled	bool	Gets or sets the input disabled attribute
DisplayName	string	Gets or sets the display name for this field. This value is used when generating error messages when the input value fails to parse correctly.
HideValidationMessage	bool	Get or set validator state
Label	string	Gets or sets the label
LabelContent	RenderFragment	Gets or sets the render fragment to customize the label part
OnChange	EventCallback<ChangeEventArgs>	Gets or sets a callback called after a the current value changed.
OnReset	EventCallback<ChangeEventArgs>	Gets or sets the call when the input is reset.
PolicyEdit	string	Policy required to edit the TextBox
PolicyVisible	string	Policy required to view the TextBox
ReadOnly	bool	Gets or sets the input readonly attribute
Required	bool?	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.
ResetButton	bool?	Display reset button if true
ResetText	string	Reset button text
ResetTextAriaLabel	string	Reset button ariaLabel text
Tooltip	string	Gets or sets the tooltip.
TooltipIsHtml	bool	Gets or sets if the tooltip contents use the HTML format; else, the content use a raw text format.
Value	TValue	Gets or sets the value of the input. This should be used with two-way binding.
ValueChanged	EventCallback<TValue>	Gets or sets a callback that updates the bound value.
ValueExpression	Expression<Func<TValue>>	Gets or sets an expression that identifies the bound value.

Cascading parameters inherited from LgInputBase<TValue>

Parameter	Type	Description
ParentAuthorizeView	LgAuthorizeView	Potential policies defined by an ancestor

Parameters inherited from LgAriaComponentBase

Parameter	Type	Description
AriaLabel	string	Gets or sets aria label
AriaLabelledBy	string	Gets or sets id of component for aria label