Class ScaffoldKeyboardState

Namespace

Nalu

Assembly

Nalu.Maui.Scaffold.dll

The live soft-keyboard state of a Scaffold: one observable object per scaffold (KeyboardState), updated from the same platform geometry the keyboard modes react to (iOS keyboardLayoutGuide, Android IME window insets) — per animation frame while the keyboard moves. Bind to it through KeyboardBindingExtension (IsVisible="{nalu:KeyboardBinding IsVisible, Converter={StaticResource Not}}") or KeyboardBindings to collapse, pad or re-arrange content while the keyboard is up, whatever the surface's ScaffoldKeyboardMode.

public sealed class ScaffoldKeyboardState : INotifyPropertyChanged

Inheritance

object

ScaffoldKeyboardState

Implements

INotifyPropertyChanged

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Height

Gets the keyboard's overlap with the window's bottom edge, in device-independent units: 0 while hidden, the running value while it animates, the resting height when shown (iOS: accessory bar included). This is the amount the keyboard modes resize/pan by.

public double Height { get; }

Property Value

double

IsVisible

Gets a value indicating whether the soft keyboard currently overlaps the window (Height > 0). On iOS a connected hardware keyboard still shows the input accessory bar, which counts as visible.

public bool IsVisible { get; }

Property Value

bool

Events

PropertyChanged

Occurs when a property value changes.

public event PropertyChangedEventHandler? PropertyChanged

Event Type

PropertyChangedEventHandler