Extension: omni.kit.widget.highlight_label-1.0.3 |
Documentation Generated: Dec 17, 2024 |
Overview#
This extension provides the HighlightLabel widget, designed for displaying text within a user interface and allowing specific words or phrases to be highlighted. It is a flexible component that supports case-sensitive or case-insensitive matching for the highlighted text, customizable dimensions, and styling.
Important API List#
The extension primarily consists of the following public API:
HighlightLabel: A widget that displays text with the capability to highlight specified words or phrases.
General Use Case#
The HighlightLabel widget can be used in user interfaces where there is a need to draw attention to specific words or phrases within blocks of text. This could be useful in applications such as text editors, documentation viewers, or any context where emphasizing certain text dynamically is beneficial. The widget’s support for case-sensitive and case-insensitive highlighting, along with its customizable appearance, makes it versatile for various UI design needs. For examples of how to use the APIs, please consult the Python usage pages.