Unity App UI

https://docs.unity3d.com/Packages/com.unity.dt.app-ui@2.2
Admin
Unity App UI is a powerful framework for building beautiful, high-performance user interfaces in...
Tokens:321,267
Snippets:4,289
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Custom Color Picker Example

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ColorField.html

An example demonstrating how to implement and use a custom color picker with the ColorField.

```APIDOC
## Custom Color Picker Example

### Description
This example shows how to create a custom implementation of `ICustomColorFieldPicker` and assign it to a `ColorField`.

### Code Example
```csharp
// Example implementation of a custom color picker
public class CustomColorPicker : ICustomColorFieldPicker
{
    private VisualElement m_PickerWindow;
    private Action<Color> m_OnValueChanging;
    private ColorField m_Owner;
    private Color m_InitialColor;

    public void Show(ColorField owner, Action<Color> onValueChanging, Color initialColor, bool showAlpha, bool hdr)
    {
        m_Owner = owner;
        m_OnValueChanging = onValueChanging;
        m_InitialColor = initialColor;

        // Create custom picker UI
        m_PickerWindow = new VisualElement { name = "custom-picker" };

        // Setup picker with callbacks
        var picker = new MyCustomPickerUI(initialColor, showAlpha, hdr);

        picker.onColorChanged += (color) =>
        {
            // Send ChangingEvent while picker is still open
            m_OnValueChanging?.Invoke(color);
        };

        picker.onColorAccepted += (color) =>
        {
            // Send final ChangeEvent like the default implementation
            using var evt = ChangeEvent<Color>.GetPooled(m_InitialColor, color);
            evt.target = m_Owner;
            m_Owner.SetValueWithoutNotify(color);
            m_Owner.SendEvent(evt);
            ClosePickerWindow();
        };

        picker.onCanceled += () =>
        {
            // Revert to initial color
            m_OnValueChanging?.Invoke(m_InitialColor);
            ClosePickerWindow();
        };

        m_PickerWindow.Add(picker);
        owner.rootVisualElement.Add(m_PickerWindow);
    }

    private void ClosePickerWindow()
    {
        m_PickerWindow?.RemoveFromHierarchy();
        m_OnValueChanging = null;
        m_Owner?.Focus();
    }
}

// Usage:
var colorField = new ColorField();
colorField.customPicker = new CustomColorPicker();
```
```

--------------------------------

### Setup(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.StoryBookComponent.html

Configures the component using the provided VisualElement.

```APIDOC
## public virtual void Setup(VisualElement element)

### Description
Sets up the component with the specified VisualElement.

### Parameters
- **element** (VisualElement) - The element to setup.
```

--------------------------------

### Setup Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.StoryBookComponent.html

Initializes the component with a specific VisualElement.

```csharp
public virtual void Setup(VisualElement element)
```

--------------------------------

### Create and Apply Logging Middleware

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.Middleware-1.html

Example of creating a logging middleware and applying it to a Redux store using Store.ApplyMiddlewares and Store.ComposeEnhancers.

```csharp
// Middleware that logs all actions
var loggerMiddleware = (store) => next => action =>
{
   Debug.Log($"Dispatching action: {action}");
   // Call the next middleware in the chain
   next(action);
};
// Apply the middleware to the store
var middlewares = Store.ApplyMiddlewares(loggerMiddleware);
var enhancer = Store.ComposeEnhancers(middlewares, DefaultEnhancer.GetDefaultEnhancer());
var store = Store.CreateStore(reducer, initialState, enhancer);
```

--------------------------------

### NavGraph.startDestination

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavGraph.html

Property to get or set the starting destination for the NavGraph. A NavGraph must have a startDestination set to be considered valid.

```APIDOC
## Property: startDestination

### Description
Gets or sets the starting destination for this NavGraph. This destination is added to the back stack when the NavGraph is navigated to.

### Type
NavDestination

### Usage
```csharp
public NavDestination startDestination { get; set; }
```
```

--------------------------------

### BuildWith Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AppBuilder.html

Initializes the application using the provided host instance.

```csharp
public IApp<THost> BuildWith<THost>(THost host) where THost : class, IHost
```

--------------------------------

### Get Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.IPartionableState.html

The declaration for the Get method used to retrieve a slice state from the store state.

```csharp
TSliceState Get<TSliceState>(string sliceName)
```

--------------------------------

### SetupAppBar Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.INavVisualController.html

Sets up the app bar for a given navigation destination.

```APIDOC
## POST /api/SetupAppBar

### Description
Setup the app bar.

### Method
POST

### Endpoint
/api/SetupAppBar

### Parameters
#### Request Body
- **appBar** (AppBar) - Required - The app bar to setup.
- **destination** (NavDestination) - Required - The destination to setup the app bar for.
- **navController** (NavController) - Required - The navigation controller.

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

### Request Example
```json
{
  "appBar": {},
  "destination": {},
  "navController": {}
}
```

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### attachmentName

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.BaseThreadAttachment.html

Gets the name of the attachment.

```APIDOC
## attachmentName

### Description
The name of the attachment.

### Declaration
`public abstract string attachmentName { get; }`

### Property Value
- **Type**: string
```

--------------------------------

### SetupDrawer Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.INavVisualController.html

Sets up the drawer for a given navigation destination.

```APIDOC
## POST /api/SetupDrawer

### Description
Setup the drawer.

### Method
POST

### Endpoint
/api/SetupDrawer

### Parameters
#### Request Body
- **drawer** (Drawer) - Required - The drawer to setup.
- **destination** (NavDestination) - Required - The destination to setup the drawer for.
- **navController** (NavController) - Required - The navigation controller.

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

### Request Example
```json
{
  "drawer": {},
  "destination": {},
  "navController": {}
}
```

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### filePath

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.UxmlFilePathAttribute.html

Gets the path to the UXML file.

```APIDOC
## Property: filePath

### Description
Returns the path to the UXML file associated with the attribute.

### Declaration
`public string filePath { get; }`

### Property Value
- **Type**: string
```

--------------------------------

### contentContainer

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.BottomNavBar.html

Gets the content container of the BottomNavBar.

```APIDOC
## contentContainer

### Description
Retrieves the VisualElement that acts as the content container for the navigation bar.

### Syntax
```csharp
public override VisualElement contentContainer { get; }
```
```

--------------------------------

### Initializing the Application

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.IApp-1.html

Method to initialize the application with a service provider and an optional host.

```csharp
void Initialize(IServiceProvider serviceProvider, THost host = null)
```

--------------------------------

### Prepare Start Drag

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Core.DragAndDrop.html

Clears existing drag and drop data in preparation for a new operation.

```csharp
public static void PrepareStartDrag()
```

--------------------------------

### SetupBottomNavBar Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.INavVisualController.html

Sets up the bottom navigation bar for a given navigation destination.

```APIDOC
## POST /api/SetupBottomNavBar

### Description
Setup the bottom navigation bar.

### Method
POST

### Endpoint
/api/SetupBottomNavBar

### Parameters
#### Request Body
- **bottomNavBar** (BottomNavBar) - Required - The bottom navigation bar to setup.
- **destination** (NavDestination) - Required - The destination to setup the bottom navigation bar for.
- **navController** (NavController) - Required - The navigation controller.

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

### Request Example
```json
{
  "bottomNavBar": {},
  "destination": {},
  "navController": {}
}
```

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### GetTooltipTemplate(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.VisualElementExtensions.html

Get the tooltip template for a VisualElement.

```APIDOC
## GetTooltipTemplate(VisualElement)

### Description
Get the tooltip template for a VisualElement.

### Signature
`public static VisualElement GetTooltipTemplate(this VisualElement element)`

### Parameters
- **element** (VisualElement) - The target visual element.

### Returns
- **VisualElement** - The tooltip template.

### Exceptions
- **ArgumentNullException** - The VisualElement object can't be null.
```

--------------------------------

### GetTooltipContent(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.VisualElementExtensions.html

Get the tooltip content for a VisualElement.

```APIDOC
## GetTooltipContent(VisualElement)

### Description
Get the tooltip content for a VisualElement.

### Signature
`public static VisualElementExtensions.TooltipContentCallback GetTooltipContent(this VisualElement element)`

### Parameters
- **element** (VisualElement) - The target visual element.

### Returns
- **VisualElementExtensions.TooltipContentCallback** - The tooltip content callback.

### Exceptions
- **ArgumentNullException** - The VisualElement object can't be null.
```

--------------------------------

### SetupNavigationRail Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.INavVisualController.html

Sets up the navigation rail for a given navigation destination.

```APIDOC
## POST /api/SetupNavigationRail

### Description
Setup the navigation rail.

### Method
POST

### Endpoint
/api/SetupNavigationRail

### Parameters
#### Request Body
- **navigationRail** (NavigationRail) - Required - The navigation rail to setup.
- **destination** (NavDestination) - Required - The destination to setup the navigation rail for.
- **navController** (NavController) - Required - The navigation controller.

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

### Request Example
```json
{
  "navigationRail": {},
  "destination": {},
  "navController": {}
}
```

### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### NavHost()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavHost.html

Initializes a new instance of the NavHost class.

```APIDOC
## NavHost()

### Description
Default constructor for the NavHost class.

### Syntax
```csharp
public NavHost()
```
```

--------------------------------

### clickable

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.PickerItem.html

Gets or sets the Clickable manipulator for the PickerItem.

```APIDOC
### Property
#### clickable

`public Pressable clickable { get; set; }`

Clickable Manipulator for this PickerItem.
```

--------------------------------

### PushSubMenu (Details)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MenuBuilder.html

Creates an action menu item with specified details, adds a sub-menu to the current menu, and makes it the current menu.

```APIDOC
## POST /api/menu/push-submenu/details

### Description
Creates an action menu item with specified details, adds a sub-menu to the current menu, and makes it the current menu.

### Method
POST

### Endpoint
/api/menu/push-submenu/details

### Parameters
#### Request Body
- **actionId** (int) - Required - A unique identifier for the action.
- **labelStr** (string) - Required - The raw label of the menu item (will be localized).
- **iconName** (string) - Required - The icon of the menu item.

### Response
#### Success Response (200)
- **MenuBuilder** (MenuBuilder) - The MenuBuilder instance.

### Request Example
```json
{
  "actionId": 3,
  "labelStr": "Sub Menu Item",
  "iconName": "submenu_icon"
}
```

### Response Example
```json
{
  "MenuBuilder": "// MenuBuilder object"
}
```
```

--------------------------------

### title

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.DrawerHeader.html

Gets or sets the title text of the DrawerHeader.

```APIDOC
### Property: title

#### Description
Gets or sets the title string displayed in the DrawerHeader.

#### Declaration
`public string title { get; set; }`

#### Property Value
- **string** - The title text.
```

--------------------------------

### colorValue

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ColorSlider.html

Gets the currently selected color value.

```APIDOC
### Property
#### colorValue

**Description**
The currently selected color value from the slider.

**Type**
`Color`

**Declaration**
`public Color colorValue { get; }`
```

--------------------------------

### IApp<THost>.Initialize(IServiceProvider, THost)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.IApp-1.html

Initializes the application with the provided service provider and host.

```APIDOC
## void Initialize(IServiceProvider serviceProvider, THost host)

### Description
Initializes the application using the specified service provider and host instance.

### Parameters
- **serviceProvider** (IServiceProvider) - The service provider to use for dependency resolution.
- **host** (THost) - The host instance to associate with the application.
```

--------------------------------

### PrepareAnimateViewIn method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.AnchorPopup-1.html

Performs final layout preparation one frame before animation starts.

```csharp
protected override void PrepareAnimateViewIn()
```

--------------------------------

### colorRange

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ColorSlider.html

Gets or sets the gradient range for the slider.

```APIDOC
### Property
#### colorRange

**Description**
The current color range displayed in the slider track.

**Type**
`Gradient`

**Declaration**
`public Gradient colorRange { get; set; }`
```

--------------------------------

### ContextProvider()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ContextProvider.html

Initializes a new instance of the ContextProvider class.

```APIDOC
## Constructor: ContextProvider()

### Description
Initializes a new instance of the ContextProvider class.

### Syntax
`public ContextProvider()`
```

--------------------------------

### context

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ContextChangedEvent-1.html

Gets the new context associated with the event.

```APIDOC
## Property: context

### Description
Retrieves the new context value.

### Type
`T` (where T : IContext)

### Access
Read-only
```

--------------------------------

### HelpBox()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.HelpBox.html

Initializes a new instance of the HelpBox class using the default constructor.

```APIDOC
## HelpBox()

### Description
Initializes a new instance of the HelpBox class.

### Syntax
public HelpBox()
```

--------------------------------

### attachmentIcon

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.BaseThreadAttachment.html

Gets the icon name associated with the attachment.

```APIDOC
## attachmentIcon

### Description
The icon name for the attachment.

### Declaration
`public abstract string attachmentIcon { get; }`

### Property Value
- **Type**: string
```

--------------------------------

### Store Constructor

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.Store-1.html

Initializes a new store instance. Use Store.CreateStore instead of calling this constructor directly.

```csharp
[Preserve]
public Store(Reducer<TStoreState> reducer, TStoreState initialState)
```

--------------------------------

### LangContext.GetLocalizedStringAsyncDelegate

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Core.LangContext.GetLocalizedStringAsyncDelegate.html

The delegate to get a localized string asynchronously.

```APIDOC
## Delegate LangContext.GetLocalizedStringAsyncDelegate

### Description
The delegate to get a localized string asynchronously.

### Namespace
Unity.AppUI.Core

### Assembly
Unity.AppUI.dll

### Syntax
```csharp
public delegate Task<string> LangContext.GetLocalizedStringAsyncDelegate(string referenceText, string lang, params object[] arguments)
```

### Parameters
#### Path Parameters
- **referenceText** (string) - Required - The reference text.
- **lang** (string) - Required - The language.
- **arguments** (object[]) - Required - The arguments to format the string.

### Returns
- **Task<string>** - The localized string.
```

--------------------------------

### AppUISetup Class

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.AppUISetup.html

The AppUISetup class is a static class used to add App UI Shaders to the GraphicsSettings PreloadedShaders list. It is marked with the InitializeOnLoad attribute, indicating it runs automatically when Unity loads.

```APIDOC
## Class AppUISetup

### Description
This class is used to add the App UI Shaders to the GraphicsSettings PreloadedShaders list.

### Namespace
Unity.AppUI.Editor

### Assembly
Unity.AppUI.Editor.dll

### Syntax
```csharp
[InitializeOnLoad]
public static class AppUISetup
{
}
```

### Inheritance
- object
- AppUISetup

### Inherited Members
- object.Equals(object)
- object.Equals(object, object)
- object.GetHashCode()
- object.GetType()
- object.MemberwiseClone()
- object.ReferenceEquals(object, object)
- object.ToString()
```

--------------------------------

### AnimateViewIn method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.AnchorPopup-1.html

Starts the entry animation for the popup.

```csharp
protected override void AnimateViewIn()
```

--------------------------------

### GoTo

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.SwipeView.html

Navigates to the item at the specified index.

```csharp
public bool GoTo(int index)
```

--------------------------------

### GetLastAncestorOfType<T>(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.VisualElementExtensions.html

Get the last ancestor of a given type.

```APIDOC
## GetLastAncestorOfType<T>(VisualElement)

### Description
Get the last ancestor of a given type.

### Signature
`public static T GetLastAncestorOfType<T>(this VisualElement view) where T : VisualElement`

### Parameters
- **view** (VisualElement) - The VisualElement object.

### Returns
- **T** - The last ancestor of the given type.
```

--------------------------------

### value Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ThreadComposer.html

Gets or sets the current text content.

```csharp
public string value { get; set; }
```

--------------------------------

### AppUIBuildSetup Class Syntax

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.AppUIBuildSetup.html

The class definition for AppUIBuildSetup, implementing necessary build callback interfaces.

```csharp
public class AppUIBuildSetup : IPreprocessBuildWithReport, IPostprocessBuildWithReport, IOrderedCallback
```

--------------------------------

### thumbCount

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.SliderInt.html

Gets the number of thumbs currently configured for the slider.

```APIDOC
### Property
#### thumbCount

Gets the number of thumbs for this slider.

##### Declaration
```csharp
protected override int thumbCount { get; }
```

##### Property Value
- **int** - The number of thumbs.
```

--------------------------------

### SetupAppBar Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavigationScreen.html

Configures the AppBar specifically for the current screen.

```csharp
protected virtual void SetupAppBar(AppBar appBar, NavController controller)
```

--------------------------------

### PushSubMenu (Action)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MenuBuilder.html

Creates an action menu item, adds a sub-menu to the current menu, and makes it the current menu.

```APIDOC
## POST /api/menu/push-submenu/action

### Description
Creates an action menu item, adds a sub-menu to the current menu, and makes it the current menu.

### Method
POST

### Endpoint
/api/menu/push-submenu/action

### Parameters
#### Request Body
- **bindItemFunc** (Action<MenuItem>) - Required - A callback to bind the action.

### Response
#### Success Response (200)
- **MenuBuilder** (MenuBuilder) - The MenuBuilder instance.

### Remarks
When the binding callback is invoked, the sub-menu is already pushed on the stack and set on the menu item.

### Request Example
```json
{
  "bindItemFunc": "// Action binding callback"
}
```

### Response Example
```json
{
  "MenuBuilder": "// MenuBuilder object"
}
```
```

--------------------------------

### spacing

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Spacer.html

Gets or sets the spacing configuration for the Spacer element.

```APIDOC
### Property
#### spacing

Gets or sets the spacing value of the spacer.

**Type**: SpacerSpacing
```

--------------------------------

### Build Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Toast.html

Creates a Toast instance associated with a reference VisualElement. Note that Show() must be called separately to display the toast.

```csharp
public static Toast Build(VisualElement referenceView, string text, NotificationDuration duration)
```

--------------------------------

### minValue

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.RangeSliderFloat.html

Gets or sets the low part of the range value.

```APIDOC
## minValue

### Description
The low part of the range value.

### Declaration
```csharp
public float minValue { get; set; }
```
```

--------------------------------

### Host an Application

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.UIToolkitHost.html

Registers an IUIToolkitApp with the host using a provided service provider.

```csharp
public void HostApplication(IUIToolkitApp app, IServiceProvider serviceProvider)
```

--------------------------------

### maxValue

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.RangeSliderFloat.html

Gets or sets the high part of the range value.

```APIDOC
## maxValue

### Description
The high part of the range value.

### Declaration
```csharp
public float maxValue { get; set; }
```
```

--------------------------------

### index

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.PickerItem.html

Gets or sets the index of the item within the collection.

```APIDOC
### Property
#### index

`public int index { get; set; }`

The index of this item in the collection.
```

--------------------------------

### Initialize SearchBar

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.SearchBar.html

Default constructor for creating a new SearchBar instance.

```csharp
public SearchBar()
```

--------------------------------

### ISizeableElement.size

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ISizeableElement.html

Gets or sets the current size of the UI element.

```APIDOC
## Property: size

### Description
Gets or sets the current size of the UI element.

### Declaration
`Size size { get; set; }`

### Property Value
- **Type**: Size
```

--------------------------------

### Implement OnConfiguringApp

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.UIToolkitAppBuilder-1.html

Override this method to configure the application builder instance.

```csharp
protected virtual void OnConfiguringApp(AppBuilder builder)
```

--------------------------------

### SetupDrawer Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavigationScreen.html

Configures the Drawer specifically for the current screen.

```csharp
protected virtual void SetupDrawer(Drawer drawer, NavController controller)
```

--------------------------------

### contentContainer

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.DrawerHeader.html

Gets the container element where child elements are added.

```APIDOC
### Property: contentContainer

#### Description
Gets the VisualElement container where child elements are added.

#### Declaration
`public override VisualElement contentContainer { get; }`

#### Property Value
- **VisualElement** - The container element.
```

--------------------------------

### DateRangePicker.value

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.DateRangePicker.html

Gets or sets the current DateRange value of the picker.

```APIDOC
## Property: value

### Description
The current value of the date picker.

### Declaration
`public DateRange value { get; set; }`

### Property Value
- **Type**: DateRange
```

--------------------------------

### HelpBox(string, AlertSemantic, string)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.HelpBox.html

Initializes a new instance of the HelpBox class with a specified message, semantic variant, and icon.

```APIDOC
## HelpBox(string msg, AlertSemantic variant, string icon)

### Description
Initializes a new instance of the HelpBox class with a message and optional variant.

### Parameters
- **msg** (string) - The message to display.
- **variant** (AlertSemantic) - The semantic variant controlling the color scheme (default: AlertSemantic.Information).
- **icon** (string) - The icon name to display (default: "info").

### Syntax
public HelpBox(string msg, AlertSemantic variant = AlertSemantic.Information, string icon = "info")
```

--------------------------------

### value

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.DatePicker.html

Gets or sets the current value of the date picker.

```APIDOC
## Property: value

### Description
Gets or sets the current value of the date picker.

### Syntax
```csharp
public Date value { get; set; }
```

### Property Value
- **Type**: Date
```

--------------------------------

### Build Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Tray.html

Creates a new instance of a Tray component associated with a reference view and content.

```csharp
public static Tray Build(VisualElement referenceView, VisualElement content)
```

--------------------------------

### innerRadius

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.CircularProgress.html

Gets or sets the inner radius of the CircularProgress element.

```APIDOC
## Property: innerRadius

### Description
The inner radius of the CircularProgress component.

### Type
float

### Access
public float innerRadius { get; set; }
```

--------------------------------

### isExclusive

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Accordion.html

Gets or sets the exclusive expansion behavior of the Accordion.

```APIDOC
## isExclusive

### Description
Determines the behavior of the Accordion when multiple items are open. If set to true, a maximum of one item can be open at a time.

### Syntax
```csharp
public bool isExclusive { get; set; }
```
```

--------------------------------

### ActionBar()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ActionBar.html

Initializes a new instance of the ActionBar class.

```APIDOC
### Constructor

#### ActionBar()

**Description**
Initializes a new instance of the ActionBar class.

**Declaration**
```csharp
public ActionBar()
```
```

--------------------------------

### HostApplication Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.IUIToolkitHost.html

Hosts the application using the provided IUIToolkitApp and IServiceProvider.

```APIDOC
## HostApplication(IUIToolkitApp, IServiceProvider)

Hosts the application.

### Declaration
```csharp
void HostApplication(IUIToolkitApp app, IServiceProvider serviceProvider)
```

### Parameters
| Type            | Name            | Description      |
|-----------------|-----------------|------------------|
| IUIToolkitApp   | app             | The app to host. |
| IServiceProvider| serviceProvider | The service provider to use. |
```

--------------------------------

### DefaultEnhancer<TState>(DefaultEnhancerConfiguration)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.StoreFactory.html

Get the default enhancer for the store.

```APIDOC
## POST /api/users

### Description
Gets the default enhancer for the store.

### Method
POST

### Endpoint
/api/users

### Parameters
#### Path Parameters
- **cfg** (DefaultEnhancerConfiguration) - Optional - The configuration for the default enhancer.

### Request Body
```json
{
  "cfg": {
    "someSetting": "value"
  }
}
```

### Response
#### Success Response (200)
- **enhancer** (StoreEnhancer<TState>) - The default enhancer.

#### Response Example
```json
{
  "enhancer": "function"
}
```
```

--------------------------------

### Initialize UIToolkitHost

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.UIToolkitHost.html

Constructor to create a new instance of UIToolkitHost using a specified UIDocument.

```csharp
public UIToolkitHost(UIDocument uiDocument)
```

--------------------------------

### Get State

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.DevTools.InstrumentedStore-1.html

Returns the current state of type TState.

```csharp
public TState GetState()
```

--------------------------------

### Toolbar()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Toolbar.html

Initializes a new instance of the Toolbar class.

```APIDOC
## Toolbar()

### Description
Constructor for the Toolbar class. Initializes a new instance of the Toolbar visual element.

### Syntax
```csharp
public Toolbar()
```
```

--------------------------------

### IServiceScope.ServiceProvider

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.IServiceScope.html

Gets the service provider associated with the current scope.

```APIDOC
## Property: ServiceProvider

### Description
Gets the service provider for this scope.

### Property Value
- **Type**: IServiceProvider
- **Description**: The service provider instance used for resolving services within this scope.
```

--------------------------------

### AppUIBuildSetup Build Methods

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.AppUIBuildSetup.html

Methods invoked by Unity during the build lifecycle to handle pre- and post-processing tasks.

```csharp
public void OnPostprocessBuild(BuildReport report)
```

```csharp
public void OnPreprocessBuild(BuildReport report)
```

--------------------------------

### Define dragStarted event

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.BaseGridView.html

Triggered when a drag operation has started.

```csharp
public event Action<PointerMoveEvent> dragStarted
```

--------------------------------

### PartitionedState Methods

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.PartitionedState.html

Details the methods available for the PartitionedState class, including Get, Set, OnAfterDeserialize, and OnBeforeSerialize.

```APIDOC
## Methods

### Get<TSliceState>(string)
Implementation of the method to get the slice state from the store state.

#### Declaration
```csharp
public TSliceState Get<TSliceState>(string sliceName)
```

#### Parameters
Type | Name | Description  
---|---|---  
string | sliceName | The name of the slice.

#### Returns
Type | Description  
---|---  
TSliceState | The slice state.

#### Type Parameters
Name | Description  
---|---  
TSliceState | The type of the slice state.

### OnAfterDeserialize()
Implement this method to receive a callback after Unity deserializes your object.

#### Declaration
```csharp
public void OnAfterDeserialize()
```

### OnBeforeSerialize()
Implement this method to receive a callback before Unity serializes your object.

#### Declaration
```csharp
public void OnBeforeSerialize()
```

### Set<TSliceState>(string, TSliceState)
Implementation of the method to set the slice state in the store state.

#### Declaration
```csharp
public PartitionedState Set<TSliceState>(string sliceName, TSliceState sliceState)
```

#### Parameters
Type | Name | Description  
---|---|---  
string | sliceName | The name of the slice.  
TSliceState | sliceState | c The slice state.

#### Returns
Type | Description  
---|---  
PartitionedState | The new store state.

#### Type Parameters
Name | Description  
---|---  
TSliceState | The type of the slice state.

#### Remarks
It is important to note that this method should return a new instance of the store state to ensure immutability.
```

--------------------------------

### Build

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MenuBuilder.html

Creates a MenuBuilder instance, used for initializing a new menu.

```APIDOC
## POST /api/menu/build

### Description
Creates a MenuBuilder instance.

### Method
POST

### Endpoint
/api/menu/build

### Parameters
#### Request Body
- **referenceView** (VisualElement) - Required - The reference view to position the menu.
- **menu** (Menu) - Optional - The menu to display.

### Response
#### Success Response (200)
- **MenuBuilder** (MenuBuilder) - The MenuBuilder instance.

### Exceptions
- **ArgumentNullException**: If `referenceView` is null.

### Request Example
```json
{
  "referenceView": "// VisualElement object",
  "menu": "// Menu object"
}
```

### Response Example
```json
{
  "MenuBuilder": "// MenuBuilder object"
}
```
```

--------------------------------

### Initialize Link Constructors

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Link.html

Constructors for creating a new Link instance with optional text and URL parameters.

```csharp
public Link()
```

```csharp
public Link(string text)
```

```csharp
public Link(string text, string url)
```

--------------------------------

### Toast.Build(VisualElement, string, NotificationDuration)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Toast.html

Builds and returns a new Toast instance. Note that this method does not display the toast immediately; Show() must be called afterwards.

```APIDOC
## Toast.Build(VisualElement, string, NotificationDuration)

### Description
Build and return a Toast UI element. The method will find the best suitable parent view which will contain the Toast element.

### Parameters
- **referenceView** (VisualElement) - Required - An arbitrary VisualElement which is currently present in the UI panel.
- **text** (string) - Required - The raw message or Localization dictionary key for the message to be displayed inside the Toast.
- **duration** (NotificationDuration) - Required - A duration enum value.

### Returns
- **Toast** - The Toast instance, if no exception has occurred.

### Exceptions
- **ArgumentNullException** - If referenceView is null.
```

--------------------------------

### GetPreferredTooltipPlacement(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.VisualElementExtensions.html

Get the preferred placement for a VisualElement's Tooltip.

```APIDOC
## GetPreferredTooltipPlacement(VisualElement)

### Description
Get the preferred placement for a VisualElement's Tooltip.

### Signature
`public static PopoverPlacement GetPreferredTooltipPlacement(this VisualElement element)`

### Parameters
- **element** (VisualElement) - The VisualElement which contains a tooltip.

### Returns
- **PopoverPlacement** - The preferred placement, previously set using SetPreferredTooltipPlacement or the closest value set on an element.

### Exceptions
- **ArgumentNullException** - The VisualElement object can't be null.
```

--------------------------------

### ReactionPicker()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ReactionPicker.html

Initializes a new instance of the ReactionPicker class.

```APIDOC
## ReactionPicker()

### Description
Initializes a new instance of the ReactionPicker class. This is the default constructor for creating a new reaction selection UI element.

### Syntax
```csharp
public ReactionPicker()
```
```

--------------------------------

### pathType

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.UxmlFilePathAttribute.html

Gets the type of path used for loading the UXML file.

```APIDOC
## Property: pathType

### Description
Returns the type of path used for loading, such as AssetDatabase or Resources.

### Declaration
`public UxmlFilePathType pathType { get; }`

### Property Value
- **Type**: UxmlFilePathType
```

--------------------------------

### Slider GetTrackElement method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Slider-3.html

Get the VisualElement representing the slider track.

```csharp
protected override VisualElement GetTrackElement()
```

--------------------------------

### BottomNavBarItem(string, string, Action)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.BottomNavBarItem.html

Initializes a new instance of the BottomNavBarItem class with specified icon, label, and click handler.

```APIDOC
## BottomNavBarItem(string icon, string label, Action clickHandler)

### Description
Constructor that sets the icon, label, and click handler for the navigation item.

### Parameters
- **icon** (string) - The BottomNavBarItem's icon.
- **label** (string) - The BottomNavBarItem's label.
- **clickHandler** (Action) - The BottomNavBarItem's click handler.

### Syntax
```csharp
public BottomNavBarItem(string icon, string label, Action clickHandler)
```
```

--------------------------------

### Scrollable Direction Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Scrollable.html

Gets or sets the scroll direction for the manipulator.

```csharp
public ScrollViewMode direction { get; set; }
```

--------------------------------

### StoryBookStory(string, Func<VisualElement>)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.StoryBookStory.html

Initializes a new instance of the StoryBookStory class.

```APIDOC
## StoryBookStory(string name, Func<VisualElement> createGUI)

### Description
Creates a new story with a specified name and a GUI creation function.

### Parameters
- **name** (string) - The name of the story.
- **createGUI** (Func<VisualElement>) - The function that creates the GUI of the story.
```

--------------------------------

### StackView()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.StackView.html

Initializes a new instance of the StackView class.

```APIDOC
## StackView()

### Description
The constructor of the StackView.

### Declaration
```csharp
public StackView()
```
```

--------------------------------

### gesture

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.PinchGestureEvent.html

Property to get or set the magnification gesture associated with the event.

```APIDOC
### Property
`public PinchGesture gesture { get; set; }`

Gets or sets the PinchGesture object representing the magnification gesture.
```

--------------------------------

### Access the selected property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.NavigationRailItem.html

Gets or sets the selection state of the NavigationRailItem.

```csharp
public bool selected { get; set; }
```

--------------------------------

### SetupBottomNavBar Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavigationScreen.html

Configures the BottomNavBar specifically for the current screen.

```csharp
protected virtual void SetupBottomNavBar(BottomNavBar bottomNavBar, NavController controller)
```

--------------------------------

### Access the icon property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.NavigationRailItem.html

Gets or sets the icon string for the NavigationRailItem.

```csharp
public string icon { get; set; }
```

--------------------------------

### IInstrumentedStore Methods

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.DevTools.IInstrumentedStore.html

Methods for interacting with the store's lifted state and managing subscriptions.

```csharp
LiftedState GetLiftedState()
```

```csharp
IDisposableSubscription Subscribe<TSelected>(Selector<LiftedState, TSelected> selector, Listener<TSelected> listener, SubscribeOptions<TSelected> options = default)
```

```csharp
bool Unsubscribe(ISubscription<LiftedState> subscription)
```

--------------------------------

### Access the clickable property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.NavigationRailItem.html

Gets or sets the Pressable manipulator for the NavigationRailItem.

```csharp
public Pressable clickable { get; set; }
```

--------------------------------

### BeginMacro(string)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Undo.UndoStack.html

Begins composition of a macro command with the given text description. Subsequent commands pushed to the stack are added as children until EndMacro is called.

```APIDOC
## BeginMacro(string)

### Description
Begins composition of a macro command. While a macro is being composed, the stack is disabled and events are not emitted.

### Parameters
- **name** (string) - Required - The name of the macro command.
```

--------------------------------

### Show Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Popup.html

Displays the popup.

```csharp
public virtual void Show()
```

--------------------------------

### ColorWheel Saturation Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ColorWheel.html

Gets or sets the saturation of the color wheel.

```csharp
public float saturation { get; set; }
```

--------------------------------

### ColorWheel Brightness Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ColorWheel.html

Gets or sets the brightness of the color wheel.

```csharp
public float brightness { get; set; }
```

--------------------------------

### InstantiateWith Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AppBuilder.html

Creates a new AppBuilder instance configured with default services for the specified application type.

```csharp
public static AppBuilder InstantiateWith<TApp, THost>() where TApp : class, IApp<THost> where THost : class, IHost
```

--------------------------------

### SubscriptionBase Constructor

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.SubscriptionBase-3.html

Initializes a new subscription with a selector, listener, store, and subscription options.

```csharp
protected SubscriptionBase(Selector<TState, TSelected> selector, Listener<TSelected> listener, TStore store, SubscribeOptions<TSelected> options)
```

--------------------------------

### Get current state

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.Store-1.html

Retrieves the current state tree of the application.

```csharp
public TStoreState GetState()
```

--------------------------------

### Get Lifted State

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.DevTools.InstrumentedStore-1.html

Retrieves the current lifted state of the store.

```csharp
public LiftedState GetLiftedState()
```

--------------------------------

### Build Method

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Tooltip.html

Creates a new Tooltip instance associated with a reference VisualElement.

```csharp
public static Tooltip Build(VisualElement referenceView)
```

--------------------------------

### IsReadOnly

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AppUIServiceCollection.html

Gets or sets a value indicating whether the collection is read-only.

```APIDOC
## Property: IsReadOnly

### Description
Gets or sets a value indicating whether the collection is read-only.

### Declaration
```csharp
public bool IsReadOnly { get; set; }
```

### Property Value
- **bool** - A value indicating whether the collection is read-only.
```

--------------------------------

### DrawerHeader()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.DrawerHeader.html

Initializes a new instance of the DrawerHeader class.

```APIDOC
## DrawerHeader()

### Description
Default constructor for the DrawerHeader visual element.

### Syntax
`public DrawerHeader()`
```

--------------------------------

### Retrieve Display Name

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Editor.StoryBookPage.html

Property to get the display name of the page.

```csharp
public virtual string displayName { get; }
```

--------------------------------

### AsyncRelayCommand Constructors

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AsyncRelayCommand.html

Details on how to initialize the AsyncRelayCommand class.

```APIDOC
## AsyncRelayCommand Constructors

### AsyncRelayCommand(Func<Task>, AsyncRelayCommandOptions)

Initializes a new instance of the AsyncRelayCommand class.

#### Parameters
- **execute** (Func<Task>) - Required - The Func<TResult> to invoke when ExecuteAsync(object?) is called.
- **options** (AsyncRelayCommandOptions) - Required - The AsyncRelayCommandOptions to use.

#### Exceptions
- **ArgumentNullException** - If the execute argument is null.
```

--------------------------------

### isRunning Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AsyncRelayCommand.html

Gets the CancellationTokenSource that can be used to cancel the asynchronous operation.

```csharp
public bool isRunning { get; }
```

--------------------------------

### isCancellationRequested Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AsyncRelayCommand.html

Gets the CancellationTokenSource that can be used to cancel the asynchronous operation.

```csharp
public bool isCancellationRequested { get; }
```

--------------------------------

### UIToolkitHost(UIDocument)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.UIToolkitHost.html

Constructor to initialize a new instance of UIToolkitHost using a specified UIDocument.

```APIDOC
## UIToolkitHost(UIDocument)

### Description
Creates a new instance of UIToolkitHost that hosts an app in the given UIDocument.

### Parameters
- **uiDocument** (UIDocument) - Required - The UIDocument to host the app in.
```

--------------------------------

### executionTask Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AsyncRelayCommand.html

Gets or sets the Task that represents the asynchronous operation.

```csharp
public Task? executionTask { get; set; }
```

--------------------------------

### ActionButton()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ActionButton.html

Initializes a new instance of the ActionButton class.

```APIDOC
### Constructor
#### ActionButton()

### Description
Default constructor for the ActionButton class.
```

--------------------------------

### SetupNavigationRail Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavigationScreen.html

Configures the NavigationRail specifically for the current screen.

```csharp
protected virtual void SetupNavigationRail(NavigationRail navigationRail, NavController controller)
```

--------------------------------

### canBeCancelled Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.MVVM.AsyncRelayCommand.html

Gets the CancellationTokenSource that can be used to cancel the asynchronous operation.

```csharp
public bool canBeCancelled { get; }
```

--------------------------------

### PushSubMenu API

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MenuBuilder.html

Creates an action menu item, adds a sub-menu to the current menu, and makes it the current menu.

```APIDOC
## PushSubMenu(int actionId, string labelStr, string iconName, Action subMenuOpenedCallback)

### Description
Create an action menu item, add a sub-menu to the current menu, and make it the current menu.

### Method
`public MenuBuilder PushSubMenu(int actionId, string labelStr, string iconName, Action subMenuOpenedCallback)`

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Request Example
```json
{
  "actionId": 123,
  "labelStr": "File",
  "iconName": "folder_icon",
  "subMenuOpenedCallback": "() => { /* handle sub-menu opened */ }"
}
```

### Response
#### Success Response (200)
- **MenuBuilder** (MenuBuilder) - The MenuBuilder instance.

#### Response Example
```json
{
  "message": "Sub-menu pushed successfully"
}
```
```

--------------------------------

### FindStartDestination()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavGraph.html

Retrieves the start destination defined for the current NavGraph instance.

```APIDOC
## public NavDestination FindStartDestination()

### Description
Finds and returns the start destination for this NavGraph.

### Returns
- **NavDestination** - The start destination for this NavGraph.
```

--------------------------------

### Access showCaret property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.TreeViewItem.html

Gets or sets whether the caret is shown for this TreeViewItem.

```csharp
public bool showCaret { get; set; }
```

--------------------------------

### Dropdown Constructors

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Dropdown.html

Details on how to create and initialize a Dropdown UI element.

```APIDOC
## Dropdown Constructors

### Dropdown()

#### Description
Default constructor for the Dropdown class.

#### Declaration
```csharp
public Dropdown()
```

### Dropdown(IList, BindItemFunc, BindTitleFunc, int[])

#### Description
Constructs a Dropdown UI element with a provided dynamic collection of items.

#### Declaration
```csharp
public Dropdown(IList items, Picker<DropdownItem, DropdownItem>.BindItemFunc bindItemFunc = null, Picker<DropdownItem, DropdownItem>.BindTitleFunc bindTitleFunc = null, int[] defaultIndices = null)
```

#### Parameters
- **items** (IList) - Required - An items collection.
- **bindItemFunc** (Picker<DropdownItem, DropdownItem>.BindItemFunc) - Optional - The binding function used to populate display data for each item.
- **bindTitleFunc** (Picker<DropdownItem, DropdownItem>.BindTitleFunc) - Optional - The binding function used to populate display data for the title.
- **defaultIndices** (int[]) - Optional - The selected index by default.
```

--------------------------------

### PartitionedState Class Overview

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.PartitionedState.html

Provides an overview of the PartitionedState class, its inheritance, implemented interfaces, and namespace.

```APIDOC
## Class PartitionedState 
A partitioned state. This is the specialization of a state that is partitioned into multiple slices.

### Inheritance
object
Dictionary<string, object>
PartitionedState

### Implements
IDictionary<string, object>
ICollection<KeyValuePair<string, object>>
IReadOnlyDictionary<string, object>
IReadOnlyCollection<KeyValuePair<string, object>>
IEnumerable<KeyValuePair<string, object>>
IDictionary
ICollection
IEnumerable
IDeserializationCallback
ISerializable
IPartionableState<PartitionedState>
IPartionableState
ISerializationCallbackReceiver

### Namespace
Unity.AppUI.Redux

### Assembly
Unity.AppUI.Redux.dll

### Syntax
```csharp
[Serializable]
public class PartitionedState : Dictionary<string, object>, IDictionary<string, object>, ICollection<KeyValuePair<string, object>>, IReadOnlyDictionary<string, object>, IReadOnlyCollection<KeyValuePair<string, object>>, IEnumerable<KeyValuePair<string, object>>, IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable, IPartionableState<PartitionedState>, IPartionableState, ISerializationCallbackReceiver
```
```

--------------------------------

### Access expanded property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.TreeViewItem.html

Gets or sets whether the TreeViewItem is expanded or collapsed.

```csharp
public bool expanded { get; set; }
```

--------------------------------

### onPinch

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.TrackpadGestureManipulator.html

Property to get or set the callback invoked when a pinch gesture is recognized.

```APIDOC
## onPinch

### Description
The callback that will be invoked when a pinch gesture is recognized.

### Syntax
`public Action<PinchGesture> onPinch { get; set; }`
```

--------------------------------

### Meta Constructor

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Redux.Meta-1.html

Initializes a new instance of the Meta class with a specified thunk status.

```csharp
public Meta(ThunkStatus thunkStatus)
```

--------------------------------

### Configure StackView initialItem

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.StackView.html

Sets or gets the initial VisualElement added to the stack.

```csharp
public VisualElement initialItem { get; set; }
```

--------------------------------

### Create a MenuBuilder instance

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MenuBuilder.html

Initializes a new MenuBuilder instance for a specific reference view.

```csharp
public static MenuBuilder Build(VisualElement referenceView, Menu menu = null)
```

--------------------------------

### Panel()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Panel.html

Initializes a new instance of the Panel class.

```APIDOC
## Panel()

### Description
Initializes a new instance of the Panel class. This is the default constructor for creating a new UI panel container.

### Syntax
```csharp
public Panel()
```
```

--------------------------------

### Spacer Spacing Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Spacer.html

Property to get or set the spacing configuration for the Spacer.

```csharp
public SpacerSpacing spacing { get; set; }
```

--------------------------------

### Scrollable Threshold Property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Scrollable.html

Gets or sets the drag threshold, which defaults to 8f.

```csharp
public float threshold { get; set; }
```

--------------------------------

### Badge()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Badge.html

Initializes a new instance of the Badge class.

```APIDOC
## Badge()

### Description
Initializes a new instance of the Badge class.

### Syntax
```csharp
public Badge()
```
```

--------------------------------

### emojiProvider

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ReactionPicker.html

Property to get or set the emoji provider used to populate the grid.

```APIDOC
## public EmojiDatabase emojiProvider { get; set; }

### Description
The emoji provider used to populate the grid.
```

--------------------------------

### HelpBox Default Constructor

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.HelpBox.html

Initializes a new instance of the HelpBox class.

```csharp
public HelpBox()
```

--------------------------------

### Accessing query

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MentionPicker.html

Gets or sets the query string used to filter suggestions.

```csharp
public string query { get; set; }
```

--------------------------------

### Button()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Button.html

Initializes a new instance of the Button class.

```APIDOC
## Button()

### Description
Default constructor for the Button UI element.

### Syntax
```csharp
public Button()
```
```

--------------------------------

### Accessing mentionProvider

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.MentionPicker.html

Gets or sets the provider used to retrieve mention suggestions.

```csharp
public IMentionProvider mentionProvider { get; set; }
```

--------------------------------

### SplitView()

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.SplitView.html

Initializes a new instance of the SplitView class.

```APIDOC
## SplitView()

### Description
Default constructor for the SplitView component.

### Syntax
```csharp
public SplitView()
```
```

--------------------------------

### ISelectableElement.selected

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ISelectableElement.html

A property to get or set the current selected state of the UI element.

```APIDOC
## Property: selected

### Description
Gets or sets the selected state of the UI element. Returns true if the element is selected, false otherwise.

### Declaration
`bool selected { get; set; }`
```

--------------------------------

### ToAppUITouch(Touch)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Core.TouchExtensions.html

Converts a UnityEngine.Touch instance to an AppUITouch instance.

```APIDOC
## ToAppUITouch(Touch)

### Description
Converts a UnityEngine.Touch to an AppUITouch.

### Syntax
`public static AppUITouch ToAppUITouch(this Touch touch)`

### Parameters
- **touch** (Touch) - The UnityEngine.Touch to convert.

### Returns
- **AppUITouch** - The converted AppUITouch.
```

--------------------------------

### Accessing passMask property

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.ExVisualElement.html

Sets or gets the mask of passes to render for the element.

```csharp
public ExVisualElement.Passes passMask { get; set; }
```

--------------------------------

### Tooltip.Build(VisualElement)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.UI.Tooltip.html

Creates a new Tooltip instance associated with a reference VisualElement.

```APIDOC
## public static Tooltip Build(VisualElement referenceView)

### Description
Builds a new Tooltip instance. In the Application element, only one Tooltip is created and moved to the correct position when hovering over other UI elements.

### Parameters
- **referenceView** (VisualElement) - Required - An arbitrary UI element used as reference for the application context to attach to the popup.

### Returns
- **Tooltip** - A Tooltip instance.

### Exceptions
- **ArgumentNullException** - Thrown if `referenceView` is null.
```

--------------------------------

### NavController(NavHost)

Source: https://docs.unity3d.com/Packages/com.unity.dt.app-ui%402.2/api/Unity.AppUI.Navigation.NavController.html

Initializes a new instance of the NavController class associated with a specific NavHost.

```APIDOC
### Constructor: NavController(NavHost)

Initializes a new instance of the NavController class.

#### Parameters
- **navHost** (NavHost) - Required - The NavHost that this NavController is associated with.
```
Tokens:
Raw