docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.Dt.App.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. Use a Modal to display an AlertDialog object.

    AnchorPopup<T>

    Base class for Popup that can be anchored to another UI Element.

    Avatar

    Avatar UI element.

    Badge

    Badge UI element.

    BaseDialog

    Base class for Dialogs (Dialog, AlertDialog, etc).

    BaseSlider<TValueType>

    Base class for any Slider (TouchSliderFloat, TouchSliderInt, SliderFloat, SliderInt).

    BottomNotification<T>

    A base class for notification displayed at the bottom of the screen.

    BoundsField

    Bounds Field UI element.

    BoundsIntField

    BoundsInt Field UI element.

    BreadcrumbItem

    BreadcrumbItem visual element.

    Breadcrumbs

    Breadcrumbs visual element.

    BreadcrumbSeparator

    BreadcrumbSeparator visual element.

    Button

    Button UI element.

    ChangingEvent<TValueType>

    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.

    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.

    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.

    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.

    Dropdown

    Dropdown UI element.

    ExVisualElement

    A visual element that can be used as a normal VisualElement but with additional styling options like shadows, borders, outline, etc.

    FloatField

    Float Field UI element.

    FocusControllerExtensions

    Extension methods for FocusController.

    Header

    Header UI element.

    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.

    KeyboardFocusController

    A Manipulator that adds a class to the target element when it is keyboard focused. This is useful for accessibility purposes.

    KeyCodeExtensions

    Extensions for the KeyCode enum.

    LinearProgress

    LinearProgress UI element.

    Link

    A link visual element.

    LocalizedTextElement

    A localized text element.

    LongField

    A NumericalField<TValueType> that only accepts long values.

    Mask

    A visual element that can be used to mask color.

    Menu

    Menu UI element.

    MenuBuilder

    A utility class to build a Menu programmatically.

    MenuDivider

    A special Divider intended to be used inside Menu elements.

    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.

    NotifyValueChangingExtensions

    Extensions for INotifyValueChanging<TValueType>.

    NumericalField<TValueType>

    Numerical Field UI element.

    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.

    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. It also inherits from ContextProvider, hence this element must not have any ContextProvider ancestors.

    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.

    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.

    Radio

    Radio UI element.

    RadioGroup

    A container for a set of Radio UI elements.

    RectExtensions

    Extension methods for the Rect class.

    RectField

    Rect Field UI element.

    RectIntField

    RectInt Field UI element.

    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.

    SliderBase<TValueType>

    Base class for Sliders (SliderFloat, SliderInt).

    SliderFloat

    Slider UI element for floating point values.

    SliderInt

    Slider UI element for integer values.

    SplitView

    A SplitView is a container that displays two children at a time and provides a UI to navigate between them. The split bar can be dragged to resize the two children.

    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.

    Submittable

    A Manipulator that simulates a click when the target element is "submitted".

    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.

    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.

    TextElementExtendedUxmlTraits

    Class containing the UXML traits for the TextElement class.

    TextField

    Text Field UI element.

    TextFieldExtensions

    Extensions for the TextField class.

    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.

    TouchSlider<TValueType>

    Base class for TouchSlider UI elements (TouchSliderFloat, TouchSliderInt).

    TouchSliderFloat

    TouchSlider UI element for floating point values.

    TouchSliderInt

    TouchSlider UI element for integer values.

    Tray

    The Tray Popup class.

    ValueOutOfRangeException

    Exception thrown when a Visual Element hasn't been found.

    Vector2Field

    Vector2 Field UI element.

    Vector2IntField

    Vector2Int Field UI element.

    Vector3Field

    Vector3 Field UI element.

    Vector3IntField

    Vector3Int Field UI element.

    Vector4Field

    Vector4 Field UI element.

    VisualElementExtendedUxmlTraits

    Class containing the UXML traits for the VisualElement class.

    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.

    PositionResult

    The position result data structure returned in ComputePosition(VisualElement, VisualElement, Panel, PopoverPlacement, Int32, Int32, Boolean, Boolean) utility method.

    Interfaces

    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.

    INotifyValueChanging<TValueType>

    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<TValueType>

    Interface used on UI elements which handle value validation. Value validation implies the UI element has a value property, hence this interface inherits from UnityEngine.UIElements.INotifyValueChanged<T>.

    Enums

    AlertSemantic

    Semantic values used for AlertDialog variants.

    See variant.

    AnimationMode

    The animation used by Notification to appear and disappear.

    CheckboxState

    The possible states for a Checkbox.

    Chip.Variant

    The possible variants for a Chip.

    ColorPicker.SliderMode

    The type of channels sliders to display in the ColorPicker.

    Direction

    Direction of a UI container. This is used on Tabs UI elements for example.

    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.

    HeaderSize

    Header sizing.

    IconSize

    Sizing values for Icon elements.

    InlineValue

    Inline mode for the Slider value element.

    MobilePopupPresentationType

    Same as PopupPresentationType but for Mobile explicitly.

    ModalFullScreenMode

    The FullScreen mode used by a Modal component.

    NotificationStyle

    The style used to display the Notification element.

    PopoverPlacement

    Possible placements for a Popover.

    PopupPresentationType

    By providing a type prop, you can specify the type of Dialog that is rendered by your DialogTrigger. Note that pressing the Esc key will close the Dialog regardless of its type.

    Progress.Variant

    The progress variant.

    Size

    The sizing of UI components.

    Spacing

    The spacing of UI components.

    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.

    TrayPosition

    The position of the Tray.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023