Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onebeld/pleasantui
Graphical user interface library for Avalonia with its own controls
https://github.com/onebeld/pleasantui
avalonia avaloniaui c-sharp control controls csharp design dotnet interface library netstandard nuget pleasant style styled-components styles theme ui user-interface xaml
Last synced: 29 days ago
JSON representation
Graphical user interface library for Avalonia with its own controls
- Host: GitHub
- URL: https://github.com/onebeld/pleasantui
- Owner: Onebeld
- License: mit
- Created: 2023-05-01T11:52:50.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-20T10:27:11.000Z (about 2 months ago)
- Last Synced: 2024-09-30T11:16:16.376Z (about 1 month ago)
- Topics: avalonia, avaloniaui, c-sharp, control, controls, csharp, design, dotnet, interface, library, netstandard, nuget, pleasant, style, styled-components, styles, theme, ui, user-interface, xaml
- Language: C#
- Homepage:
- Size: 5.02 MB
- Stars: 27
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PleasantUI
Pleasant UI is a graphical user interface library for Avalonia with its own controls. Previously, it was only available as part of the Regul and Regul Save Cleaner projects. This project has existed since at least 2021.
This library continues the OlibUI tradition of releasing only later versions, not the very first.
This library is mostly focused on performance, lightness, and beauty, compared to many others.
This library is fully compatible with AOT compilation, and does not need to be added to rd.xml
## Getting Started
Install this library using NuGet, or copy the code to paste into your project file:
```xml
```
### Setup
For your application, add PleasantTheme to your styles:
```xml
```
This library automatically loads settings and saves them when the program is finished _(note, for mobile projects you need to save settings manually)_
Make sure that in the application class file, the XAML loader is in the overridden initialization method. Otherwise, you will get an error that the program is not initialized when you run the program.
```csharp
using Avalonia;
using Avalonia.Controls.ApplicationLifetimes;
using Avalonia.Markup.Xaml;
using YourApplication.ViewModels;
using YourApplication.Views;
namespace YourApplication;
public partial class App : Application
{
// That's exactly what you need to do, as shown below
public override void Initialize()
{
AvaloniaXamlLoader.Load(this);
}
public override void OnFrameworkInitializationCompleted()
{
if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
{
desktop.MainWindow = new MainWindow
{
DataContext = new MainWindowViewModel(),
};
}
base.OnFrameworkInitializationCompleted();
}
}
```
Next, we need to modify the main window so that it inherits from PleasantWindow:
```csharp
using PleasantUI.Controls;
namespace YourApplication.Views;
public partial class MainWindow : PleasantWindow
{
public MainWindow()
{
InitializeComponent();
}
}
```
Make sure that the (A)XAML file of the main window has a PleasantWindow object instead of Window:
```xml
```
Done! Now you can build your applications with this library.
## Screenshots
[Regul Save Cleaner](https://github.com/Onebeld/RegulSaveCleaner) (WIP)
[OlibKey](https://github.com/Onebeld/OlibKey) (WIP)
## Credits
* [AvaloniaUI](https://github.com/AvaloniaUI/Avalonia)
* Some controls from PieroCastillo's [Aura.UI](https://github.com/PieroCastillo/Aura.UI) library
* [ProgressRing](https://github.com/ymg2006/FluentAvalonia.ProgressRing) by ymg2006
The editors I used to create this project:
* [JetBrains Rider](https://www.jetbrains.com/rider/)
