MbSoftLab.StringEnums 1.0.1

MbSoftLab.StringEnums

Description

MbSoftLab.StringEnums is a lightweight .NET library that allows you to decorate enum members with custom string values. Perfect for associating enums with display names, CSS classes, API values, or any other string representation.

Features

• 🏷️ Simple String Values - Attach string values using [StringValue] attribute
• 🔄 Conditional Values - Return different strings based on conditions with [ConditionalStringValue]
• 🔧 Extensible - Create your own custom attributes
• 📦 Lightweight - No external dependencies, targets .NET Standard 2.0

Installation

dotnet add package MbSoftLab.StringEnums

Or via NuGet Package Manager:

Install-Package MbSoftLab.StringEnums

Quick Start

Simple StringValues for Enums

 
// The enum 
 public enum MyEnum
 { 
   [StringValue("my-css-class-1")]
   Class1,

   [StringValue("my-css-class-2")]
   Class2
 }

Console.WriteLine(MyEnum.Class1.GetStringValue()); // output: my-css-class-1
Console.WriteLine(MyEnum.Class2.GetStringValue()); // output: my-css-class-2

Custom StringValue Attributes

using System;

namespace MbSoftLab.StringEnums.Demo
{
    public class CssClassAttribute : StringValueAttribute
    {
        public CssClassAttribute(string value) : base(value) { }
    }

    public static class CssClassEnumExtension
    {
        // Your concrete EnumExtension
        public static string GetCssClass(this Enum value)
        {
            return value.GetValueFromAttribute<CssClassAttribute>();
        }
    }
    // The enum 
    public enum MyEnum
    {
        [StringValue("i am a string")]
        [CssClass("my-css-class-1")]
        Class1,

        [CssClass("my-css-class-2")]
        Class2
    }
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine(MyEnum.Class1.GetStringValue()); // output: i am a string
            Console.WriteLine(MyEnum.Class1.GetCssClass()); // output: my-css-class-1
            Console.WriteLine(MyEnum.Class2.GetCssClass()); // output: my-css-class-2

            Console.ReadKey();
        }
    }
}

Conditional String Values

Return different strings based on a boolean condition:

public enum ToggleState
{
    [ConditionalStringValue("enabled", "disabled")]
    Power
}

// Usage
Console.WriteLine(ToggleState.Power.GetStringValueByCondition(true));  // output: enabled
Console.WriteLine(ToggleState.Power.GetStringValueByCondition(false)); // output: disabled

Documentation

For detailed documentation, see:

• 📖 Full Documentation
• 🚀 Quick Start Guide
• 📚 API Reference
• 🔧 Advanced Usage
• 🏗️ Architecture
• 📝 Changelog
• 🎉 Release Notes

Compatibility

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.