Class ScaffoldRoot

Namespace

Nalu

Assembly

Nalu.Maui.Scaffold.dll

A root destination hosting an independent navigation stack: the root page (created lazily from PageType through the Nalu navigation engine — own DI scope, page-model lifecycle, destroyable while not displayed) plus the pages pushed onto it, preserved while the root is not selected. Its identity in absolute navigation derives from the page type.

public class ScaffoldRoot : Element, INotifyPropertyChanged, IElementController, IVisualTreeElement, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IElement

Inheritance

object

BindableObject

Element

ScaffoldRoot

Implements

INotifyPropertyChanged

IElementController

IVisualTreeElement

IEffectControlProvider

IToolTipElement

IContextFlyoutElement

IElement

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)

Fields

CurrentIconProperty

Bindable property for CurrentIcon (read-only).

public static readonly BindableProperty CurrentIconProperty

Field Value

BindableProperty

IconProperty

Bindable property for Icon.

public static readonly BindableProperty IconProperty

Field Value

BindableProperty

IsSelectedProperty

Bindable property for IsSelected (read-only).

public static readonly BindableProperty IsSelectedProperty

Field Value

BindableProperty

IsVisibleProperty

Bindable property for IsVisible.

public static readonly BindableProperty IsVisibleProperty

Field Value

BindableProperty

SelectedIconProperty

Bindable property for SelectedIcon.

public static readonly BindableProperty SelectedIconProperty

Field Value

BindableProperty

TitleProperty

Bindable property for Title.

public static readonly BindableProperty TitleProperty

Field Value

BindableProperty

Properties

CurrentIcon

Gets the icon the chrome should currently display: SelectedIcon while selected (when set), Icon otherwise. Read-only, recomputed whenever IsSelected, Icon or SelectedIcon change — bind tab templates directly to it.

public ImageSource? CurrentIcon { get; }

Property Value

ImageSource

Icon

Gets or sets the icon used by the default tab bar template.

public ImageSource? Icon { get; set; }

Property Value

ImageSource

IsSelected

Gets whether this root is its owning area's CurrentRoot. Read-only, updated by the navigation engine; observable via binding — the styling hook for tab templates (highlight state, SelectedIcon swap).

public bool IsSelected { get; }

Property Value

bool

IsVisible

Gets or sets whether this destination is shown by the chrome. Defaults to true. A non-visible root is omitted from the default tab bar / flyout templates, but its route stays fully navigable (programmatic and absolute navigation still work).

public bool IsVisible { get; set; }

Property Value

bool

PageType

Gets or sets the root page type — the page, or its registered page-model type (AddPage/AddPages). Required: scaffold initialization throws when unset.

[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicConstructors)]
public Type? PageType { get; set; }

Property Value

Type

SelectCommand

Gets the parameterless command selecting this root through the navigation engine (preserved-stack restore, active-root-pops-to-root, guards always run) — the selection hook for custom tab bar and flyout templates alike: with the root as binding context, Command="{Binding SelectCommand}" is all a template needs. CanExecute is false while ANY selection on the owning scaffold is navigating (all roots' commands disable together, so a second tap can't race the first) and the command no-ops while the root is not part of a presented Scaffold.

public ICommand SelectCommand { get; }

Property Value

ICommand

SelectedIcon

Gets or sets the icon used by the default tab bar template while this root is selected (e.g. the filled variant of Icon). Falls back to Icon when not set.

public ImageSource? SelectedIcon { get; set; }

Property Value

ImageSource

Title

Gets or sets the display title used by the default tab bar template.

public string? Title { get; set; }

Property Value

string