https://github.com/ktsu-dev/themeprovider
A semantic color theming library for .NET applications that provides 44+ beautiful themes with intelligent color mapping, framework integration, and accessibility-first design.
https://github.com/ktsu-dev/themeprovider
accessibility c color color-palette color-science color-space colors contrast-ratio dark-theme dear-imgui imgui light-theme net oklab perceptual-color semantic-colors theme theming ui-framework wcag
Last synced: 28 days ago
JSON representation
A semantic color theming library for .NET applications that provides 44+ beautiful themes with intelligent color mapping, framework integration, and accessibility-first design.
- Host: GitHub
- URL: https://github.com/ktsu-dev/themeprovider
- Owner: ktsu-dev
- License: mit
- Created: 2025-07-21T13:18:19.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-06-24T23:25:47.000Z (about 1 month ago)
- Last Synced: 2026-06-25T01:08:44.666Z (about 1 month ago)
- Topics: accessibility, c, color, color-palette, color-science, color-space, colors, contrast-ratio, dark-theme, dear-imgui, imgui, light-theme, net, oklab, perceptual-color, semantic-colors, theme, theming, ui-framework, wcag
- Language: C#
- Homepage: https://ktsu.dev
- Size: 396 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Authors: AUTHORS.md
- Copyright: COPYRIGHT.md
Awesome Lists containing this project
README
# ktsu.ThemeProvider
> A semantic color theming library for .NET applications with 44+ themes, intelligent color mapping, and framework integration.
[](LICENSE.md)
[](https://nuget.org/packages/ktsu.ThemeProvider)
[](https://nuget.org/packages/ktsu.ThemeProvider)
[](https://nuget.org/packages/ktsu.ThemeProvider)
[](https://github.com/ktsu-dev/ThemeProvider/commits/main)
[](https://github.com/ktsu-dev/ThemeProvider/graphs/contributors)
[](https://github.com/ktsu-dev/ThemeProvider/actions)
## Introduction
`ktsu.ThemeProvider` is a comprehensive theming system that uses semantic color specifications rather than arbitrary color names. Instead of hardcoding colors like "blue" or "red", you define colors by their purpose (Primary, Error, Warning) and priority level, and the library generates consistent, accessible color palettes. It includes 44 carefully crafted themes from popular color schemes and provides built-in Dear ImGui integration with an extensible architecture for other UI frameworks.
## Features
- **Semantic Color System**: Define colors by purpose (Primary, Error, Warning, Neutral) and priority level rather than specific hues, enabling consistent theming across any UI framework
- **44 Built-in Themes**: Includes Catppuccin, Tokyo Night, Gruvbox, Everforest, Nightfox, Kanagawa, PaperColor, Nord, Dracula, VSCode, One Dark, Monokai, and Nightfly theme families
- **Centralized Theme Registry**: Discover, filter, and instantiate themes by name, family, or light/dark classification with rich metadata
- **Dear ImGui Integration**: Companion package `ktsu.ThemeProvider.ImGui` provides complete ImGui color palette mapping via `ImGuiPaletteMapper`
- **Perceptual Color Science**: Uses Oklab perceptual color space for uniform color interpolation, extrapolation, and lightness-based priority mapping
- **WCAG Accessibility**: Built-in contrast ratio calculations, accessibility level checking (AA/AAA), and automatic color adjustment to meet WCAG standards
- **Extensible Framework Mappers**: Implement `IPaletteMapper` to integrate with any UI framework
- **Priority-Based Color Hierarchy**: Seven priority levels (VeryLow to VeryHigh) automatically mapped to appropriate lightness values, with theme-aware ordering for dark and light themes
- **Multi-Target Support**: Targets .NET 5.0 through 10.0, plus .NET Standard 2.0 and 2.1
## Installation
### Package Manager Console
```powershell
Install-Package ktsu.ThemeProvider
```
### .NET CLI
```bash
dotnet add package ktsu.ThemeProvider
```
### Package Reference
```xml
```
For Dear ImGui integration, also install:
```bash
dotnet add package ktsu.ThemeProvider.ImGui
```
## Usage Examples
### Basic Example
```csharp
using ktsu.ThemeProvider;
using static ktsu.ThemeProvider.ThemeRegistry;
// Create a theme directly
var theme = new Themes.Catppuccin.Mocha();
// Or find and create via the registry
ThemeInfo? themeInfo = FindTheme("Catppuccin Mocha");
ISemanticTheme? registryTheme = themeInfo?.CreateInstance();
// Map semantic color requests to actual colors
var requests = new[]
{
new SemanticColorRequest(SemanticMeaning.Primary, Priority.Medium),
new SemanticColorRequest(SemanticMeaning.Error, Priority.High),
new SemanticColorRequest(SemanticMeaning.Neutral, Priority.VeryLow),
};
IReadOnlyDictionary colors =
SemanticColorMapper.MapColors(requests, theme);
```
### Theme Discovery with the Registry
```csharp
using ktsu.ThemeProvider;
using static ktsu.ThemeProvider.ThemeRegistry;
// Browse all themes
IReadOnlyList allThemes = AllThemes;
IReadOnlyList darkThemes = DarkThemes;
IReadOnlyList lightThemes = LightThemes;
// Browse by family
IReadOnlyList families = Families;
IReadOnlyList catppuccinThemes = GetThemesInFamily("Catppuccin");
// Find a specific theme by name (case-insensitive)
ThemeInfo? themeInfo = FindTheme("Tokyo Night Storm");
ISemanticTheme? theme = themeInfo?.CreateInstance();
// Create all theme instances at once
IReadOnlyList allInstances = CreateAllThemeInstances();
IReadOnlyList gruvboxInstances = CreateThemeInstancesInFamily("Gruvbox");
```
### Complete Palette Generation
```csharp
using ktsu.ThemeProvider;
var theme = new Themes.Nord.Nord();
// Generate the complete palette (all meaning + priority combinations)
IReadOnlyDictionary completePalette =
SemanticColorMapper.MakeCompletePalette(theme);
// Access any color from the palette
var primaryMedium = completePalette[new SemanticColorRequest(SemanticMeaning.Primary, Priority.Medium)];
RgbColor rgb = primaryMedium.RgbValue;
string hex = rgb.ToHex();
```
### Dear ImGui Integration
```csharp
using ktsu.ThemeProvider;
using ktsu.ThemeProvider.ImGui;
using Hexa.NET.ImGui;
// Create theme and mapper
var theme = new Themes.Catppuccin.Mocha();
var mapper = new ImGuiPaletteMapper();
// Get complete ImGui color palette
IReadOnlyDictionary imguiColors = mapper.MapTheme(theme);
// Apply to ImGui style
var style = ImGui.GetStyle();
foreach ((ImGuiCol colorKey, Vector4 colorValue) in imguiColors)
{
style.Colors[(int)colorKey] = colorValue;
}
```
### Accessibility Checking
```csharp
using ktsu.ThemeProvider;
var foreground = RgbColor.FromHex("#FFFFFF");
var background = RgbColor.FromHex("#1E1E2E");
// Calculate contrast ratio
float contrastRatio = ColorMath.GetContrastRatio(foreground, background);
// Check WCAG compliance
AccessibilityLevel level = ColorMath.GetAccessibilityLevel(foreground, background, isLargeText: false);
// Adjust a color to meet accessibility requirements
RgbColor adjusted = ColorMath.AdjustForAccessibility(foreground, background, AccessibilityLevel.AA);
// Create perceptually uniform gradients
RgbColor[] gradient = ColorMath.CreateGradient(foreground, background, steps: 10);
```
## Advanced Usage
### Creating Custom Framework Mappers
Implement `IPaletteMapper` to integrate with any UI framework:
```csharp
using ktsu.ThemeProvider;
public class MyFrameworkMapper : IPaletteMapper
{
public string FrameworkName => "My UI Framework";
public IReadOnlyDictionary MapTheme(ISemanticTheme theme)
{
var requests = new Dictionary
{
{ MyColorEnum.Button, new(SemanticMeaning.Primary, Priority.Medium) },
{ MyColorEnum.Background, new(SemanticMeaning.Neutral, Priority.VeryLow) },
{ MyColorEnum.ErrorText, new(SemanticMeaning.Error, Priority.High) },
};
var palette = SemanticColorMapper.MapColors(requests.Values, theme);
var result = new Dictionary();
foreach (var kvp in requests)
{
if (palette.TryGetValue(kvp.Value, out var color))
{
result[kvp.Key] = ConvertToMyColor(color.RgbValue);
}
}
return result;
}
}
```
### Creating Custom Themes
Implement `ISemanticTheme` with colors from your palette:
```csharp
using ktsu.ThemeProvider;
using System.Collections.ObjectModel;
public class MyCustomTheme : ISemanticTheme
{
private static readonly PerceptualColor Background = PerceptualColor.FromRgb("#1A1B26");
private static readonly PerceptualColor Foreground = PerceptualColor.FromRgb("#C0CAF5");
private static readonly PerceptualColor Blue = PerceptualColor.FromRgb("#7AA2F7");
private static readonly PerceptualColor Green = PerceptualColor.FromRgb("#9ECE6A");
private static readonly PerceptualColor Red = PerceptualColor.FromRgb("#F7768E");
public bool IsDarkTheme => true;
public Dictionary> SemanticMapping { get; } = new()
{
{ SemanticMeaning.Neutral, new() { Background, Foreground } },
{ SemanticMeaning.Primary, new() { Blue } },
{ SemanticMeaning.Success, new() { Green } },
{ SemanticMeaning.Error, new() { Red } },
};
}
```
## API Reference
### `SemanticMeaning` (enum)
Defines semantic color purposes.
| Value | Description |
|-------|-------------|
| `Neutral` | Backgrounds, borders, inactive elements |
| `Primary` | Main brand/accent colors |
| `Alternate` | Secondary accent, binary choice emphasis |
| `Success` | Successful operations, confirmations |
| `CallToAction` | Important buttons and highlights demanding attention |
| `Information` | Informational content, help text |
| `Caution` | Cautionary content needing attention |
| `Warning` | Warning states, potentially problematic |
| `Error` | Error states, incorrect conditions |
| `Failure` | Failed operations (distinct from error) |
| `Debug` | Debug/development information |
### `Priority` (enum)
Controls color intensity and lightness within a semantic meaning.
| Value | Description |
|-------|-------------|
| `VeryLow` | Lowest intensity (backgrounds in dark themes, lightest in light themes) |
| `Low` | Low intensity |
| `MediumLow` | Below-medium intensity |
| `Medium` | Default intensity level |
| `MediumHigh` | Above-medium intensity |
| `High` | High intensity |
| `VeryHigh` | Highest intensity (foreground text in dark themes, darkest in light themes) |
### `SemanticColorRequest`
A readonly record struct combining a `SemanticMeaning` and `Priority` to specify a color.
| Property | Type | Description |
|----------|------|-------------|
| `Meaning` | `SemanticMeaning` | The semantic purpose of the color |
| `Priority` | `Priority` | The intensity/lightness level |
### `SemanticColorMapper`
Static class that maps semantic color requests to actual colors.
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `MapColors(requests, theme)` | `IReadOnlyDictionary` | Maps a collection of requests to colors using the theme |
| `MakeCompletePalette(theme)` | `IReadOnlyDictionary` | Generates all possible meaning+priority combinations for a theme |
### `ThemeRegistry`
Static class providing centralized theme discovery and management.
#### Properties
| Name | Type | Description |
|------|------|-------------|
| `AllThemes` | `IReadOnlyList` | All 44 registered themes with metadata |
| `DarkThemes` | `IReadOnlyList` | All dark themes |
| `LightThemes` | `IReadOnlyList` | All light themes |
| `Families` | `IReadOnlyList` | All theme family names |
| `ThemesByFamily` | `IReadOnlyDictionary>` | Themes grouped by family |
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `FindTheme(name)` | `ThemeInfo?` | Finds a theme by name (case-insensitive) |
| `GetThemesInFamily(family)` | `IReadOnlyList` | Gets all themes in a family |
| `CreateAllThemeInstances()` | `IReadOnlyList` | Creates instances of all themes |
| `CreateThemeInstancesInFamily(family)` | `IReadOnlyList` | Creates instances of themes in a family |
### `ColorMath`
Static class providing color space conversions and accessibility utilities.
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `RgbToOklab(rgb)` | `OklabColor` | Converts linear RGB to Oklab color space |
| `OklabToRgb(oklab)` | `RgbColor` | Converts Oklab to linear RGB color space |
| `GetRelativeLuminance(rgb)` | `float` | Calculates WCAG relative luminance |
| `GetContrastRatio(color1, color2)` | `float` | Calculates WCAG contrast ratio (1:1 to 21:1) |
| `GetAccessibilityLevel(fg, bg, isLargeText)` | `AccessibilityLevel` | Checks WCAG AA/AAA compliance |
| `AdjustForAccessibility(fg, bg, level, isLargeText)` | `RgbColor` | Adjusts color to meet WCAG requirements |
| `CreateGradient(from, to, steps)` | `RgbColor[]` | Creates a perceptually uniform gradient |
### `PerceptualColor`
Readonly record struct representing a color with perceptual properties in Oklab space.
#### Properties
| Name | Type | Description |
|------|------|-------------|
| `OklabValue` | `OklabColor` | The color in Oklab perceptual space |
| `RgbValue` | `RgbColor` | The RGB representation |
| `Hue` | `float` | Hue in Oklab polar coordinates |
| `Chroma` | `float` | Chroma (colorfulness) in Oklab polar coordinates |
| `Lightness` | `float` | Lightness in Oklab space |
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `FromRgb(RgbColor)` | `PerceptualColor` | Creates from an RGB color |
| `FromRgb(string hex)` | `PerceptualColor` | Creates from a hex color string |
| `SemanticDistanceTo(other)` | `float` | Calculates perceptual distance to another color |
### `RgbColor`
Readonly record struct representing a linear RGB color with float precision.
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `FromBytes(r, g, b)` | `RgbColor` | Creates from 8-bit values (0-255) |
| `FromHex(hex)` | `RgbColor` | Creates from hex string (e.g., "#FF0000") |
| `ToHex()` | `string` | Converts to hex string |
| `ToBytes()` | `(byte R, byte G, byte B)` | Converts to 8-bit values |
| `ToSRgb()` | `SRgbColor` | Converts to sRGB gamma-corrected values |
### `IPaletteMapper`
Interface for mapping semantic themes to framework-specific color palettes.
#### Properties
| Name | Type | Description |
|------|------|-------------|
| `FrameworkName` | `string` | The name of the target UI framework |
#### Methods
| Name | Return Type | Description |
|------|-------------|-------------|
| `MapTheme(theme)` | `IReadOnlyDictionary` | Maps a theme to a framework-specific palette |
## Available Themes
| Family | Variants | Description |
|--------|----------|-------------|
| **Catppuccin** | Latte, Frappe, Macchiato, Mocha | Warm pastel themes with excellent readability |
| **Tokyo Night** | Night, Storm, Day | Clean themes inspired by Tokyo's neon nights |
| **Gruvbox** | Dark, Dark Hard, Dark Soft, Light, Light Hard, Light Soft | Retro groove colors with warm backgrounds |
| **Everforest** | Dark, Dark Hard, Dark Soft, Light, Light Hard, Light Soft | Green forest colors for comfortable viewing |
| **Nightfox** | Nightfox, Dayfox, Duskfox, Nordfox, Terafox, Carbonfox, Dawnfox | Fox-inspired vibrant themes |
| **Kanagawa** | Wave, Dragon, Lotus | Japanese-inspired themes |
| **PaperColor** | Light, Dark | Material Design inspired themes |
| **VSCode** | Dark, Light | Microsoft VSCode default themes |
| **Nord** | - | Arctic-inspired theme with cool blue tones |
| **Dracula** | - | Gothic theme with purple and pink accents |
| **One Dark** | - | Atom's iconic One Dark theme |
| **Monokai** | - | Classic Monokai with vibrant colors |
| **Nightfly** | - | Dark blue theme inspired by night flying |
## Contributing
Contributions are welcome! Feel free to open issues or submit pull requests.
## License
This project is licensed under the MIT License. See the [LICENSE.md](LICENSE.md) file for details.