public SearchBox(string placeholder = string.Empty)

Initializes a new instance of this class.

public int TabIndex { set ; }

Sets the keyboard tab order of the component.

public bool IsFocused

Returns a value indicating whether the component is focused.

public bool IsEnabled { get ; set ; }

Gets or sets a value indicating whether the component is interactive (enabled).

public bool IsUnderlined { get ; set ; }

Returns a value indicating whether the component is underlined.

public string Text { get ; set ; }

Gets or sets the text shown in the component.

public string Placeholder { get ; set ; }

Gets or sets the placeholder text shown when the component is empty.

public bool IsInvalid { get ; set ; }

Gets or sets a value indicating whether the component is currently in an invalid state.

public bool IsBusy { get ; set ; }

Gets or sets a value indicating whether the component is waiting on the search it asked for. While set, a spinner stands where the clear button does and the box reports itself as busy to assistive technology; the box stays editable throughout. On a box with an OnCancel handler, a pointer on it swaps the spinner for the cancel button. It says nothing about Failed, which the caller takes down itself - usually with ClearFailure where it starts the next search.

public bool IsFailed

Returns a value indicating whether the box is showing that its last search did not answer.

public TextSize Size { get ; set ; }

Gets or sets the size of the component.

public TextWeight Weight { get ; set ; }

Gets or sets the font weight of the component.

public TextAlign TextAlign { get ; set ; }

Gets or sets the text alignment of the component.

public string Background { get ; set ; }

Gets or sets the CSS background of the component.

public bool IsShowingProgress

Returns a value indicating whether the progress bar along the bottom edge of the box is showing.

public SearchBox Clear()

Empties the box, puts the caret in it and raises OnSearch with the empty query - what pressing the clear button does.

public override HTMLElement Render()

Renders the component's root HTML element.

public void Attach(ComponentEventHandler<SearchBox> handler)

Attaches a handler to the component's value-changed event.

public SearchBox SetText(string text)

Sets the text of the component.

public SearchBox SetPlaceholder(string error)

Sets the placeholder of the component.

public SearchBox Disabled(bool value = true)

Disables the component.

public SearchBox Busy(bool value = true)

Shows (or hides) the spinner that says the box is waiting on its search - see IsBusy.

public SearchBox Failed(int millisecondsVisible = 5000)

Says the last search did not answer: the box is outlined in the danger colour and carries a warning glyph where the spinner was, for millisecondsVisible (pass 0 to leave it up until something clears it, which is ClearFailure). Nothing else takes it down: it describes one search, so the caller that starts the next one is what says the last one stopped mattering. It says that the search itself failed, which is not the same as a query the user should fix; a box whose *contents* are wrong is IsInvalid, and that one stays until it is put right.

public SearchBox ClearFailure()

Takes down the failure set by Failed now, rather than when it would have expired.

public SearchBox ProgressIndeterminate()

Shows an indeterminate progress bar sweeping along the bottom edge of the box, for a load whose size is not known. Take it down with HideProgress.

public SearchBox HideProgress()

Takes down the progress set by Progress or ProgressIndeterminate. A bar kept up by ShowProgressWhile stays until its tasks end.

public SearchBox ShowProgressWhile(Task task, Action onEnded = null)

Shows an indeterminate progress bar until task ends, however it ends. Overlapping calls keep the bar up until the last of their tasks has ended; a progress set by hand takes precedence while set.

public SearchBox Underlined()

Configures the component to underlined.

public SearchBox NotUnderlined()

Removes the underline from the component.

public SearchBox SetIcon(UIcons icon)

Sets the icon of the component.

public SearchBox NoIcon()

Removes / disables the icon on the component.

public SearchBox Focus()

Moves keyboard focus to the component.

public SearchBox SearchAsYouType()

Configures the search box to fire its callback after every keystroke (debounced) rather than only on submit.

public SearchBox OnSearch(SearchEventHandler onSearch)

Registers a callback invoked when the search event fires.

public SearchBox OnCancel(SearchCancelledEventHandler onCancel)

Registers what to do when the user calls off a search that is still running, and by registering it says a search can be called off: while IsBusy a pointer on the box then swaps the spinner for a cancel button, in the same place and at the same size, and pressing it raises this and nothing else. The box is not emptied and no search is raised - a handler that wants either does it itself (box.Clear() empties it and raises OnSearch with the empty query). Without a handler there is no cancel button and a busy box keeps its clear button, since nothing would be offered in its place.

public SearchBox SetKeyboardShortcut(params string[] keys)

Registers a global keyboard shortcut that focuses this SearchBox when pressed, and renders a visual chip showing the shortcut on the right side of the box. Modifier names are case-insensitive ("Ctrl", "Cmd", "Meta", "Alt", "Shift"). Example: SetKeyboardShortcut("Ctrl", "K").

public SearchBox OnShortcut(Action onShortcut)

What the shortcut set by SetKeyboardShortcut does instead of focusing the box - for a box that stands for a search happening somewhere else. Pass null to have it focus again.

public SearchBox Height(UnitSize unitSize)

Gets or sets the CSS height of the component.

public SearchBox H(int unitSize)

Shortcut for setting the height in pixels.