From 070d77b72be48f24953ef79063eda5157fea0c59 Mon Sep 17 00:00:00 2001 From: Louis Charette Date: Sat, 2 Nov 2024 23:07:38 -0400 Subject: [PATCH] Add Default Severity --- app/assets/interfaces/severity.ts | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/app/assets/interfaces/severity.ts b/app/assets/interfaces/severity.ts index b4e1bb42..a2deb0f9 100644 --- a/app/assets/interfaces/severity.ts +++ b/app/assets/interfaces/severity.ts @@ -1,3 +1,17 @@ +/** + * Severity Enum + * + * This is a shared enum used to define the severity of different components + * (e.g., alert, button, etc.). This makes it easier to reference severity + * levels across multiple components, also defining a common concept across + * themes. + * + * Template components must accept all values of this enum as valid input. + * However, themes may choose to ignore or bind some values to another style. + * For example, a theme might not have an 'Info' colored button. In this case, + * the theme's button component must accept 'Info' as a valid input, but it can + * map it to the 'Primary' style. + */ export enum Severity { Primary = 'Primary', Secondary = 'Secondary', @@ -5,5 +19,6 @@ export enum Severity { Warning = 'Warning', Danger = 'Danger', Info = 'Info', - Muted = 'Muted' + Muted = 'Muted', // Aka, Disabled + Default = 'Default' // No-style or default style }