public OmniBox(Config config)

Initializes a new instance of this class.

public ObservableList<InlineFilterChip> InlineFilterChips { get; }

Gets or sets the inline filter chips.

public SearchQuery CurrentSearchQuery

What the box says right now, parsed - the same SearchQuery pressing Enter would raise, chips included. For a host that answers as the query is typed rather than on Enter.

public IReadOnlyList<ContextCard> ContextToAdd

Gets the cards currently shown in the context row, in the order they were added.

public bool HasContextToAdd

Returns a value indicating whether the context row currently holds any card.

public ModelOption SelectedModel

Gets or sets the selected model.

public Mode ActiveMode { get ; set ; }

Which half of a SearchAndChat box is showing. Setting it switches the box and moves its own toggle with it, so a host that drives the mode from somewhere else - a control in a page header - and the box never disagree. On a box that is only search or only chat this is that mode and setting it does nothing.

public IObservable<Mode> ActiveModeObservable

Follows ActiveMode - what a host with a mode control of its own, or a header that shows different things in each mode, listens to.

public ThinkingEffort SelectedThinkingEffort

Gets or sets the selected thinking effort.

public bool IsModelLocked

Returns a value indicating whether the component is model locked.

public bool IsGenerating { get ; set ; }

Returns a value indicating whether the component is generating.

public bool AllowSendWhileGenerating { get ; set ; }

Gets or sets whether a message typed while IsGenerating is set is sent instead of the trigger stopping the reply in flight — for a host that queues it for the turn in progress. The trigger still offers "stop" while the input is empty.

public string GeneratingText { get ; set ; }

Gets or sets the label shown next to the spinner while generating (defaults to "Generating"). The elapsed time is appended after it, e.g. "Generating, 1m 25s". Setting it updates the footer immediately when a generation is in progress.

public DateTimeOffset GeneratingStartedAt { get ; set ; }

Gets or sets when the generation in progress started — what the footer's elapsed time counts from. Setting IsGenerating starts it at the current time; set it afterwards to backdate a generation that began before this box knew about it, e.g. a reply that was already running when its chat was opened. A time in the future counts as now.

public IReadOnlyList<string> ChatHistory

The messages Up walks back through in the empty chat input, oldest first: what WithChatHistory was given, plus every message sent from this box since.

public int TabIndex { set ; }

Sets the keyboard tab order of the component.

public bool IsEnabled { get ; set ; }

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

public string SearchText { get ; set ; }

Gets or sets the search text.

public string ChatText { get ; set ; }

Gets or sets the chat text.

public int MaxChatCharacters { get ; set ; }

Gets or sets how many characters a chat message can hold, as MaxCharacters does at construction. Set it to zero to lift the limit again.

public string SearchPlaceholder { get ; set ; }

Gets or sets the search placeholder.

public string ChatPlaceholder { get ; set ; }

Gets or sets the chat placeholder.

public string Background { get ; set ; }

Gets or sets the CSS background of the component.

public string SuggestedText

The text currently suggested in the empty search box, or null - see SetSuggestedText.

public bool IsSearching

Whether the box is showing that a search is running - see SetSearching.

public OmniBox AcceptSuggestedText()

Puts the suggested text (see SetSuggestedText) into the search box, as if the user had typed it, and leaves the caret at its end. Does nothing when there is no suggestion or the box is not empty.

public static SearchQuery ParseQuery(string input, bool tokenIgnoreCase = false)

Parses the query.

public OmniBox RegisterSnap(SnapHandler snap)

Registers a snap-handler that can convert recognized input into an inline filter chip.

public OmniBox RegisterSnaps(params SnapHandler[] snaps)

Registers multiple snap-handlers in one call.

public OmniBox RegisterFilterSnap(FilterSnapHandler filter)

Registers a filter snap handler that creates an inline filter chip.

public OmniBox RegisterFilterSnaps(params FilterSnapHandler[] filters)

Registers multiple filter snap handlers in one call.

public OmniBox AddSnap(SnapHandler snap)

Adds an active snap chip as if the user had typed its trigger and picked it, and re-runs the search. Use it to open a box already filtered, e.g. restoring the chips a search was made with. A snap that is already active is not added twice.

public OmniBox AddFilterSnap(FilterSnapHandler handler, string value, string trigger = null)

Adds an active filter chip as if the user had typed the trigger and picked value, and re-runs the search. Use it to open a box already filtered — a palette that starts from the filters the view behind it is applying, say. Without trigger the handler's first trigger word is used.

public OmniBox ClearSnaps()

Removes every active snap and filter chip from the box, and re-runs the search.

public OmniBox EnableChatMentions(ChatMention mention)

Enables an "@mention" style inline picker in the chat input: typing Trigger (default @) at a word boundary shows a picker anchored at the text caret, live-filters as more is typed, and forwards Arrow Up/Down, Enter/Tab and Escape to the callbacks below. This is a thin, UI-agnostic hook — wire it up to any anchored picker (for example a ToolAgentSelector via its ShowInlineAt/Filter/ MoveHighlight/ActivateHighlighted methods).

public OmniBox AddContext(ContextCard card)

Adds one more card to the context row, keeping the cards already there.

public OmniBox RemoveContext(ContextCard card)

Takes one card out of the context row. Does nothing if the card isn't in it.

public OmniBox ClearContext()

Empties the context row. Call it from the chat handler once the context has been sent along with the message.

public double CaretClientX()

The viewport-relative horizontal position of the text caret in whichever input is currently active (the search box or the chat box), clamped to that input's bounds. Returns double.NaN when there is no active input to measure — for example before the OmniBox has been rendered.

Remarks

Used by companions that want to track where the user is typing, e.g. PixelAvatar attached with AttachTo.

public OmniBox OnSearch(SearchEventHandler onSearch)

Registers a callback invoked when the search event fires.

public OmniBox OnChat(ChatEventHandler onChat)

Registers a callback invoked when the chat event fires.

public OmniBox OnChatPaste(ChatPasteEventHandler onChatPaste)

Registers a callback invoked when something is pasted into the chat input, so the host can take what the input cannot: an image on the clipboard, a copied file.

Remarks

The handler decides. Set Handled to keep the paste out of the input; leave it alone and the paste happens as it always would, which is what a handler that only wants the files should do when a paste carries text as well.

public OmniBox OnStop(StopEventHandler onStop)

Registers a callback invoked when the stop event fires.

public OmniBox OnModelChanged(ModelChangedEventHandler onModelChanged)

Registers a callback invoked when the model changed event fires.

public OmniBox LockModel(ModelOption model)

Locks the OmniBox to the given model option so users cannot pick another.

public OmniBox SetThinkingEffort(ThinkingEffort effort)

Sets the thinking effort of the component.

public OmniBox NoModeToggle()

Takes the Search/Chat toggle out of the box's own footer, for a host that puts one somewhere of its own. ActiveMode still switches the box, and still reports which half is showing.

public OmniBox OnInput(ComponentEventHandler<OmniBox, Event> onInput)

Registers a callback invoked when the input event fires.

public OmniBox OnKeyDown(ComponentEventHandler<OmniBox, KeyboardEvent> onKeyDown)

Registers a callback invoked when the key down event fires.

public OmniBox OnKeyUp(ComponentEventHandler<OmniBox, KeyboardEvent> onKeyUp)

Registers a callback invoked when the key up event fires.

public OmniBox OnKeyPress(ComponentEventHandler<OmniBox, KeyboardEvent> onKeyPress)

Registers a callback invoked when the key press event fires.

public OmniBox OnFocus(ComponentEventHandler<OmniBox, Event> onFocus)

Registers a callback invoked when the focus event fires.

public OmniBox OnBlur(ComponentEventHandler<OmniBox, Event> onBlur)

Registers a callback invoked when the blur event fires.

public OmniBox WithHistory(Func<Task<SearchQuery[]>> historyFetcher)

Shows a history button on the left of the search input that lists the recent searches historyFetcher returns, most recent first, and turns on Up/Down history in the search input: Up in the empty box fetches the same list and puts its first entry in the box, each further Up goes one search further back, and Down comes forward again, back to the empty box. The searches made in this box since it was built are walked first even when the fetcher does not return them yet. Typing or deleting anything ends the walk, and Up/Down go back to moving the caret.

public OmniBox WithChatHistory(IEnumerable<string> messages)

Replaces the chat history with messages, in the order they were sent (oldest first, the order a conversation reads in) - typically the user's own messages, gathered when a conversation is opened. Up in the empty chat input puts the most recent one in the box, each further Up goes one message further back, and Down comes forward again, back to the empty box. Typing or deleting anything ends the walk, and Up/Down go back to moving the caret. Every message sent from the box is added for you, so this only needs calling for what was sent before it existed.

public OmniBox AddToChatHistory(string message)

Adds message to the end of the chat history, as the most recent message - for one sent some other way than through this box. Blank messages, and a repeat of the most recent one, are skipped.

public OmniBox ClearChatHistory()

Empties the chat history, so Up in the empty chat input has nothing to bring back until the next message is sent.

public OmniBox WithHelp(bool showSyntax = false)

Enables a help button next to the search input that opens a popup listing the registered filter snaps (and snaps), each with the trigger word and an example value (or the description as a fallback). When showSyntax is true, the popup also includes a "Query syntax" section describing the boolean operators (AND, OR, NOT), grouping with parentheses, and exact-phrase quoting, with a short example next to each. Recent searches are reached via the separate history button configured with WithHistory.

public OmniBox WithAskAI(string text = "Ask AI", UIcons icon = UIcons.Beacon, Action<OmniBox> onClick = null)

Adds a primary-styled action button at the end of the search input — the way out of a search that isn't finding it, over to whatever answers the question instead. The button follows the box's roundness, so a box made round with Rounded gets a pill. Search modes only: in SearchAndChat the button sits at the end of the footer and hides itself while the box is in chat mode. Calling this again updates the button that is already there; passing a null or empty text hides it.

Parameters

text

The button label, e.g. "Ask AI".

icon

The icon shown before the label.

onClick

Called with this OmniBox when the button is clicked — read SearchText from it to know what was typed.

public HTMLElement Render()

Renders the component's root HTML element.

public OmniBox SetKeyboardShortcut(params string[] keys)

Registers a global keyboard shortcut that focuses the OmniBox search input when pressed, and renders a visual chip showing the shortcut on the right side of the search box. In SearchAndChat mode, pressing the shortcut also switches the active mode to Search. Modifier names are case-insensitive ("Ctrl", "Cmd", "Meta", "Alt", "Shift"). Example: SetKeyboardShortcut("Ctrl", "K").

public OmniBox SetSearchRightText(string text)

Sets the search right text of the component.

public OmniBox SetSearchText(string text)

Sets the search text of the component.

public OmniBox SetSearchPlaceholder(string text)

Sets the search placeholder of the component.

public OmniBox SetSuggestedText(string text, Action<string> onAccepted = null)

Shows text in the empty search box in place of the placeholder, followed by a Tab keycap: pressing Tab while the box is focused and empty puts the text in the box, as if it had been typed. The suggestion steps aside as soon as anything is typed and comes back when the box is emptied, until ClearSuggestedText is called. onAccepted, if given, is called with the text each time the suggestion is accepted.

public OmniBox ClearSuggestedText()

Removes the suggestion set by SetSuggestedText; the placeholder shows again and Tab moves focus as usual.

public OmniBox SetSearching(bool searching)

Says that a search is running: the magnifier gives its place to a spinner, in the same spot, so the box keeps its shape while it runs. A fast answer never makes it blink - the spinner only fades in after a moment.

public OmniBox SetChatText(string text)

Sets the chat text of the component.

public OmniBox SetChatPlaceholder(string text)

Sets the chat placeholder of the component.

public OmniBox SetChatHeader(IComponent component)

Replaces the component rendered inside the box above the chat input — the place for whatever the message is being written against, e.g. a compact ContextCards group of the attached documents. Passing null empties the slot, which then takes up no space.

public OmniBox Rounded(BorderRadius radius = BorderRadius.Full)

Renders the box with rounded corners (defaults to a fully rounded "pill" shape). The radius carries over to everything that meets the box's outline — the search container, the buttons at its ends and the "Ask AI" button added with WithAskAI — and the pill shape also drops the vertical dividers between them, so the contents sit inside the curve.

Parameters

radius

The border radius to apply. Defaults to Full.

public OmniBox Disabled(bool value = true)

Disables the component.

public OmniBox Focus()

Moves keyboard focus to the component.

public OmniBox Height(UnitSize unitSize)

Gets or sets the CSS height of the component.

public OmniBox H(int unitSize)

Shortcut for setting the height in pixels.

public event StopEventHandler Stopped

Raised when stopped occurs.

public event ComponentEventHandler<OmniBox, Event> Input

Raised when input occurs.

public event ComponentEventHandler<OmniBox, KeyboardEvent> KeyDown

Raised when key down occurs.

public event ComponentEventHandler<OmniBox, KeyboardEvent> KeyUp

Raised when key up occurs.

public event ComponentEventHandler<OmniBox, KeyboardEvent> KeyPress

Raised when key press occurs.

public event ComponentEventHandler<OmniBox, Event> ReceivedFocus

Raised when received focus occurs.

public event ComponentEventHandler<OmniBox, Event> LostFocus

Raised when lost focus occurs.

private int _suggestionsRequest = 0

Which suggestions request the popup is still willing to draw. Debouncing cancels a *pending* timer, never a fetch already in flight, so with a fetcher slower than the debounce two requests overlap and the one that answers last wins -- which is the older one whenever the network reorders them, leaving suggestions for a query the user has already typed past. Every trigger and every hide takes the next number, and an answer that no longer holds the current one is dropped instead of drawn.

private const string CHAT_TRIGGER_SWAP_CLASS = "tss-omnibox-chat-btn-swap"

Put on the trigger's icon for the moment it turns from "send" into "stop" or back (tss.omnibox.css).

public ToolAgentSelector(string label = "Tools", UIcons icon = UIcons.Tools)

Initializes a new instance of this class.

public Item[] SelectedItems

Gets every currently selected item, agents first, then tools.

public int SelectedCount

Gets the number of currently selected items.

public override HTMLElement Render()

Renders the component's root HTML element.

public ToolAgentSelector Agents(params Item[] items)

Sets the items shown under the "Agents" section (replaces any previously set).

public ToolAgentSelector Tools(params Item[] items)

Sets the items shown under the "Tools" section (replaces any previously set).

public ToolAgentSelector Compact(bool value = true)

Hides item descriptions, rendering a denser list of icon + title rows only.

public ToolAgentSelector OnChange(Action<ToolAgentSelector> handler)

Registers a callback invoked whenever the selection changes.

public override ToolAgentSelector Show()

Shows the popup anchored below the trigger button.

public ToolAgentSelector ShowInlineAt(double clientX, double clientY)

Shows the popup anchored at an explicit viewport position (for example, next to a text caret), without moving focus or toggling the trigger button's pressed state. Used to back an "@mention" style picker.

public override void Hide(Action onHidden = null)

Hides the popup.

public ToolAgentSelector Filter(string text)

Filters the visible items by the given free-text query (matches title or description). Used both by the built-in search box and externally, to drive the popup from an inline "@" mention as the user types.

public void MoveHighlight(int direction)

Moves the keyboard-navigation highlight forward (positive) or backward (negative) among the currently visible items, wrapping around at either end.

public bool ActivateHighlighted()

Toggles the selection of the currently highlighted item (defaulting to the first visible item if none is highlighted yet). Returns true if an item was toggled.

public event Action<ToolAgentSelector> SelectionChanged

Raised whenever an item's selected state changes.