README.md

XamarinForms.VisualDebugger

A library and client app to view the visual heirarchy of your Xamarin app pages as an interactive tree diagram at runtime

Getting Started

Install the XamarinForms.VisualDebug Nuget packages into your Core AND platform specific projects

Install-Package XamarinForms.VisualDebug
dotnet add package XamarinForms.VisualDebug

Core project

For the simplest use case in App.xaml.cs include the following

       public App()
        {
            InitializeComponent();

            MainPage = new NavigationPage(new MainPage());

            //Add this line
            Current.PageAppearing += Current_PageAppearing;
        }

        private void Current_PageAppearing(object sender, Page e)
        {
            XamarinForms.VisualDebug.Core.Utility.RenderAndSend(e);
        }

To use the iOS simulator, the Xamarin app needs to know the IP address of the computer running the client app, wither provide that as the second argument to Sender.SendToServer manually, or there is a helper you can include in your core project which tries to work out the IP at compile time:

https://github.com/Pepsi1x1/XamarinForms.VisualDebug/blob/master/XamarinForms.VisualDebug/XamarinForms.VisualDebug/IPConstant.tt

and the following snippet consumes that:

                string ip = string.Empty;
                // Only needed on iOS, a null or empty string passed in uses the platform default for android internally 10.0.2.2 or 127.0.0.1 on other platforms
                if (Xamarin.Forms.Device.RuntimePlatform == Xamarin.Forms.Device.iOS)
                {
                    ip = XamarinForms.VisualDebug.Constants.IPConstant.LocalIP;
                }

                XamarinForms.VisualDebug.Core.Utility.RenderAndSend(e, ip);

iOS

Add the following line to FinishedLaunching in AppDelegate.cs somehwher after the Xamarin.Forms.Forms.Init call

            XamarinForms.VisualDebug.iOS.VisualDebug.Init();

Android

Add the following line to FinishedLaunching in AppDelegate.cs somehwher after the Xamarin.Forms.Forms.Init call

            XamarinForms.VisualDebug.Droid.VisualDebug.Init();

Electron app

Run the client before starting the simluator/emulator for your Xamarin app

$ cd XamarinForms.VisualDebug.App
# Install dependencies
$ npm install
# Run the app
$ npm start