console-play - npm Package Compare versions

Comparing version 0.0.16 to 0.0.17

dist/index.d.ts

@@ -7,3 +7,3 @@ import figlet from 'figlet';
     options?: Exclude<figlet.Options, "font"> & {
-        consoleType?: Exclude<keyof typeof console, "clear" | "table" | "groupEnd" | "group" | "groupCollapsed">;
+        consoleType?: "log" | "info" | "warn" | "error";
         wrapUnit?: string;
@@ -10,0 +10,0 @@ styleOptions: StyleOptions;

package.json

 {
   "name": "console-play",
-  "version": "0.0.16",
+  "version": "0.0.17",
   "description": "",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

@@ -1,6 +0,7 @@
-# console-play
+## ConsolePlay: A Fancy Console Output Library
 
-This library provides the function to display decorated text(Ascii Art) in the browser console
+ConsolePlay is a library that provides a way to output fancy and styled text in the browser console using Figlet fonts and custom style options.
 
 ## Quick Start
+
 Install:
@@ -12,3 +13,6 @@ ```
 Simple usage:
+
 ```ts
+import { consolePlay } from "console-play";
+
 consolePlay({
@@ -19,3 +23,2 @@ text: "Hello, World!",
             color: "red",
-            backgroundColor: "black",
         },
@@ -25,1 +28,69 @@ },
 ```
+
+In console:
+<img src="https://user-images.githubusercontent.com/36734151/237031951-78ce243f-1703-4b01-b781-50c0282d4948.png">
+
+## Features
+
+- Output text using Figlet fonts (currently only Standard, but more Figlet fonts will be supported in the future).
+- Custom styling options for the console output
+- Dark mode support
+
+## API
+### consolePlay
+
+| Property | Type | Required | Default | Description |
+| -------- | ---- | -------- | ------- | ----------- |
+| text | `string` | Yes | N/A | The text to be output in the console. |
+| options | `ConsolePlayProps` | No | N/A | An object containing configuration options for the console output. |
+
+### Option
+
+| Property | Type | Required | Default | Description |
+| -------- | ---- | -------- | ------- | ----------- |
+| consoleType | "log", "info", "warn", "error"  | No | "log" | The type of console output (e.g., log, error, warn, etc.). |
+| wrapUnit | `string` | No | N/A | A string representing the character(s) to wrap around the text. this prop is alpha version. so it may not work. |
+| styleOptions | `StyleOptions` | Yes | N/A | An object containing the style options for the console output. |
+| styleDebug | `boolean` | No | `false` | A boolean flag to enable/disable style debugging.if `true` then console.log CSS style will be applied |
+
+### Style Options
+
+Style options is unfinished. So, it may not work except `color` and `backGroundColor`.
+
+| Property | Type | Required | Default | Description |
+| -------- | ---- | -------- | ------- | ----------- |
+| imageUrl | `string` | Yes | N/A | URL of the image to be displayed as a background image. if this prop set, then you also need to set padding to allocate place for image |
+| color | `HasThemeStyle` | No | N/A | Text color. Can be a single color or an object with `light` and `dark` properties (can automatically switch between dark or light mode depending on the user's environment). |
+| backgroundColor | `HasThemeStyle` | No | N/A | Background color. Can be a single color or an object with `light` and `dark` properties (can automatically switch between dark or light mode depending on the user's environment).|
+| display | `"inline-block" \| "block" \| "flex" \| "grid"` | No | N/A | CSS display value. |
+| padding | `FourDirectionStyle` | No | N/A | Padding around the text. Can be a single number or an object with `top`, `right`, `left`, and `bottom` properties. |
+| margin | `FourDirectionStyle` | No | N/A | Margin around the text. Can be a single number or an object with `top`, `right`, `left`, and `bottom` properties. |
+| boxShadow | `string` | No | N/A | CSS box-shadow value. such as box-shadow: 12px 12px 2px 1px rgba(0, 0, 255, .2);|
+
+The `HasThemeStyle` type is defined as follows:
+
+```typescript
+type HasThemeStyle =
+  | string
+  | {
+      light: string;
+      dark: string;
+    };
+```
+
+The `FourDirectionStyle` type is defined as follows:
+
+```typescript
+type FourDirectionStyle =
+  | number
+  | {
+      top?: number;
+      right?: number;
+      left?: number;
+      bottom?: number;
+    };
+```
+
+For more information on `HasThemeStyle` and `FourDirectionStyle`, please refer to the original code provided.
+## License
+[MIT © skyt-a](./LICENSE)

No alert changes

Improved metrics

Total package byte prevSize

56514

increased by7.86%

Number of package files

29

increased by3.57%

Number of lines in readme file

94

increased by308.7%

No dependency changes