LgSuggestBox

Module : Lagoon.UI
Namespace : Lagoon.UI.Components
Category: Suggest
Inherits from: LgSuggestBoxBase<string>

A suggest box component.

Parameters inherited from LgSuggestBoxBase<TItem>

Parameter	Type	Description
ControllerUri	string	Gets or sets remote data url
DropDownMaxHeight	int	Gets or sets dropdown maximal height in pixel
FilterTextSearchMode	FilterTextSearchMode	Gets or sets the search text mode (containe by default)
HighlightText	bool	Hilghlight founded text into result list
ItemContent	RenderFragment<TItem>	Gets or sets child item result content
Items	IEnumerable<TItem>	Gets or sets the items source
MaxItemsInView	int	Define the number of items displayed from the search result. Default : 8 Set to 0 to display all results.
MinSearchCharacter	int	Minimal input length before the search is fired
SeeAllEnabled	bool	Display a "See All" button to get all data
TextFilterCollation	CollationType?	Gets or sets the type of case and accent sensitivity.

Parameters inherited from LgTextBox

Parameter	Type	Description
AllowResize	bool	Allow the textbox to be resized (false by default).
AutoComplete	bool	Gets or sets the flag indicating if the browser should automatically complete the input.
AutoUnmask	bool	Gets or sets the flag indicating if value should be returned without the mask.
ClearIncomplete	bool	Gets or sets the flag indicating if value should be clear if mask is incomplete.
DataList	List<string>	Gets or sets the datalist
InputMask	string	Gets or sets the input mask
InputMaskKind	InputMaskKind	Gets or sets the input mask kind
InputMaskPlaceholder	string	Gets or sets the character (or string) filling the empty positions of the input mask.
MaxLength	int?	Gets or sets the maximum number of characters entered
MaxRows	int?	Gets or sets the maximum number of lines shown when TextMode is TextBoxMode.Multiline.
MinRows	int?	Gets or sets the maximum number of lines shown when TextMode is TextBoxMode.Multiline.
OnChangeDisabled	bool	Gets or sets if the OnChange event is disabled.
OnChangingAsync	Func<ChangingEventArgs<string>, Task>	Gets or sets a callback called before the current value is changed.
OnFocus	EventCallback<FocusEventArgs>	Gets or sets a callback called on the onfocus event.
OnInput	EventCallback<ChangeEventArgs>	Gets or sets a callback called on each change of the text typed in the input.
OnKeyUp	EventCallback<KeyboardEventArgs>	Gets or sets a callback called on the onkey event.
Placeholder	string	Gets or sets the input placeholder
Rows	int?	The number of lines when TextMode is TextBoxMode.Multiline.
TextMode	TextBoxMode?	Gets or sets input text mode.

Parameters inherited from LgInputRenderBase<TValue>

Parameter	Type	Description
Prefix	string	Gets or sets the input prefix.
PrefixType	InputLabelType	Indicate if prefix is simple text or icon from library.
Suffix	string	Gets or sets the input suffix.
SuffixType	InputLabelType	Indicate if suffix is simple text or icon from library. (Default: Text)

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