This repo has the experimental .NET MAUI HybridWebView control, which enables hosting arbitrary HTML/JS/CSS content in a WebView and enables communication between the code in the WebView (JavaScript) and the code that hosts the WebView (C#/.NET). For example, if you have an existing React JS application, you could host it in a cross-platform .NET MAUI native application, and build the back-end of the application using C# and .NET.
Example usage of the control:
<hwv:HybridWebView
HybridAssetRoot="hybrid_root"
MainFile="hybrid_app.html"
RawMessageReceived="OnHybridWebViewRawMessageReceived" />And here's how .NET code can call a JavaScript method:
var sum = await myHybridWebView.InvokeJsMethodAsync<int>("JsAddNumbers", 123, 456);And the reverse, JavaScript code calling a .NET method:
HybridWebView.SendInvokeMessageToDotNet("CallMeFromScript", ["msg from js", 987]);In addition to method invocation, sending "raw" messages is also supported.
Projects in this repo:
- HybridWebView --> a cross-platform .NET MAUI control that can load static web assets (HTML, JS, CSS, etc.) and send messages between JavaScript and .NET
- MauiCSharpInteropWebView --> a sample app that shows the basic functionality of sending messages and calling methods between JavaScript and .NET
- MauiReactJSHybridApp --> a sample app that incorporates a pre-existing React-based todo application into a .NET MAUI cross-platform application
See the main discussion topic here: dotnet/maui#12009
Or please log an issue in this repo for any other topics.
To get started, you'll need a .NET MAUI 7 project, then add the HybridWebView control, and add some web content to it.
Note: If you'd like to check out an already completed sample, go to https://github.com/Eilon/SampleMauiHybridWebViewProject
- Ensure you have Visual Studio 2022 with the .NET MAUI workload installed
- Create a .NET MAUI App project that targets .NET 7 (or use an existing one)
- Add a reference to the
EJL.MauiHybridWebViewpackage:- Right-click on the Dependencies node in Solution Explorer and select Manage NuGet Packages
- Select the Browse tab
- Ensure the Include prerelease checkbox is checked
- In the search box enter
ejl.mauihybridwebview - Select the matching package, and click the Install button
- Register and add the
HybridWebViewcontrol to a page in your app:- In
MauiProgram.csadd the linebuilder.Services.AddHybridWebView();to register theHybridWebViewcomponents - Open the
MainPage.xamlfile - Delete the
<ScrollView>control and all of its contents - Add a
xmlns:ejl="clr-namespace:HybridWebView;assembly=HybridWebView"declaration to the top-level<ContentPage ....>tag - Add the markup
<ejl:HybridWebView HybridAssetRoot="hybrid_root" MainFile="index.html" RawMessageReceived="OnHybridWebViewRawMessageReceived" />inside the<ContentPage>tag - Open the
MainPage.xaml.csfile - Delete the
countfield, and theOnCounterClickedmethod, and replace it with the following code:private async void OnHybridWebViewRawMessageReceived(object sender, HybridWebView.HybridWebViewRawMessageReceivedEventArgs e) { await Dispatcher.DispatchAsync(async () => { await DisplayAlert("JavaScript message", e.Message, "OK"); }); }
- In
- Now add some web content to the app:
- In Solution Explorer expand the Resources / Raw folder
- Create a new sub-folder called
hybrid_root - In the
hybrid_rootfolder add a new file calledindex.htmland replace its contents with:<!DOCTYPE html> <html lang="en" xmlns="http://www.w3.org/1999/xhtml"> <head> <meta charset="utf-8" /> <title></title> <script src="_hwv/HybridWebView.js"></script> <script src="myapp.js"></script> </head> <body> <div> Your message: <input type="text" id="messageInput" /> </div> <div> <button onclick="SendMessageToCSharp()">Send to C#!</button> </div> </body> </html>
- In the same folder add another file
myapp.jswith the following contents:function SendMessageToCSharp() { var message = document.getElementById('messageInput').value; HybridWebView.SendRawMessageToDotNet(message); }
- You can now run your .NET MAUI app with the HybridWebView control!
- You can run it on Windows, Android, iOS, or macOS
- When you launch the app, type text into the textbox and click the button to receive the message in C# code
To run this app you need to have Visual Studio for Windows or Mac, including the .NET MAUI workload. Then clone this repo, open the solution, and run one of the sample projects.
The MauiReactJSHybridApp sample contains portions of a pre-existing Todo App built using React JS.
The original React JS Todo app sample used here is based on this sample: https://github.com/mdn/todo-react. I created a fork at https://github.com/Eilon/todo-react that incorporates some small changes to call the .NET API from JavaScript to synchronize the Todo list between the two parts of the app.
To make changes to the fork and update the .NET MAUI app, here's what I do:
- Clone of the forked repo and open a terminal/console window in that folder
- Run
yarnto ensure the JavaScript dependencies are installed - Run
set PUBLIC_URL=/to establish the root of the app as/because that's the root of the .NET MAUI HybridWebView app - Run
npm run buildto compile the app and produce a static version of it- If you get this error:
Error: error:0308010C:digital envelope routines::unsupported - Then run
set NODE_OPTIONS=--openssl-legacy-provider - And run this again:
npm run build
- If you get this error:
- This will build the HTML/JS/CSS output into a new
./buildfolder - Go to the
MauiReactJSHybridApp'sResources/Raw/ReactTodoAppfolder and delete all the existing files, and replace with the files from the previous step's./buildfolder - Then run the MauiReactJSHybridApp from Visual Studio
This project is licensed under the MIT License. However, portions of the incorporated source code may be subject to other licenses:
- The
MauiReactJSHybridApp/Resources/Raw/ReactTodoAppfolder is the output of a build from https://github.com/Eilon/todo-react, which is a modified fork of https://github.com/mdn/todo-react, which is licensed under the Mozilla Public License 2.0.