0.1.0-beta.1

@diamonddigitaldev/electron-kit | Beta Preview (v0.1.0-beta.1)

Important

This is the first public version, and a beta: the API can still change between 0.x versions. It's published under npm's next tag.

The shared design system for Diamond Digital Development's Electron apps: one package that holds what the apps share, so a fix to shared UI or behaviour is made once, here, and each app takes it with a version bump. Diamond File Converter 2.0 is the first app built on it.

npm install @diamonddigitaldev/electron-kit@next

What's in it

• Main-process behaviour from one call, start(): a sandboxed, context-isolated main window that keeps its size and position, one instance and the files an app is opened with, the settings and their migration, a log redacted to file names, the house menu, and an updater with Stable, Beta and Alpha channels.
• A shared preload, window.kitAPI, registered on the app's session, that answers the app's own page only, and kit.ipc.handle(), the same check for an app's own channels.
• Page components and CSS on Bootstrap 5.3: the nav rail, the Settings view with its Update and Credits tabs, toasts, prompts, drop zones, progress and the action bar, in each app's accent, meeting WCAG 2.2 AA in both themes.
• An electron-builder base config: an NSIS installer on Windows; AppImage, .deb and .rpm on Linux.
• Test helpers for an app's own tests: the accent's contrast, the menu's shortcuts, the build config.

Requires Electron 44 or later and Node.js 24 or later. Windows and Linux.

The docs are in the repository: start at docs/README.md.

Note

This version was published to npm by hand, since npm only lets a trusted publisher be set up for a package that's already there. From the next version on, each is published by GitHub Actions with provenance, and only after a maintainer approves it with two-factor authentication.

Found something wrong? Open an issue.