https://github.com/Pepsi1x1/XamarinForms.VisualDebug

A library and client app to view the visual heirarchy of your Xamarin app pages as an interactive tree diagram at runtime
https://github.com/Pepsi1x1/XamarinForms.VisualDebug

electron electron-app xamarin xamarin-forms xamarin-library xamarinforms

Last synced: 30 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/Pepsi1x1/XamarinForms.VisualDebug
• Owner: Pepsi1x1
• License: mit
• Created: 2020-09-14T16:06:24.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T14:51:03.000Z (almost 2 years ago)
• Last Synced: 2024-11-04T23:07:06.874Z (about 1 month ago)
• Topics: electron, electron-app, xamarin, xamarin-forms, xamarin-library, xamarinforms
• Language: JavaScript
• Homepage:
• Size: 2.97 MB
• Stars: 22
• Watchers: 5
• Forks: 1
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-xamarin-forms - XamarinForms.VisualDebugger ★22

README

        
# XamarinForms.VisualDebugger

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

![Preview](https://github.com/Pepsi1x1/XamarinForms.VisualDebug/raw/master/final-5f6f58c13e5b3e0061bb6cf9-6.gif "Preview")

# Getting Started

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

```sh

Install-Package XamarinForms.VisualDebug

dotnet add package XamarinForms.VisualDebug

```

## Core project

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

```c#

       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:

```c#

                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

```c#

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

```       

            

## Android

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

```c#

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

```

            

## Electron app

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

```sh

$ cd XamarinForms.VisualDebug.App

# Install dependencies

$ npm install

# Run the app

$ npm start     

```