Class ScaffoldArea

Namespace

Nalu

Assembly

Nalu.Maui.Scaffold.dll

A destination group holding one or more ScaffoldRoots, each hosting an independent navigation stack. A plain area has no visible root switcher: with a single root it is a plain page host; with multiple roots, switching happens through navigation. ScaffoldTabBar derives from it to add a tab UI.

[ContentProperty("Roots")]
public class ScaffoldArea : Element, INotifyPropertyChanged, IElementController, IVisualTreeElement, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IElement

Inheritance

object

BindableObject

Element

ScaffoldArea

Implements

INotifyPropertyChanged

IElementController

IVisualTreeElement

IEffectControlProvider

IToolTipElement

IContextFlyoutElement

IElement

Derived

ScaffoldTabBar

Inherited Members

Element.AutomationIdProperty

Element.ClassIdProperty

Element.InsertLogicalChild(int, Element)

Element.AddLogicalChild(Element)

Element.RemoveLogicalChild(Element)

Element.ClearLogicalChildren()

Element.FindByName(string)

Element.RemoveDynamicResource(BindableProperty)

Element.SetDynamicResource(BindableProperty, string)

Element.OnBindingContextChanged()

Element.OnChildAdded(Element)

Element.OnChildRemoved(Element, int)

Element.OnParentSet()

Element.OnPropertyChanged(string)

Element.OnParentChanging(ParentChangingEventArgs)

Element.OnParentChanged()

Element.OnHandlerChanging(HandlerChangingEventArgs)

Element.OnHandlerChanged()

Element.MapAutomationPropertiesIsInAccessibleTree(IElementHandler, Element)

Element.MapAutomationPropertiesExcludedWithChildren(IElementHandler, Element)

Element.AutomationId

Element.ClassId

Element.Effects

Element.Id

Element.StyleId

Element.Parent

Element.Handler

Element.ChildAdded

Element.ChildRemoved

Element.DescendantAdded

Element.DescendantRemoved

Element.ParentChanging

Element.ParentChanged

Element.HandlerChanging

Element.HandlerChanged

BindableObject.BindingContextProperty

BindableObject.ClearValue(BindableProperty)

BindableObject.ClearValue(BindablePropertyKey)

BindableObject.GetValue(BindableProperty)

BindableObject.IsSet(BindableProperty)

BindableObject.RemoveBinding(BindableProperty)

BindableObject.SetBinding(BindableProperty, BindingBase)

BindableObject.ApplyBindings()

BindableObject.OnPropertyChanging(string)

BindableObject.UnapplyBindings()

BindableObject.SetValue(BindableProperty, object)

BindableObject.SetValue(BindablePropertyKey, object)

BindableObject.CoerceValue(BindableProperty)

BindableObject.CoerceValue(BindablePropertyKey)

BindableObject.Dispatcher

BindableObject.BindingContext

BindableObject.PropertyChanged

BindableObject.PropertyChanging

BindableObject.BindingContextChanged

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ScaffoldElementExtensions.GetScaffold(IElement)

ScaffoldElementExtensions.GetScaffoldOrDefault(IElement)

Remarks

Areas carry no route identity of their own: absolute navigation is type-based and resolves the destination from the roots' PageType registrations.

Constructors

ScaffoldArea()

Initializes a new ScaffoldArea.

public ScaffoldArea()

Fields

CurrentRootProperty

Bindable property for CurrentRoot (read-only).

public static readonly BindableProperty CurrentRootProperty

Field Value

BindableProperty

IsSelectedProperty

Bindable property for IsSelected (read-only).

public static readonly BindableProperty IsSelectedProperty

Field Value

BindableProperty

TitleProperty

Bindable property for Title.

public static readonly BindableProperty TitleProperty

Field Value

BindableProperty

Properties

CurrentRoot

Gets the selected root (defaults to the first root). Read-only: selection changes only through the Nalu navigation engine (absolute navigation or tab/flyout interaction), so lifecycle events and leaving guards can never be bypassed. Observable via binding. Each root preserves its navigation stack while unselected.

public ScaffoldRoot? CurrentRoot { get; }

Property Value

ScaffoldRoot

IsSelected

Gets whether this area is the scaffold's CurrentArea. Read-only, updated by the navigation engine; observable via binding — the styling hook for flyout templates (highlight state).

public bool IsSelected { get; }

Property Value

bool

Roots

Gets the root destinations owned by this area.

public IList<ScaffoldRoot> Roots { get; }

Property Value

IList<ScaffoldRoot>

Title

Gets or sets the display title used by the default flyout template as the group header of a multi-root area. Icons live on the roots (Icon) — an area deliberately carries text-only metadata.

public string? Title { get; set; }

Property Value

string

Operators

implicit operator ScaffoldArea(ScaffoldRoot)

Wraps a standalone root into a single-root ScaffoldArea, enabling the terse form <nalu:ScaffoldRoot PageType="..." /> directly inside a Scaffold. Composition happens once at conversion time — the resulting structure is real and is never mutated afterwards.

public static implicit operator ScaffoldArea(ScaffoldRoot root)

Parameters

root ScaffoldRoot

The root to wrap.

Returns

ScaffoldArea