Skip to content

Minimal and modular Electron utility toolkit — manage windows, tray, IPC, notifications, and custom frames with ease.

License

Notifications You must be signed in to change notification settings

Tiny-Essentials/Tiny-Electron-Essentials

Repository files navigation

banner

Discord server NPM version NPM downloads

Patreon Ko-Fi Bitcoin Litecoin

npm installnfo

🚀 Tiny-Electron-Essentials

A modular toolkit for simplifying Electron app development. Provides a set of reusable helpers to manage windows, tray, IPC, notifications, and more with clean and consistent APIs.


🧠 What is this?

tiny-electron-essentials is a minimalistic utility library designed to speed up the development of Electron applications.

It offers reliable helpers for:

  • 🪟 Window creation and management
  • 🖥️ Tray icon control
  • 🔗 IPC event handling
  • 🔔 Native notifications
  • 🏗️ CSS-based custom window frames
  • 🔥 App lifecycle control with single-instance locks
  • 🌐 Proxy management, file loaders, and more

Everything is built with clarity and extensibility in mind.


📦 NPM Module

npm install tiny-electron-essentials

📂 Project Structure

Folder Description
src/ 🧠 Main source code for the entire module
tests/ 🧪 Automated tests for core functionality
docs/ 📚 Full documentation with API descriptions and examples

📚 Documentation

Full documentation is available in the docs/ folder.

✔️ Includes detailed explanations for all modules: Global utilities, Main process controllers, Preload IPC bridges, and more.


🔗 Useful Links


🛠️ Requirements

  • Electron v23 or higher
  • Node.js v18 or higher

📝 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

🧠 Note: This documentation was written by ChatGPT, an AI assistant developed by OpenAI, based on the project structure and descriptions provided by the repository author.
If you find any inaccuracies or need improvements, feel free to contribute or open an issue!


🔙 Back to Tiny Essentials

Did you like this module? It’s part of the Tiny Essentials collection — a set of minimal yet powerful tools to make development easier. 👉 Click here to explore more Tiny Essentials modules



Made with tiny love!