statusify
v1.0.1
Published
A simple utility to set status messages on a web page.
Downloads
10
Maintainers
therealayo1Readme
Statusify
A versatile JavaScript utility for displaying status messages with styling and timeout options. Ideal for providing feedback in the browser console, HTML elements, or custom logging targets.
Installation
You can use this module directly without installation if it is in your project's directory, or you can install it from npm:
npm install statusifyUsage
const statusify = require("statusify");
// Basic usage (logs to console with default red color and 5-second timeout)
statusify("This is a message");
// Custom color and timeout (logs to console)
statusify("Warning!", { color: "orange", timeout: 3000 });
// Display message in an HTML element
const messageContainer = document.getElementById("message-container");
statusify("Hello from Statusify!", {
color: "blue",
timeout: 2000,
target: messageContainer,
});
// Custom logging target (e.g., for testing)
const mockLogger = {
log: (message, ...args) => {
console.log(`[MOCK] ${message}`, ...args);
},
};
statusify("Test message", { target: mockLogger });Parameters
message(string): The text content of the status message to display.options(object - optional): An object containing configuration settings:color(string, default: "red"): The color of the message text in CSS format (e.g., "blue", "#FF5733").timeout(number, default: 5000): The time in milliseconds before the message disappears (set to 0 to disable auto-clearing).target(object, default: console): The object where the message will be displayed. This can be:- The browser console object (default).
- An HTML element (e.g., obtained using
document.getElementById). - Any custom object with a
logmethod (e.g., a logging utility).
Example
Here is a complete example:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Statusify Example</title>
</head>
<body>
<div id="message-container"></div>
<script src="path/to/your/statusify.js"></script>
<script>
const statusify = require("statusify");
const messageContainer = document.getElementById("message-container");
statusify("Hello from Statusify!", {
color: "blue",
timeout: 2000,
target: messageContainer,
});
</script>
</body>
</html>License
This project is licensed under the ISC License.