Extension: omni.kit.widget.searchfield-1.1.8

Documentation Generated: Dec 17, 2024

Overview#

The omni.kit.widget.searchfield extension provides a widget for creating interactive search fields within the Omniverse Kit UI. The SearchField class allows users to input search terms, manage search tokens, and receive suggestions while typing. It offers customization options for the appearance and behavior of the search field, as well as callback functions that can be used to integrate the widget’s functionality into applications.

Important API List#

The module consists of the following main components:

  • SearchField: A widget that represents a search field where users can input search words and receive suggestions.

General Use Case#

Users can utilize the SearchField to input search queries, which can be tokenized and manipulated within the search field. The widget can show suggestions based on the current input, and developers can set callback functions to react to search queries and input changes. For examples of how to use the APIs, please consult the Python usage pages.

User Guide#