UsoUIElements is the standard Garage-Ware Games implementation of Unity's UiElements and is used as the base UI for all Garage-Ware Games applications written for Unity. More...

Namespaces
namespace	CustomElements
	Contains custom elements used by UsoUIElements.
namespace	Editor
	Contains editor only scripts used by UsoUIElements.
namespace	Templates
	Code templates for new elements.
namespace	Utilities
	Contains utility classes and functions used by UsoUIElements.

Classes
interface	IUsoUiElement
	Defines the contract for all USO UI framework elements, providing a standardized interface for field validation, data binding, styling, and framework integration capabilities. More...
class	UsoButton
	UsoButton is a custom button implementation, extending the Unity Button class, and is part of the GWG.UsoUIElements namespace. It provides additional functionality to the standard Button with the core Unity UI Elements framework. More...
class	UsoEnumField
	A custom enum field control that extends Unity's EnumField with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoFoldout
	A custom foldout control that extends Unity's Foldout with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoFormElement
	A custom form container element that extends Unity's VisualElement with USO UI framework functionality and specialized form management capabilities. Provides enhanced styling, field validation, data binding capabilities, form lifecycle events, and integration with the USO UI system for comprehensive form-based user interfaces. More...
class	UsoHelpBox
	A custom help box control that extends Unity's HelpBox with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoImage
	A custom image control that extends Unity's Image with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoLabel
	A custom label control that extends Unity's Label with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoLineItem
	A custom line item container element that extends Unity's VisualElement with USO UI framework functionality and hierarchical organization capabilities. Provides enhanced styling, field validation, data binding capabilities, validation state management, and integration with the USO UI system for structured content organization. More...
class	UsoListView
	A custom list view control that extends Unity's ListView with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoRowElement
	A custom row layout container element that extends Unity's VisualElement with USO UI framework functionality and horizontal layout configuration. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system for structured horizontal content organization. More...
class	UsoSlider
	A custom slider control that extends Unity's Slider with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoSliderInt
	A custom integer slider control that extends Unity's SliderInt with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoSlideToggle
	A custom slide toggle control that extends Unity's BaseField<bool> with USO UI framework functionality and animated sliding behavior. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system for interactive boolean input with visual sliding animation. More...
class	UsoTextField
	A custom text field control that extends Unity's TextField with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoToggle
	A custom toggle control that extends Unity's Toggle with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoToolbar
	A custom toolbar control that extends Unity's Toolbar with USO UI framework functionality. Provides enhanced styling, field validation, orientation control, and integration with the USO UI system. More...
class	UsoToolbarButton
	A custom toolbar button control that extends Unity's ToolbarButton with USO UI framework functionality. Provides enhanced styling, field validation, and integration with the USO UI system. More...
class	UsoToolbarMenu
	A custom toolbar menu control that extends Unity's ToolbarMenu with USO UI framework functionality. Provides enhanced styling, field validation, and integration with the USO UI system. More...
class	UsoToolbarSearchField
	A custom toolbar search field control that extends Unity's BindableElement with specialized search functionality and USO UI framework integration. Provides enhanced search capabilities, value change notifications, integrated clear functionality, and horizontal layout optimization for toolbar contexts. More...
class	UsoTreeView
	A custom tree view control that extends Unity's TreeView with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system. More...
class	UsoTwoPaneSplitView
	A custom two-pane split view control that extends Unity's TwoPaneSplitView with USO UI framework functionality. Provides enhanced styling, field validation, automatic pane creation, and integration with the USO UI system. More...
class	UsoUiDisplaySection
	A custom UI display section container element that extends Unity's VisualElement with USO UI framework functionality and specialized content display capabilities. Provides enhanced styling, field validation, data binding capabilities, theme integration, and data source management for structured content presentation within the USO UI system. More...
class	UsoVector3IntField
	A custom Vector3Int field control that extends Unity's Vector3IntField with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system for three-dimensional integer vector input. More...
class	UsoVisualElement
	A custom visual element container that extends Unity's VisualElement with USO UI framework functionality. Provides enhanced styling, field validation, data binding capabilities, and integration with the USO UI system for general-purpose container and layout scenarios. More...

Enumerations
enum	ElementType
	Enumeration defining the types of UI elements supported by the USO framework. Used for element categorization, factory methods, and type-specific behavior configuration. More...
enum	FieldStatusTypes
	Enumeration defining the validation and status states available for USO UI elements. Used to communicate field validation results, user feedback, and element states through visual indicators. More...
enum	LabelType
	Enumeration defining the visual hierarchy and styling types for label elements within the USO framework. Used to apply appropriate CSS classes and establish consistent typography throughout the application. More...
enum	ToolbarOrientation
	Enumeration that defines the available orientation options for UsoToolbar controls. Used to control the layout direction and arrangement of child elements within the toolbar. More...

Detailed Description

UsoUIElements is the standard Garage-Ware Games implementation of Unity's UiElements and is used as the base UI for all Garage-Ware Games applications written for Unity.

This system is designed for use with the Unity Data Binding system while making it much simpler to use.

Enumeration Type Documentation

◆ ElementType

enum GWG.UsoUIElements.ElementType

Enumeration defining the types of UI elements supported by the USO framework. Used for element categorization, factory methods, and type-specific behavior configuration.

This enumeration provides a way to categorize and identify different types of UI elements within the USO framework. It can be used for factory pattern implementations, configuration systems, and type-specific processing logic. The enumeration covers the primary interactive and display elements commonly used in USO applications.

◆ FieldStatusTypes

enum GWG.UsoUIElements.FieldStatusTypes

Enumeration defining the validation and status states available for USO UI elements. Used to communicate field validation results, user feedback, and element states through visual indicators.

This enumeration provides a standardized way to represent different states and validation results across all USO UI elements. Each status type triggers specific visual styling through CSS classes and may include color changes, icons, or other visual indicators. The status system enables consistent user feedback for form validation, operation results, and contextual information throughout USO applications. Status changes are typically applied through the SetFieldStatus method and reflected automatically in the UI.

◆ LabelType

enum GWG.UsoUIElements.LabelType

Enumeration defining the visual hierarchy and styling types for label elements within the USO framework. Used to apply appropriate CSS classes and establish consistent typography throughout the application.

This enumeration provides a standardized way to categorize label elements based on their semantic importance and visual hierarchy. Each type corresponds to specific CSS styling that maintains consistent typography and visual hierarchy throughout USO applications. The types range from prominent headers to descriptive text, allowing for clear information architecture and user interface organization.

◆ ToolbarOrientation

enum GWG.UsoUIElements.ToolbarOrientation

Enumeration that defines the available orientation options for UsoToolbar controls. Used to control the layout direction and arrangement of child elements within the toolbar.

This enumeration provides a simple way to specify toolbar layout without needing to work directly with CSS flex direction properties. The toolbar automatically applies appropriate styling based on the selected orientation.

Namespaces

Classes