Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

Codexcite.Reloader

Lightweight library for "live reloading" XAML pages in Xamarin.Forms on Android, UWP and iOS. Allows simultaneous updating of multiple connected clients - great if you need to see the impact of your changes instantly on different platforms.

Sample GIF

Similar to Xamarin LiveReload that unfortunately was discontinued and stopped working for me after updating to Xamarin.Forms 3.5.

Usage

Codexcite.Reloader.Monitor

Acts as a TCP server and monitors a specific folder (and sub-folders) for changes to .xaml files. Sends update notifications to the connected clients upon file changes. Update: now the Visual Studio extension is available, check below for details.

  • Download and build the project
  • Open command line at the Codexcite.Reloader.Monitor.Console\bin[platform] location
  • Run the program
dotnet .\Codexcite.Reloader.Monitor.Console.dll -path [PATH] -host [HOST] -port [PORT]

Parameters:

  • -path : the folder containing the .xaml files to be monitored. Default: Environment.CurrentDirectory
  • -host : the IP address for the SignalR server. Default: the first available internal network IP address.
  • -port : the port number for the SignalR server. Default: 5500.

Codexcite.Reloader.Forms

Runs inside the Xamarin.Forms app, connects to the Codexcite.Reloader.Monitor server. Updates the XAML for the current displayed page upon receiving notifications from the server.

  • Download and build the project
  • Reference the project or the resulting .dll in your Xamarin.Forms .Net Standard project. Or, use the nuget Codexcite.Reloader.Forms NuGet
  • Recommended to use a Debug condition with your package reference
<PackageReference Condition="'$(Configuration)'=='Debug'" Include="Codexcite.Reloader.Forms" Version="1.2.1" />
  • On Android, if you get a build error Can not resolve reference: System.Threading.Tasks.Extensions, referenced by System.Reactive, it is a known issue when referencing a .Net Standard 2.0 library that uses System.Reactive. Fix: add this to your Android .csproj file:
  <ItemGroup>
    ... other package references here
    <PackageReference Include="System.Runtime.CompilerServices.Unsafe" Version="4.5.2" />
  </ItemGroup>
  <ItemGroup>
    <Reference Include="System.Threading.Tasks.Extensions">
    <HintPath>$(UserProfile)\.nuget\packages\system.threading.tasks.extensions\4.5.2\lib\netstandard2.0\System.Threading.Tasks.Extensions.dll</HintPath>
    </Reference>
  </ItemGroup>
  • Initialize the Reloader in your Xamarin.Forms.Application, using the same url that you configured for the Codexcite.Reloader.Monitor.
public App()
{
#if DEBUG
  Reloader.Forms.Reloader.Init("[your local ip here]", 5500);
#endif

  // normal initialization here
  InitializeComponent();

  MainPage = new NavigationPage(new MainPage());
}
  • On the UWP project, enable the "Private Networks (Client and Server)" capability in the Package.appxmanifest.

Codexcite.Reloader.Monitor Visual Studio extension

  • Download from the MS Marketplace, or use the local .vsix file, or download and build the .VSIX project.
  • Install in Visual Studio
  • (Optional) Enable the Reload Monitor toolbar
  • Start the Reloader Monitor from the Tools menu option or from the Toolbar option.
  • Select the path to the .xaml files to be monitored. Choose your server IP and port. Start dialog
  • Click "Start". You'll be able to see notifications about client connections in the Output -> Debug window. Output window
  • Run your apps, making sure you use the same IP and port for Reloader.Init().

Remarks

  • Tested on UWP and Android so far, but it should work on iOS too.
  • The Xaml updating is pretty basic so far:
    • UPDATE 1.0.1 Now handling updates to other pages and caching the updated xaml for future reuse.
    • Upon updating the xaml for the page, the Page.Dissapearing and Page.Appearing events are forced triggered, so any initial setup code you have in the page code behind can be run again. Worked well with ReactiveUI WhenActivated.
    • Only handled the NavigationPage with ContentPages case so far, still pending for other Page types.
    • UPDATE 1.0.2 Now also handling updates for the App.xaml Resources, like control styles. Sample GIF
    • UPDATE 1.1.0 Removed dependency on SignalR, using a simple TcpListener / TcpClient connection now.
    • UPDATE 1.2.2 Having problems keeping the TcpClient's Socket alive on Android (it dies after ~1 minute, even with pinging going on every 5 seconds. Fixed for now by forcing a reconnect every 30 seconds. Help on this would be appreciated.

License

The MIT License (MIT) see License file

Contributing

Please feel free to add Issues or Pull Requests.

About

Lightweight library for "live reloading" XAML pages in Xamarin.Forms on Android, UWP and iOS.

Topics

Resources

License

Releases

No releases published

Packages

No packages published

Languages

You can’t perform that action at this time.