Electrobun Documentation - Build ultra fast, tiny, cross-platform desktop apps

Electrobun Documentation

Everything you need to build ultra fast, tiny, cross-platform desktop applications with TypeScript.

Quick Start

import { BrowserWindow } from "electrobun/bun";

const win = new BrowserWindow({
  title: "My App",
  url: "views://mainview/index.html",
});

Electrobun

Ultra fast and tiny desktop app framework

Build cross-platform desktop applications with TypeScript that are incredibly small and blazingly fast. Electrobun combines the power of native bindings with Bun’s runtime for unprecedented performance.

✓ Native bindings written in C++, ObjC, and Zig

✓ Bun as backend runtime and bundler

✓ System’s native webview as renderer, CEF Optional

✓ Custom bsdiff-based update mechanism

✓ Cross-platform: macOS, Windows, Linux

14MB

Bundle Size

14KB

Update Size

<50ms

Startup Time

100%

Native Feel

Documentation

Getting Started

• Quick Start Create your first Electrobun app in minutes
• What is Electrobun? Learn about the framework and its benefits
• Hello World Build your first app step by step
• Creating UI Build beautiful user interfaces
• Bundling & Distribution Package and distribute your apps

Advanced Guides

• Cross-Platform Development Build for macOS, Windows, and Linux
• Compatibility Platform compatibility and requirements
• Code Signing Sign and notarize your applications
• Architecture Overview Understand Electrobun’s architecture
• Webview Tag Architecture How webviews work in Electrobun
• Updates Update system and binary patches

Bun APIs

• Bun API Main process API and lifecycle management
• BrowserWindow Native window management and controls
• BrowserView Create and manage webview windows
• WebGPU Native GPU windows and WebGPU integrations
• Utils File system and OS utility functions
• Context Menu Native context menus
• Application Menu
• Paths Global paths for resources and views
• Tray System tray implementation
• Updater Built-in app update mechanism
• Events Event system and handling

Browser APIs

• Electroview Class Initialize Electrobun APIs in browser
• Webview Tag Custom webview HTML element
• Draggable Regions Make HTML elements draggable
• Global Properties Browser context global properties
• WGPU Tag Embed GPU surfaces in webviews

CLI & Configuration

• Build Configuration Configure your Electrobun builds
• CLI Arguments Command line interface reference
• Bundled Assets Asset management with views:// schema
• Bundling CEF CEF bundling across platforms
• Application Icons Configure app icons for all platforms