Skip to content

ReactView is a framework for building react.js based UIs that can be hosted in Avalonia/WPF applications

License

Notifications You must be signed in to change notification settings

OutSystems/ReactView

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ReactView

ReactView is a framework for building react.js based UIs that can be hosted in Avalonia/WPF applications. Using this framework you can build .NET desktop applications that run on Windows or macOS (using the Avalonia version) and mix TypeScript and .NET code in the same app in a seamless way.

Documentation

See the Sample.Avalonia project for an example of a Task List application that showcases most of the functionalities provided by this framework.

Getting Started

  1. Add the ReactViewControl-Avalonia (or ReactViewControl-WPF) and ViewGenerator Nuget packages to your WPF/Avalonia project.
  2. Follow these intructions
  3. For more details check the Sample project.

Releases

Stable binaries are released on NuGet, and contain everything you need to start creating ReactView based apps.

  • ReactViewControl-Avalonia
  • ReactViewControl-WPF
  • ViewGenerator

View Generator

ViewGenerator is the companion tool of the ReactView framework which generates the C# code from the TypeScript declarations and is responsible for compiling and packing all the application assets into the app bundle.

Build pre-requisites

  • NodeJS

ViewPacker

We have a node package, node-sass which creates a folder of vendors for each OS. However, to generate these vendors, the following command needs to run in each OS: Inside ViewPacker with node_modules installed, the user should run node scripts/install.js which will generate a new vendor folder inside node_modules/node_sass/vendor/ for the user's selected OS. This new vendor folder (e.g. darwin-x64-72/) and its binding.node content file shall then be added to ViewPacker's build/node-sass-vendors/.

For now we are using the following node versions:

  • 10.16.3
  • 12.18.4

Note: If you wish to upgrade the node version at use, don't forget to delete/replace any previous bindings related to the OS (darwin-x64-72/ represents node 12.X.X's version).

Versioning

The versioning system works as follows:

<major>.<cef_version>.<patch>

Whenever you fix a bug, please increase the patch version.
Whenever you bring a new feature, please increase the major version.
Use the minor version for the current cef version.

TODO

  • Improve documentation