Class ContextProvider

A container component that provides contextual settings to its children in the UI hierarchy.

Inheritance
object
CallbackEventHandler
Focusable
VisualElement
BaseVisualElement
ContextProvider
Implements
Inherited Members
VisualElement.Focus()
VisualElement.Overlaps(Rect)
VisualElement.ToString()
VisualElement.TryGetBinding(BindingId, out Binding)
VisualElement.TryGetDataSourceContext(BindingId, out DataSourceContext)
VisualElement.TryGetLastBindingToUIResult(in BindingId, out BindingResult)
VisualElement.TryGetLastBindingToSourceResult(in BindingId, out BindingResult)
VisualElement.GetFirstOfType<T>()
VisualElement.GetFirstAncestorOfType<T>()
VisualElement.canGrabFocus
VisualElement.focusController
VisualElement.cacheAsBitmap
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallbackOnce<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, TrickleDown)
CallbackEventHandler.RegisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.RegisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TUserArgsType, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType>(EventCallback<TEventType>, CallbackOptions)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, TrickleDown)
CallbackEventHandler.UnregisterCallback<TEventType, TUserArgsType>(EventCallback<TEventType, TUserArgsType>, CallbackOptions)
CallbackEventHandler.NotifyPropertyChanged(in BindingId)
Namespace: Unity.AppUI.UI
Assembly: Unity.AppUI.dll
Syntax
[UxmlElement]
public class ContextProvider : BaseVisualElement, IEventHandler, IResolvedStyle, ITransform, ITransitionAnimations, IExperimentalFeatures, IVisualElementScheduler, IContextOverrideElement, IAdditionalDataHolder
Remarks

The ContextProvider is a powerful layout component that allows you to override various UI settings for a specific section of your interface. It acts as a wrapper around UI elements, providing contextual configurations that affect all child elements within its scope.

This component is particularly useful when you need to create isolated sections of your UI with different themes, scales, languages, or layout directions without affecting the rest of the application.

Note: The ContextProvider's picking mode is set to ignore by default, meaning it won't intercept any pointer events. This allows events to pass through to its children.

Examples

Here are some common usage examples of the ContextProvider component. Creating a dark-themed modal dialog:

<ContextProvider theme="dark" scale="medium">
    <Dialog>
        <Header text="Dark Theme Dialog" />
        <Content>
            <Label text="This entire dialog uses dark theme styling" />
        </Content>
        <Footer>
            <Button text="Close" />
        </Footer>
    </Dialog>
</ContextProvider>

Setting up a multilingual section with RTL support.

<ContextProvider lang="ar-SA" dir="Rtl">
    <Panel class="form-section">
        <TextField label="الاسم" />
        <TextField label="البريد الإلكتروني" />
        <Button text="إرسال" />
    </Panel>
</ContextProvider>

Creating a larger scale section for improved accessibility.

<ContextProvider scale="large" tooltip-delay-ms="0">
    <Panel class="accessibility-section">
        <Label text="Larger Text for Better Visibility" />
        <Button text="Easy to Click" tooltip="Instant tooltip" />
    </Panel>
</ContextProvider>

Constructors

ContextProvider()

Default constructor.

Declaration
public ContextProvider()

Fields

ussClassName

Main Uss Class Name.

Declaration
public const string ussClassName = "appui-context-provider"
Field Value
Type Description
string

Implements

Extension Methods