Development overlay for Bini.js: an animated status badge, route inspector, and full-screen error panel.
bini-overlay gives your Bini.js project a polished development experience by replacing Vite's default error screen. It adds a floating status badge, a route inspector, and a full-screen error panel with syntax-highlighted code frames.
>= 18.0.0>= 8.0.0bini-router >= 2.0.0Register the plugin in your Bini.js config. biniOverlay() returns an array of plugins, which Vite automatically flattens, so add it to your plugins array as-is.
To hide the floating badge, set disableBadge to true:
The badge is injected into the page so it never collides with your app's CSS. By default, it sits in the bottom-left corner.
| State | Appearance | Behaviour |
|---|---|---|
| Loading | Logo draws itself with an animation | Plays on page load and on each HMR update |
| Idle | Filled gradient logo | Default state when there are no errors |
| Error | Red pill showing 1 Issue / N Issues | Click the count to open the error panel |
Clicking the badge opens a menu showing the current route type (Static, Dynamic, or Not Found) and a link to the Route Info inspector.
The Preferences popover lets you change the Theme (System, Light, Dark), Position (4 corners), Size (Small, Medium, Large), and record a custom keyboard Shortcut (default Alt+B) to toggle the badge's visibility.
When an error occurs, a full-screen panel opens automatically. It catches runtime errors, unhandled rejections, build errors, and errors reported by your error boundaries.
The panel displays five lines of code around the error, with the failing line clearly marked. Call stacks are mapped back to your original source code.
Application frames are clickable and will open your editor at the exact line. Framework frames are collapsed by default to keep the panel clean.
Uncaught errors and unhandled rejections are captured automatically. To route errors from a React error boundary into the overlay, dispatch a __bini_error__ event:
The overlay also dispatches a __bini_clear_errors__ event on window after every successful HMR update, so your boundary can listen for it to reset itself:
Development overlay for Bini.js: an animated status badge, route inspector, and full-screen error panel.
bini-overlay gives your Bini.js project a polished development experience by replacing Vite's default error screen. It adds a floating status badge, a route inspector, and a full-screen error panel with syntax-highlighted code frames.
>= 18.0.0>= 8.0.0bini-router >= 2.0.0Register the plugin in your Bini.js config. biniOverlay() returns an array of plugins, which Vite automatically flattens, so add it to your plugins array as-is.
To hide the floating badge, set disableBadge to true:
The badge is injected into the page so it never collides with your app's CSS. By default, it sits in the bottom-left corner.
| State | Appearance | Behaviour |
|---|---|---|
| Loading | Logo draws itself with an animation | Plays on page load and on each HMR update |
| Idle | Filled gradient logo | Default state when there are no errors |
| Error | Red pill showing 1 Issue / N Issues | Click the count to open the error panel |
Clicking the badge opens a menu showing the current route type (Static, Dynamic, or Not Found) and a link to the Route Info inspector.
The Preferences popover lets you change the Theme (System, Light, Dark), Position (4 corners), Size (Small, Medium, Large), and record a custom keyboard Shortcut (default Alt+B) to toggle the badge's visibility.
When an error occurs, a full-screen panel opens automatically. It catches runtime errors, unhandled rejections, build errors, and errors reported by your error boundaries.
The panel displays five lines of code around the error, with the failing line clearly marked. Call stacks are mapped back to your original source code.
Application frames are clickable and will open your editor at the exact line. Framework frames are collapsed by default to keep the panel clean.
Uncaught errors and unhandled rejections are captured automatically. To route errors from a React error boundary into the overlay, dispatch a __bini_error__ event:
The overlay also dispatches a __bini_clear_errors__ event on window after every successful HMR update, so your boundary can listen for it to reset itself: