Skip to content

A lightweight and customizable JavaScript library for creating interactive user interfaces with a futuristic, sci-fi aesthetic. It offers a set of ready-to-use "panel" components designed for building dynamic and visually appealing dashboards.

License

Notifications You must be signed in to change notification settings

soyunomas/Dynamic-SciFi-Dashboard-Kit

Repository files navigation

English | Español


Dynamic-SciFi-Dashboard-Kit

License: MIT GitHub stars GitHub forks

Dynamic-SciFi-Dashboard-Kit is a lightweight and customizable JavaScript library for creating interactive user interfaces with a futuristic, sci-fi aesthetic. It offers a set of ready-to-use "panel" components designed for building dynamic and visually appealing dashboards.

Features

  • Modular Components: A variety of panels for different purposes (logs, alerts, data, graphs, etc.).
  • Sci-Fi Aesthetics: Predefined styles with a futuristic touch, including effects like "scanlines" and "sparks".
  • Customizable: Appearance can be easily modified using CSS variables.
  • Modern JavaScript: Written in ES6+ with no heavy external dependencies (only uses Bootstrap for example layouts).
  • Easy to Use: Simple API to integrate and control the panels.
  • Responsive (with Bootstrap): Examples and panel structure are designed to adapt to different screen sizes with the help of a framework like Bootstrap.

Demo

Here you can see a demo with all the panels (click the buttons to change states).

Screenshot of the Dynamic SciFi Dashboard Kit demo

Link

(English)

Available Panels

Here's a quick look at the panels offered by the library. Click on an image to see a live example.

Panel Screenshot Live Example (GitHub Pages)
LogDisplayPanel LogDisplayPanel Screenshot View Example
CriticalWarningTextPanel CriticalWarningTextPanel Screenshot View Example
KeyValueListPanel KeyValueListPanel Screenshot View Example
LedDisplayPanel LedDisplayPanel Screenshot View Example
DynamicTextPanel DynamicTextPanel Screenshot View Example
ActionButtonsPanel ActionButtonsPanel Screenshot View Example
CanvasGraphPanel CanvasGraphPanel Screenshot View Example
IntegrityPulsePanel IntegrityPulsePanel Screenshot View Example
CircularGaugePanel CircularGaugePanel Screenshot View Example
StatusIndicatorLedPanel StatusIndicatorLedPanel Screenshot View Example
HorizontalBarGaugePanel HorizontalBarGaugePanel Screenshot View Example
ImageDisplayPanel ImageDisplayPanel Screenshot View Example
TrueCanvasGraphPanel TrueCanvasGraphPanel Screenshot View Example
TrueIntegrityPulsePanel TrueIntegrityPulsePanel Screenshot View Example
RadarDisplayPanel RadarDisplayPanel Screenshot View Example
HeatmapPanel HeatmapPanel Screenshot View Example

Installation

  1. Download (or clone) this repository.
  2. Include the DynamicSciFiDashboardKit.css and DynamicSciFiDashboardKit.js files in your HTML project:
<head>
    <!-- ... your other head tags ... -->
    <link rel="stylesheet" href="path/to/DynamicSciFiDashboardKit.css">
</head>
<body>
    <!-- ... your HTML content ... -->
    <script src="path/to/DynamicSciFiDashboardKit.js"></script>
    <script>
        // Your code to initialize the panels
    </script>
</body>

Usage Guide

For a detailed guide on how to use each panel, its options, and methods, please refer to the Complete Usage Guide (docs/USAGE_GUIDE.md).

Customization

The appearance of the panels can be extensively customized by overriding the CSS variables defined in DynamicSciFiDashboardKit.css. Review the CSS file to see the list of available variables.

Example:

/* In your own CSS file, after importing DynamicSciFiDashboardKit.css */
:root {
    --dsdk-accent-color-main: #FF6347; /* Tomato as main accent color */
    --dsdk-panel-bg: rgba(20, 20, 30, 0.9);
    --dsdk-font-mono: 'Share Tech Mono', monospace;
}

License

This project is licensed under the MIT License. See the LICENSE file for more details.


Created by Soyunomas

About

A lightweight and customizable JavaScript library for creating interactive user interfaces with a futuristic, sci-fi aesthetic. It offers a set of ready-to-use "panel" components designed for building dynamic and visually appealing dashboards.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published