release: v0.0.5

.github/workflows/ci.yml

@@ -24,4 +24,4 @@ jobs:
       - name: Run examples/
         run: |
           deno run examples/simple.ts
-          deno run examples/custom.ts
+          deno run examples/medium.ts

README.md

@@ -48,6 +48,7 @@ interface BadgeOptions {
   labelStyle?: string; // default is null
   msgWidth?: number; // default is msg length + 2
   labelWidth?: number; // default is label length + 2
+  is_8bit?: boolean; // default is false as it uses 24 bits
 }
 ```
 
@@ -72,8 +73,6 @@ interface BadgeOptions {
 - `brightCyan`
 - `brightWhite`
 
-Custom color support coming soon
-
 ### Background Colors
 
 - `black`
@@ -93,7 +92,11 @@ Custom color support coming soon
 - `brightCyan`
 - `brightWhite`
 
-Custom color support coming soon
+### Custom Colors
+
+Custom Colors are available and can be used for `msgBg`, `labelmsg`, `msgColor` and `labelColor` only. There are options to make `8 bit` and `24 bit` colors respectively. Set `is_8bit` to true if you want custom 8 bit RGB colors else it will be set to 24 bit RBG colors by default.
+
+**NOTE**: `24 bit` Colors **must** be in a range of `0x000000` and `0xffffff` and `8 bit` Colors **must** in a range of `0x0` and `0xFF`.
 
 ### Styles
 

index.ts

@@ -1,6 +1,7 @@
 import * as color from "https://deno.land/[email protected]/fmt/colors.ts";
 
 type Color =
+  | number
   | "black"
   | "red"
   | "blue"
@@ -30,6 +31,7 @@ export interface BadgeOptions {
   labelStyle?: Format;
   msgWidth?: number;
   labelWidth?: number;
+  is_8bit?: boolean;
 }
 
 const colorBgTypes: ColorType = {
@@ -90,19 +92,33 @@ function padd(str: string, width?: number): string {
 
 function getBgColor(
   colr?: Color,
+  is_8bit?: boolean,
 ): (str: string) => string {
   if (!colr) {
     return color.bgBrightBlack;
   }
+  if (typeof colr === "number") {
+    if (is_8bit) {
+      return (str: string) => color.bgRgb8(str, colr);
+    }
+    return (str: string) => color.bgRgb24(str, colr);
+  }
   return colorBgTypes[colr];
 }
 
 function getTextColor(
   colr?: Color,
+  is_8bit?: boolean,
 ): (str: string) => string {
   if (!colr) {
     return color.white;
   }
+  if (typeof colr === "number") {
+    if (is_8bit) {
+      return (str: string) => color.rgb8(str, colr);
+    }
+    return (str: string) => color.rgb24(str, colr);
+  }
   return colorTypes[colr];
 }
 
@@ -119,7 +135,7 @@ function format(
   return str;
 }
 
-export const DEFAULT_OPTIONS: BadgeOptions = {
+export const DEFAULT_OPTIONS: Partial<BadgeOptions> = {
   msgBg: "blue",
   labelBg: "brightBlack",
   msgColor: "white",
@@ -140,17 +156,28 @@ export function badges(
     msgColor,
     msgBg,
     msgStyle,
+    is_8bit,
   } = opts;
 
   const lblStr = padd(label, labelWidth);
   const msgStr = padd(msg, msgWidth);
 
-  const msgColored = getTextColor(msgColor)(
-    getBgColor(msgBg)(msgStr),
-  );
-  const lblColored = getTextColor(labelColor)(
-    getBgColor(labelBg)(lblStr),
-  );
+  let msgColored: string, lblColored: string;
+
+  if (!labelBg) {
+    lblColored = getTextColor(labelColor, is_8bit)(color.bgBrightBlack(lblStr));
+  } else {
+    lblColored = getTextColor(labelColor, is_8bit)(
+      getBgColor(labelBg, is_8bit)(lblStr),
+    );
+  }
+  if (!msgBg) {
+    msgColored = getTextColor(msgColor, is_8bit)(color.bgBlue(msgStr));
+  } else {
+    msgColored = getTextColor(msgColor, is_8bit)(
+      getBgColor(msgBg, is_8bit)(msgStr),
+    );
+  }
 
   const labelformat = format(lblColored, labelStyle);
   const msgformat = format(msgColored, msgStyle);