Go to file
Javier Suárez Ruiz cc0518f95a Added Ooui Forms Status Documentation 2018-03-15 20:44:44 +01:00
.vscode Don't show test build status 2017-06-19 00:15:48 -07:00
Documentation Added Ooui Forms Status Documentation 2018-03-15 20:44:44 +01:00
Ooui Fix compiler warnings 2018-03-13 17:59:47 -07:00
Ooui.AspNetCore Add WebAssembly session 2018-03-09 15:14:51 -08:00
Ooui.Forms Remove PCL support 2018-03-13 17:56:11 -07:00
Ooui.Wasm Fix build dist paths 2018-03-13 15:58:18 -07:00
Ooui.Wasm.Build.Tasks Add charset to wasm HTML 2018-03-13 16:49:21 -07:00
PlatformSamples/AspNetCoreMvc Fix the sample home page 2018-02-02 23:00:24 -08:00
PlatformTests Add Android presentation to a web view 2017-07-07 18:04:09 -07:00
Samples Stop using XAML for editor sample 2018-03-12 20:56:12 -07:00
Templates Created basic project template and VSIX 2018-01-17 21:26:52 +01:00
Tests Use new WriteJson method in Sessions 2018-03-09 18:51:59 -08:00
.editorconfig Update styling 2017-11-09 12:34:08 -08:00
.gitignore Add Ooui.Wasm package 2018-03-13 14:44:35 -07:00
.gitmodules Add linker to wasm build task 2018-03-13 13:16:59 -07:00
LICENSE Add MIT license 2017-06-13 18:12:27 -07:00
Ooui.sln Implement the wasm build task 2018-03-13 00:59:33 -07:00
README.md Added Ooui Forms Status Documentation 2018-03-15 20:44:44 +01:00
ooui.service Update the service to always restart 2017-12-09 15:50:59 -08:00

README.md

Ooui Web Framework Build Status

Version Package Description
NuGet Package Ooui Core library with HTML elements and a server
NuGet Package Ooui.AspNetCore Integration with ASP.NET Core
NuGet Package Ooui.Forms Xamarin.Forms backend using Ooui (Status)
NuGet Package Ooui.Wasm Package your app into a web assembly

Ooui (pronounced weee!) is a small cross-platform UI library for .NET that uses web technologies.

It presents a classic object-oriented UI API that controls a dumb browser. With Ooui, you get the full power of your favorite .NET programming language plus the ability to interact with your app using any device.

Try it Online

Head on over to http://ooui.mecha.parts to tryout the samples.

You can also load https://s3.amazonaws.com/praeclarum.org/wasm/ooui-sample.html to try the WebAssembly mode of Ooui running Xamarin.Forms. (That's Xamarin.Forms running right in your browser!)

Try the Samples Locally

git clone git@github.com:praeclarum/Ooui.git
cd Ooui

dotnet restore
msbuild
dotnet run --project Samples/Samples.csproj --no-build

(There is currently an issue with Xamarin.Forms and building from the dotnet cli, so for now we use the msbuild command and then set the --no-build flag on dotnet run but this will eventually change when the issue is resolved.)

This will open the default starting page for the Samples. Now point your browser at http://localhost:8080/shared-button

You should see a button that tracks the number of times it was clicked. The source code for that button is shown in the example below.

Example App

Here is the complete source code to a fully collaborative button clicking app.

using System;
using Ooui;

class Program
{
    static void Main(string[] args)
    {
        // Create the UI
        var button = new Button("Click me!");

        // Add some logic to it
        var count = 0;
        button.Click += (s, e) => {
            count++;
            button.Text = $"Clicked {count} times";
        };

        // Publishing makes an object available at a given URL
        // The user should be directed to http://localhost:8080/shared-button
        UI.Publish ("/shared-button", button);

        // Don't exit the app until someone hits return
        Console.ReadLine ();
    }
}

Make sure to add a reference to Ooui before you start running!

dotnet add package Ooui
dotnet run

With just that code, a web server that serves the HTML and web socket logic necessary for an interactive button will start.

The Many Ways to Ooui

Ooui has been broken up into several packages to increase the variety of ways that it can be used. Here are some combinations to help you decide which way is best for you.

OouiOoui.AspNetCoreOoui.FormsOoui.Wasm
Web DOM with the built-in web server
Web DOM with ASP.NET Core
Xamarin.Forms with ASP.NET Core
Xamarin.Forms with the built-in web server
Web DOM with Web Assembly
Xamarin.Forms with Web Assembly

How it works

When the user requests a page, the page will connect to the server using a web socket. This socket is used to keep the server's in-memory model of the UI (the one you work with as a programmer) in sync with the actual UI shown to the user in their browser. This is done using a simple messaging protocol with JSON packets.

When the user clicks or otherwise interacts with the UI, those events are sent back over the web socket so that your code can deal with them.

In the case of web assembly, this same dataflow takes place. However, sockets are not used as all communication is done locally in the browser process.

Contributing

Ooui is open source and I love merging PRs. Please fork away, and please obey the .editorconfig file. :-) Try to file issues for things that you want to work on before you start the work so that there's no duplicated effort. If you just want to help out, check out the issues and dive in!