WinFormium

Кликните сюда (https://github.com/XuanchenLin/NanUI), чтобы увидеть англоязычную версию.

WinFormium — это открытый исходный код на платформе .NET, который позволяет использовать HTML5, CSS3 и JavaScript для создания пользовательского интерфейса WinForm-приложений. Он основан на проекте Xilium.CefGlue, представляющем собой реализацию Chromium Embedded Framework (CEF) для .NET.

Если вы ищете фреймворк для создания WinForm-приложения с современным пользовательским интерфейсом, WinFormium может быть хорошим выбором. Вы можете создавать пользовательский интерфейс с помощью HTML, CSS и JavaScript, а также писать бизнес-логику приложения на C#.

Если вам нравится проект, поставьте ему звезду ⭐.

Если этот проект был вам полезен, рассмотрите возможность его поддержки.

Требования к среде

Среда разработки

• .NET Framework 4.6.2 или более поздняя версия / .NET 6.0 или более поздняя версия
• Visual Studio 2019 или более поздние версии (рекомендуется использовать VS2022)

Среда развёртывания

• Microsoft Windows 7 Service Pack 1 или более поздняя версия
• .Net Framework 4.6.2 или более поздняя версия
• Для .NET 6.0 требуется Windows 7 SP1 или более поздняя версия
• Для .NET 7.0/8.0 требуется Windows 10 или Windows 11

Это фреймворк только для Windows, поэтому он не работает в Linux или MacOS.

Минимальная поддерживаемая версия Windows — Windows 7 SP1, но Windows 7 не поддерживает некоторые функции (например, DirectComposition для рендеринга вне экрана).

Начало работы

Чтобы создать простое WinFormium-приложение, выполните следующие шаги:

1. Создайте WinForm-приложение с использованием шаблона по умолчанию.
2. Установите NuGet-пакет WinFormium:
   • Откройте NuGet Package Manager для установки или используйте консоль диспетчера пакетов NuGet, затем выполните следующую команду для установки пакета WinFormium NuGet:

     PM> Install-Package NetDimension.NanUI
   • Установите зависимости Chromium Embedded Framework, необходимые для WinFormium, выполнив следующую команду:

     PM> Install-Package NetDimension.NanUI.Runtime
     Обратите внимание, что CEF имеет большой размер, и из-за известных проблем игроки из материкового Китая должны самостоятельно настроить использование внутренних зеркал NuGet.
     • Azure CDN — https://nuget.cdn.azure.cn/v3/index.json
     • Облако Huawei — https://repo.huaweicloud.com/repository/nuget/v3/index.json
3. Для простого WinFormium-приложения потребуется следующий код:
   • Измените код в файле Program.cs следующим образом:

     using WinFormium;
     
     class Program
     {
         [STAThread]
         static void Main(string[] args)
         {
             var builder = WinFormiumApp.CreateBuilder();
     
             builder.UseWinFormiumApp<MyApp>();
     
             var app = builder.Build();
     
             app.Run();
         }
     }
   • Создайте класс, наследующий от WinFormiumStartup, для настройки приложения:

     using WinFormium;
     
     class MyAPP : WinFormiumStartup
     {
         protected override MainWindowCreationAction? UseMainWindow(MainWindowOptions opts)
         {
             // Устанавливаем главное окно приложения
             return opts.UseMainFormium<MyWindow>();
         }
     
         protected override void WinFormiumMain(string[] args)
         {
             // Код в основной функции должен находиться здесь, эта функция выполняется только в основном процессе. Это предотвращает запуск дочерним процессом некоторого некорректного кода инициализации.
             ApplicationConfiguration.Initialize();
         }
     
         protected override void ConfigurationChromiumEmbedded(ChromiumEnvironmentBuiler cef)
         {
             // Здесь настраивается Chromium Embedded Framwork
         }
     
         protected override void ConfigureServices(IServiceCollection services)
         {
             // Здесь настраиваются сервисы данного приложения
         }
     }
   • Создайте класс, реализующий Formium, для конфигурации главного окна приложения:

     using WinFormium;
     using WinFormium.Forms;
     
     class MyWindow : Formium
     {
         public MyWindow()
         {
             Url = "https://www.google.com";
         }
     
         protected override FormStyle ConfigureWindowStyle(WindowStyleBuilder builder)
         {
             // Здесь можно настроить стиль и свойства окна или оставить значение по умолчанию
     
             var style = builder.UseSystemForm();
     
             style.TitleBar = false;
     
             style.DefaultAppTitle = "My first WinFomrim app";
     
             return style;
         }
     }
4. Скомпилируйте и запустите ваше первое WinFormium-приложение.

Документация

Для получения дополнительной информации см. документацию (docs/README.md).

Примеры кода

• Minimal WinFormium App (./examples/MinimalWinFormiumApp) — введение в основные функции WinFormium.