Namespace Unity.AppUI.UI
Classes
Accordion
Accordion UI element.
AccordionItem
Item used inside an Accordion element.
AccordionItemValueChangedEvent
Event for when an accordion item value has changed.
ActionBar
ActionBar UI element.
ActionButton
ActionButton UI element.
ActionGroup
ActionGroup UI element.
ActionTriggeredEvent
An Action has been triggered.
AlertDialog
AlertDialog UI element.
AnchorPopupUtils
Utility class to compute the position of a popup based on the anchor's position and size.
AnchorPopup<T>
Base class for Popup that can be anchored to another UI Element.
AppBar
AppBar is a component that can be used to display a title, a back button, a drawer button and a set of actions.
Avatar
Avatar UI element.
AvatarGroup
AvatarGroup UI element.
AvatarVariantContext
The Avatar variant context.
BackgroundExtensions
Extension methods for Background objects.
Badge
Badge UI element.
BaseDatePicker
A base date picker control.
BaseDialog
Base class for Dialogs (Dialog, AlertDialog, etc).
BaseGridView
The base class for GridView elements.
BaseSlider<TValue, TScalar>
Base class for any kind of Slider such as TouchSliderFloat, SliderFloat or RangeSliderFloat.
BaseTextElement
Base class for all textual App UI components.
BaseVisualElement
Base class for all non textual App UI components.
BlinkingCursor
A manipulator that makes the cursor of a TextField blink.
BottomNavBar
A bottom navigation bar visual element.
BottomNavBarItem
A bottom navigation bar item visual element.
BoundsField
Bounds Field UI element.
BoundsIntField
BoundsInt Field UI element.
BreadcrumbItem
BreadcrumbItem visual element.
BreadcrumbSeparator
BreadcrumbSeparator visual element.
Breadcrumbs
Breadcrumbs visual element.
Button
Button UI element.
Canvas
A Canvas is a VisualElement that can be used to group other VisualElements. You can use it to create a scrollable area inside a window.
CanvasBackground
A CanvasBackground is a VisualElement used as the background of a Canvas.
ChangingEvent<TValue>
THe value changing event.
Checkbox
Checkbox UI element.
Chip
Chip UI element.
CircularProgress
CircularProgress UI element. This is a circular progress bar.
Clickable
Clickable Manipulator, used on Button elements.
ColorExtensions
Extensions for working with colors.
ColorField
Color Field UI element.
ColorPicker
ColorPicker UI Element.
ColorSlider
A slider that allows the user to select a color value.
ColorSwatch
A color swatch is a visual element that displays a color or a gradient.
ColorToolbar
A toolbar that contains a color swatch for the previous color, a color swatch for the current color, and an eye dropper button.
ColorWheel
A color wheel that allows the user to select a color hue by rotating the wheel. It is also possible to set the saturation and brightness and opacity of the wheel.
ContextChangedEvent<T>
Event raised when the context has changed.
ContextProvider
This element can be used in the visual tree to wrap a part of the user-interface where the context of the application needs to be overriden.
DateField
Date Field UI element.
DatePicker
A date picker control.
DateRangeField
DateRange Field UI element.
DateRangePicker
A date range picker control.
DefaultPropertyDrawerAttribute
Use this attribute to draw a property with the default PropertyField.
Dialog
Dialog UI element.
DialogTrigger
DialogTrigger serves as a wrapper around a Dialog and its associated trigger, linking the Dialog's open state with the trigger's press state. Additionally, it allows you to customize the type and positioning of the Dialog.
Divider
Divider UI element.
DoubleField
Double Field UI element.
DpiChangedEvent
The DPI has changed.
Draggable
Manipulator which monitors Press, Hold and Release events in order to drag visuals.
Dragger
Manipulator that allows dragging from a container component.
Drawer
Drawer UI element. A drawer is a UI element that slides in from the side of the screen. It can be used to display additional content or to display a menu.
DrawerHeader
A drawer header visual element.
DropZone
A drop zone is a container that can be used to drop content into.
DropZoneController
A droppable is a container that can be used to drop content into.
Dropdown
Dropdown UI element.
DropdownItem
Dropdown item UI element.
EnumExtensions
Extension methods for enums.
EnumField
EnumField UI element.
EnumerableExtensions
Enumerable extension methods.
ExVisualElement
A visual element that can be used as a normal VisualElement but with additional styling options like shadows, borders, outline, etc.
FieldLabel
A label for a field.
FloatField
Float Field UI element.
FloatingActionButton
A floating action button.
FocusControllerExtensions
Extension methods for FocusController.
GeneratedEnumExtensions
GradientExtensions
Extensions for the Gradient class.
GridView
A view containing recycled rows with items inside.
Heading
Heading UI element.
HelpText
A help text.
Icon
Icon UI component.
IconButton
IconButton UI element.
InputLabel
InputLabel UI element.
IntField
A VisualElement that displays a numeric value and allows the user to edit it.
KeyCodeExtensions
Extensions for the KeyCode enum.
KeyboardFocusController
A Manipulator that adds a class to the target element when it is keyboard focused. This is useful for accessibility purposes.
LinearProgress
LinearProgress UI element.
Link
A link visual element.
ListViewItem
A list view item visual element.
LocalizedTextElement
A localized text element.
LongField
A NumericalField<TValue> that only accepts long values.
Mask
A visual element that can be used to mask color.
MaskField
MaskField UI element.
MasonryGridView
A view containing Masonry grid layout.
Menu
Menu UI element.
MenuBuilder
A utility class to build a Menu programmatically.
MenuDivider
MenuItem
An item contained inside a Menu element.
MenuSection
A section inside a menu, with a heading.
MenuTrigger
A wrapper to display a menu when a trigger has been activated.
Modal
The Modal Popup class.
NavigationRail
A Navigation Rail is a UI element that provides a set of navigation options to the user on the side of the screen.
NavigationRailItem
A NavigationRailItem is a selectable item in a NavigationRail.
NotifyValueChangingExtensions
Extensions for INotifyValueChanging<TValue>.
NumericalField<TValue>
Numerical Field UI element.
OptionalScaleDrawerAttribute
Use this attribute to draw a property with the optional ScaleDrawer.
OptionalThemeDrawerAttribute
Use this attribute to draw a property with the optional ThemeDrawer.
PageIndicator
PageIndicator UI element. This element is used to display a list of dots that can be used to navigate between pages.
PageView
A PageView is a container that displays a single child at a time and provides a UI to navigate between them. It is similar to a ScrollView but here children are snapped to the container's edges.
PanAndZoomable
This manipulator allows panning and zooming of the content.
Pane
A Pane is a visual element that can be used as a child of a SplitView.
Panel
This is the main UI element of any Runtime App. The Panel class will create different UI layers for the main user-interface, popups, notifications and tooltips.
Picker
Picker UI element.
PickerItem
An Item from a Picker.
Picker<TItem, TTitle>
A Picker UI element with a title and a list of items.
PinchGestureEvent
Event sent in a Panel when a pinch gesture is recognized.
PointerEventExtensions
Extensions for UI-Toolkit PointerEvent
Popover
A popup usually anchored to another UI element.
Popup
This is the base class for any UI component that needs to be displayed over the rest of the user interface.
PopupNotification<T>
A base class for notification displayed at a specific anchor of the screen.
Popup<T>
A generic base class for popups.
Preloader
A preloader visual element.
Pressable
Pressable Manipulator, used on Button elements.
Progress
A base class for all progress UI elements. This class is not meant to be used directly.
Quote
Quote UI element.
Radio
Radio UI element.
RadioGroup
A container for a set of Radio UI elements.
RangeSliderFloat
Range Slider UI element for floating point values.
RangeSliderInt
Range Slider UI element for integer values.
RectExtensions
Extension methods for the Rect class.
RectField
Rect Field UI element.
RectIntField
RectInt Field UI element.
RegisterUpdateCallbackExtensions
Extensions to register a VisualElement update callback. This callback will be invoked when App UI main loop is updating. At runtime, the callback will be invoked once per frame. In the Editor, the callback will be invoked once per Editor update.
ResizeHandle
An element that can be dragged to resize another element.
SVSquare
SVSquare UI element. It is a square that allows to select a color by selecting a point in a 2D space.
The X axis represents the Hue and the Y axis represents the Saturation.
ScaleDrawerAttribute
Use this attribute to draw a property with the ScaleDrawer.
Scrollable
A Manipulator that allows the user to scroll a target element using your finger or mouse click and drag.
SearchBar
SearchBar UI element.
SingleExtensions
Extension methods for Single and Double.
SizeContext
The component size context.
SliderFloat
Slider UI element for floating point values.
SliderInt
Slider UI element for integer values.
Slider<TValue, TScalar, TInputField>
Base class for Sliders (SliderFloat, SliderInt).
Spacer
Spacer visual element.
SplitView
A SplitView is a visual element that can be used to split its children into panes. A SplitView can be either horizontal or vertical, and it will have splitters between the panes. This component can contain any number of Pane elements as children.
SplitViewPaneCollapsedEvent
Event for when the pane of a SplitView is collapsed or expanded.
Splitter
The splitter between the panes.
StackView
A StackView is a container that can contain multiple items. It is similar to a stack of cards. The items are added to the stack using the Push method. The top item is the current item. The current item can be removed using the Pop method. The item below the current item becomes the new current item. The current item can be replaced using the Replace method. The item below the current item is removed and the new item is added.
StackViewItem
An item in a StackView. It is a container for any UI element and must be used inside a StackView.
Stepper
Stepper UI element.
Styles
General usage styling classes for UI components.
SwipeView
A SwipeView is a container that displays one or more children at a time and provides a UI to navigate between them. It is similar to a ScrollView but here children are snapped to the container's edges. See PageView for a similar container that includes a page indicator.
SwipeViewItem
A SwipeViewItem is an item that must be used as a child of a SwipeView.
TabItem
An item used in Tabs bar.
Tabs
Tabs UI element.
Text
Text UI element.
TextArea
Text Area UI element.
TextField
Text Field UI element.
TextFieldExtensions
Extensions for the TextField class.
ThemeDrawerAttribute
Use this attribute to draw a property with the ThemeDrawer.
Thumb
Thumb UI element.
Toast
A toast is a view containing a quick little message for the user.
Toggle
Toggle UI element.
Toolbar
Accordion visual element.
Tooltip
The tooltip popup type.
TouchSliderFloat
TouchSlider UI element for floating point values.
TouchSliderInt
TouchSlider UI element for integer values.
TouchSlider<TValue>
Base class for TouchSlider UI elements (TouchSliderFloat, TouchSliderInt).
TrackpadGestureManipulator
A manipulator that can be used to receive trackpad gestures.
Tray
The Tray Popup class.
TreeViewItem
A tree view item that can be used directly in a ScrollView or any vertical container.
UnityObject
Helper class to destroy objects in the editor and in play mode.
UpdateEvent
THe AppUI Update event. At runtime, the callback will be invoked once per frame. In the Editor, the callback will be invoked once per Editor update.
UxmlFilePathAttribute
Attribute to specify the path to the UXML file for a VisualElement
ValueOutOfRangeException
Exception thrown when a Visual Element hasn't been found.
Vector2Field
Vector2 Field UI element.
Vector2IntField
Vector2Int Field UI element.
Vector2IntLexicographicalComparer
A simple comparer for Vector2Int that compares the x and y values lexicographically.
Vector2LexicographicalComparer
A simple comparer for Vector2 that compares the x and y values lexicographically.
Vector3Field
Vector3 Field UI element.
Vector3IntField
Vector3Int Field UI element.
Vector4Field
Vector4 Field UI element.
VisualElementExtensions
Extensions for VisualElement class.
VisualElementNotFoundException
Exception thrown when a Visual Element hasn't been found.
Structs
AdditionalStyle
Styling properties that can be applied to a ExVisualElement.
AnimationDescription
An animation description. It contains the duration of the animation, the easing function and the callback.
Pane.State
The state of a Pane.
PositionOptions
Options to pass as argument to ComputePosition(VisualElement, VisualElement, VisualElement, PositionOptions) utility method.
PositionResult
The position result data structure returned in ComputePosition(VisualElement, VisualElement, VisualElement, PositionOptions) utility method.
SliderMark<TScalar>
Small Data structure which represents a mark on the slider.
SplitView.State
The state of the SplitView.
Interfaces
IAdditionalDataHolder
Interface for any UI element that can hold additional data. This is used internally by App UI.
IContextOverrideElement
Interface for any UI element that can override the current context of the UI.
IDismissInvocator
Interface that must be implemented by any UI component which wants to request a Dismiss(DismissType) if this component is displayed inside a Popup component.
IFormattable<TValue>
Interface used on UI elements which can be formatted.
IInputElement<TValue>
Interface used on UI elements which handle user input.
INotifyValueChanging<TValue>
Interface that must be implemented to UI components which can change their value progressively, like a Slider.
IPlaceableElement
Interface that should be implemented in UI elements that can be anchored to another UI element.
IPressable
Interface for pressable elements.
ISelectableElement
Interface used on UI elements which handle a selected state.
ISizeableElement
Interface used on UI elements which handle user-defined sizing.
IValidatableElement<TValue>
Interface used on UI elements which handle value validation.
Enums
AlertSemantic
Semantic values used for AlertDialog variants.
AnimationMode
The animation used by Notification to appear and disappear.
AvatarGroupSpacing
The AvatarGroup spacing.
AvatarVariant
The Avatar variant.
BadgeOverlapType
The overlap type of the Badge.
BadgeVariant
The variant of the Badge.
BaseDatePicker.DisplayMode
Represents the display mode of the date picker.
BorderStyle
The style of a border.
ButtonVariant
The variant of the Button.
CanvasControlScheme
The current Canvas control scheme.
Note
The control scheme defines the key bindings for the Canvas manipulator.
- LMB = Left mouse button
- MMB = Middle mouse button (wheel button)
- RMB = Right mouse button
Warning
If a primaryManipulator is set on the Canvas, this manipulator will override the control scheme when the pointer (mouse, trackpad, etc) is used without modifier keys.
CanvasManipulator
The current Canvas manipulator for the primary pointer.
CheckboxState
The possible states for a Checkbox.
Chip.Variant
The possible variants for a Chip.
CollapseDirection
The direction towards which the SplitView's splitter will move to collapse.
ColorPicker.SliderMode
The type of channels sliders to display in the ColorPicker.
ColorPickerType
The type of ColorPicker to open when the ColorField is clicked.
Direction
Direction of a UI container.
Draggable.DragDirection
The direction of the drag.
DrawerAnchor
The anchor of the Drawer. The Drawer will be anchored to the left or right side of the screen.
DrawerVariant
The variant of the Drawer.
ExVisualElement.Passes
Rendering passes that will be executed. This is used to optimize and fine-tune the rendering.
FlexPosition
The position of an element inside a Flex container.
GrabMode
The current Grab Mode.
GridView.GridOperations
Available Operations.
GroupAlignment
The alignment of the group of items.
HeadingSize
Heading sizing.
HelpTextVariant
The variant of the HelpText.
HorizontalAnchor
A horizontal anchor.
IconSize
Sizing values for Icon elements.
IconVariant
Variant values for Icon elements.
IndicatorType
The type of indicator to display when a field is required.
LabelType
How to display the label of the NavigationRailItem.
MobilePopupPresentationType
Same as PopupPresentationType but for Mobile explicitly.
ModalFullScreenMode
The FullScreen mode used by a Modal component.
NavigationRailAnchor
The anchor of the Navigation Rail. The Rail will be anchored to the left or right side of the screen.
NotificationStyle
The style used to display the Notification element.
OutsideClickStrategy
The strategy used to determine if a click is outside of the popup.
PickerSelectionType
The type of selection for a Picker.
PopoverPlacement
Possible placements for a Popover.
PopupNotificationPlacement
The placement where the notification should be displayed.
PopupPresentationType
By providing a type prop, you can specify the type of Dialog that is rendered by your DialogTrigger.
Progress.Variant
The progress variant.
RestrictedValuesPolicy
The policy to restrict the values of the slider.
Size
The sizing of UI components.
SpacerSpacing
The spacer spacing.
Spacing
The spacing of UI components.
Splitter.CollapsedState
The collapse state the splitter.
StackViewItemStatus
The status of a StackViewItem.
StackViewOperation
The operation to perform on a StackView.
TextOverflow
The text overflow mode.
TextSize
Sizing values for Text UI element.
ToolbarDockMode
The dock mode of the Toolbar.
TrackDisplayType
The mode to display the track of the slider.
TrayPosition
The position of the Tray.
ValueDisplayMode
The mode to display the value of the slider.
VerticalAnchor
A vertical anchor.
Delegates
AvatarGroup.RenderSurplusDelegate
The render surplus delegate.
FormatFunction<TValue>
A function to format the value of a slider thumb or mark.
MaskField.GetDisplayNameDelegate
Method to get the display name for a specific index in the source items collection.
MaskField.GetMaskValueDelegate
Method to get the mask value for a specific index in the source items collection.
PanAndZoomable.GrabModeChangedDelegate
A delegate that is called when the grab mode changes.
PanAndZoomable.ScrollOffsetChangedDelegate
A delegate that is called when the scroll offset changes.
PanAndZoomable.ZoomChangedDelegate
A delegate that is called when the zoom level changes.
Picker<TItem, TTitle>.BindItemFunc
Method to bind the item data to the Dropdown menu item element.
Picker<TItem, TTitle>.BindTitleFunc
Method to bind the title data to the Dropdown button element.
Slider<TValue, TScalar, TInputField>.ScaleHandler
Handler to scale the value of the slider thumbs and marks.
VisualElementExtensions.TooltipContentCallback
Callback to populate the tooltip content.