Extension: omni.kit.widget.path_field-2.0.11 |
Documentation Generated: Nov 07, 2024 |
Overview
The omni.kit.widget.path_field module provides a UI widget, PathField, designed for path input and navigation within a tree-like structure. It enhances user interaction by allowing keyboard navigation and offering auto-filtered suggestions for branching paths, making it a more efficient tool for path selection compared to standard string input fields.
Important API List
The module consists of the following main component:
PathField: A widget that provides a user interface for inputting paths with keyboard navigation and branching options, enhancing the usability of path selection in applications.
General Use Case
The PathField widget can be used in applications where users need to navigate through file paths or hierarchical data structures. It provides a seamless and interactive way to enter and edit paths, with support for auto-completion and custom handlers for applying paths and fetching branching options. This widget is particularly useful in applications with complex navigation requirements, where efficient and user-friendly path input is essential. For examples of how to use the APIs, please consult the Python usage pages.