Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Romzetron/Romzetron.Avalonia
Romzetron Avalonia Theme
https://github.com/Romzetron/Romzetron.Avalonia
Last synced: 17 days ago
JSON representation
Romzetron Avalonia Theme
- Host: GitHub
- URL: https://github.com/Romzetron/Romzetron.Avalonia
- Owner: Romzetron
- License: mit
- Created: 2024-03-04T21:54:43.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-11-25T15:23:11.000Z (19 days ago)
- Last Synced: 2024-11-25T15:54:27.659Z (19 days ago)
- Language: C#
- Size: 8.99 MB
- Stars: 18
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-avalonia - Romzetron.Avalonia - Avalonia Theme that supports light/dark modes and a variety of color themes. (Libraries & Extensions / Theme & Icons)
README
# Romzetron.Avalonia Theme Library
[](https://github.com/Romzetron/Romzetron.Avalonia/blob/main/LICENSE.md)
[](https://www.nuget.org/packages/Romzetron.Avalonia)
[Romzetron.Avalonia](https://github.com/Romzetron/Romzetron.Avalonia) is a UI theme library designed to work with the [Avalonia](https://avaloniaui.net) cross-platform UI framework. Light and dark modes are supported, and one of several color themes can be chosen that apply to most controls. Some of the controls can have their color set explicitly to override the theme color.
## Installation
The [Romzetron.Avalonia](https://github.com/Romzetron/Romzetron.Avalonia) theme library is available on [nuget.org](https://www.nuget.org/packages/Romzetron.Avalonia) and can be added to your project with using the **Nuget Package Manager** within **Visual Studio** or **Jetbrains Rider**, or with the following terminal command:
```bash
dotnet add package Romzetron.Avalonia
```
## Applying Theme via XAML
The theme can be added to an application by modifying `App.axaml` to add `` to the `` tag. The default color theme is `Blue`.
```xml
```
### Changing Color Theme
The color theme can be set application wide on startup by setting the `ColorTheme` property.
```xml
```
The color theme can be set to one of the following values.
- Red
- Pink
- Purple
- DeepPurple
- Indigo
- Blue
- Teal
- Green
- Amber
- Orange
- DeepOrange
- Brown
- BlueGrey
### Changing Color Theme During Runtime
In order to set the color theme during runtime, the following method can be added to a view model to find the `RomzetronTheme` style.
```csharp
private static RomzetronTheme? GetRomzetronAvaloniaTheme()
{
// Get a reference to the current application.
if (Application.Current is not App app)
return null;
// Loop through the styles in the application.
foreach (var style in app.Styles)
{
// Return RomzetronTheme if it is found.
if (style is RomzetronTheme theme)
return theme;
}
return null;
}
```
This method is then used to change the color theme dynamically during runtime. The following example property demonstrates how to use the method.
```csharp
private ColorTheme _selectedColorTheme;
public ColorTheme SelectedColorTheme
{
get => _selectedColorTheme;
set
{
this.RaiseAndSetIfChanged(ref _selectedColorTheme, value);
// Use the helper method to get a reference to the RomzetronTheme style.
var theme = GetRomzetronAvaloniaTheme();
// Set the color theme if the RomzetronTheme style is found.
if (theme is not null)
theme.ColorTheme = value;
}
}
```
> **Note**: It would be preferable to change the color theme at runtime using a `Binding` to adhere to the MVVM rules, but a workable solution has not been found... yet.
## Applying Theme via Code Behind
Alternatively, the theme can be applied to the application in code behind by modifying `App.axaml.cs` and creating an instance of the `RomzetronTheme` style that can be added to the list of `App` styles. Doing it this way allows the `SetColorTheme()` method to be accessed directly through the code behind.
```csharp
public class App : Application
{
// Create instance of the theme library.
private readonly RomzetronTheme _theme = new();
public override void Initialize()
{
AvaloniaXamlLoader.Load(this);
// Get the current application instance.
var app = (App) Current!;
// Add theme to the application styles.
app.Styles.Add(_theme);
}
// Optional function that can be used to change the theme color at runtime.
public void SetTheme(ColorTheme theme)
{
_theme.SelectColorTheme(theme);
}
public override void OnFrameworkInitializationCompleted()
{
if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
desktop.MainWindow = new MainWindow();
base.OnFrameworkInitializationCompleted();
}
}
```
## Overriding Color Theme for Individual Controls
Some controls have the ability to have their color set explicitly, which overrides the application color theme. This can be achieved by adding a dependency property to the control that sets the desired color.
```xml
```
The following controls support this feature, with more possibly being added in the future.
- CheckBox
- CircularProgress
- Button
- DropDownButton
- ProgressBar
- RadioButton
- Slider
- SplitButton
- TabItem
- TabStripItem
- ToggleButton
- ToggleSwitch
## Dark & Light Theme Variants
`Romzetron.Avalonia` supports dark and light variations that can be set explicitly, or to follow the system theme. Set the `RequestedThemeVariant` tag in `App.axaml` to one of the following values.
```xml
```
## Example Application
An example application is included in the solution that demonstrates the look & feel of most of the controls. I may add more detail in the front end of the example application that explains how to customize the controls, but for now the best method to figure out how things work is to look at the source code.