TabTip.Avalonia 0.4.0

<p align="center"> <img src="icon.png" width="25%" style="max-width: 150px;" /> </p>

Tabtip.Avalonia (Tablet Text Input Panel)

Avalonia-based and cross-platform re-imagining of WPFTabTip that came to be after I stumbled upon this discussion in the Avalonia repo

Usage

Just Install the NuGet package and decide whether you want to use the Global Integration or the Targeted Integration.

Gloabl Integration

Add the following to App.xaml.cs:

// At the top of your  file
using TabTip.Avalonia;

// ... start of App.xaml.cs

public override void OnFrameworkInitializationCompleted()
{
    // ...

    // Integrate the tabtip manager into the entire app.
    TabTipManager.Integrate(); // (defaults to `true` for the `Integrate(bool global)` parameter.)

    // ...
}

This will integrate the TabTipManager into the entire app, causing it to trigger the TabTip for any TextBox that is clicked.

Targeted Integration

Just like for the Global Integration, we need to add a line to App.xaml.cs, but this time, we pass in false for the global parameter. This will only integrate the TabTipManager but prevent it from triggering the TabTip indiscriminately for any TextBox that is clicked:

// At the top of your  file
using TabTip.Avalonia;

// ... start of App.xaml.cs

public override void OnFrameworkInitializationCompleted()
{
    // ...

    // Integrate the tabtip manager into the entire app but don't trigger unless a textbox is registered.
    TabTipManager.Integrate(false);

    // ...
}

Once the TabTipManager has been integrated into the app, you only need to explicitly register the TextBox that you want to trigger the TabTip for. This can be done by calling TabTipManager.Register(TextBox) as follows:

// In this example, this is inside of a `Control`, so we need to override `OnApplyTemplate`
// to register the TextBox so that we're sure that it has been initialized.
protected override void OnApplyTemplate(TemplateAppliedEventArgs e)
{
    base.OnApplyTemplate(e);
    
    TabTipManager.Register(IntegratedTextBox);
    
    // Even though `NumericUpDown` is not itself a TextBox, we can still register it as the `Register` command will allow
    // any child TextBox of the registered control to trigger the TabTip. This applies to any control.
    TabTipManager.Register(IntegratedNumericUpDown);
}

Software Keyboard Trigger

By default, the software keyboard is only opened if the PointerType used when clicking is either PointerType.Touch or PointerType.Pen. If you would like to use any other setting, provide an array of PointerTypes that you want to trigger the software keyboard as below:

// Trigger on all pointer types.
TabTipManager.OverrideIntegrationTrigger([PointerType.Touch, PointerType.Mouse, PointerType.Pen]);

TabTip Factory

The ITabTipFactory interface allows you to provide your own implementation of the ITabTip interface, giving you the flexibility to create it based on which OS the host is running on. The current default is DefaultTabTipFactory which creates a TabTip instance for Windows or, if not running on Windows, simply creates a NullTabTip instance, which has an empty Toggle method so that we don't do anything on other OSs.

Overriding TabTip Factory

To override the default factory, provide an implementation of ITabTipFactory to TabTipManager.OverrideTabTipFactory as follows:

TabTipManager.OverrideTabTipFactory(myCustomFactory);

This will change the factory used and set the TabTip used by the manager to the one returned by myCustomFactory.

TabTip

The TabTip is the platform-specific implementation of the ITabTip interface. It is responsible for opening and closing the software keyboard. We currently have only two built-in implementations:

• NullTabTip: Does nothing.
• WindowsTabTip: Contains logic to open the Software Keyboard on Windows.

Overriding TabTip

The recommended way to override the TabTip used it to override the ITabTipFactory as described above.

TabTip Integration

The ITabTipIntegration interface defines the methods used to integrate the TabTip into the application. The implementing class is responsible for when to trigger the TabTip as well as setting up the appropriate event handlers to know when a TextBox has been clicked.

Overriding TabTip Integration

Before fully replacing the default integration, it is recommended to override the TabTipIntegration class. The Integrate method is purposefully virtual so that it can be overridden. Simply create a new class that inherits from TabTipIntegration and override the Integrate method. If you specifically call base.Integrate() in your override, it will call the default implementation of Integrate which will set up the default event handlers while allowing you to add any new ones you want. This is useful if all you want to do is integrate controls other than TextBox.

Regardless of whether you create a brand new class that implements ITabTipIntegration or extends TabTipIntegration, you need to set it as the one that is used by calling:

TabTipManager.OverrideIntegration(myCustomIntegration);

OS Support

Why the name TabTip?

"TabTip" refers to the Touch Keyboard and Handwriting Panel, also known as the Tablet Text Input Panel, which is a virtual keyboard in Windows. Since this project was heavily inspired by the WPF version, the name is also inspired by the WPF version.

Roadmap (non-binding 🙃)

1. Make it possible to detect if a Hardware Keyboard is connected.
2. Add a method like Integrate which allows us to specify a specific control so that it integrates it and all its children only.
   • ex: Integrate(MyCustomControlReference) would trigger for that control and all its children, but not any other controls in the app.
3. Add an AttachedProperty or something that will integrate the control it's attached to. Not sure if this is an attached property or not but basically, the same way ToolTip works.
4. Add code to add the relevant interfaces/classes to DI using Microsoft.Extensions.DependencyInjection
5. Add support for Linux?