@jasonbelmonti/signal-ui
v0.7.1
Published
Signal-driven React and Ant Design UI package for desktop apps.
Downloads
743
Readme
@jasonbelmonti/signal-ui
Signal-driven React and Ant Design UI package for desktop apps.
Development
bun install
bun run storybook
bun run typecheck
bun run buildPushes to main also publish the static Storybook to GitHub Pages via
.github/workflows/storybook-pages.yml, so the theme can be shared without a local build.
The default URL for this repository is https://jasonbelmonti.github.io/signal-ui/.
bun run build emits the consumable package contract in dist/:
dist/index.jsdist/index.d.tsdist/styles.css
dist/ is generated, not checked into git. Local builds, CI, and the release workflow recreate it
from source.
Consumption
When published, install it from npm:
bun add @jasonbelmonti/signal-ui
# or
npm install @jasonbelmonti/signal-uiFor a local checkout, build the package first and then add it as a sibling file dependency:
bun run build{
"dependencies": {
"@jasonbelmonti/signal-ui": "file:../signal-ui"
}
}Import the shared global styles once at the renderer entry, then wrap the app with the provider:
import "@jasonbelmonti/signal-ui/styles.css";
import { AntdThemeProvider } from "@jasonbelmonti/signal-ui";The package exports the provider, theme tokens, shared components including Panel,
PixelCubeLoader, and PixelCubePath, plus procedural audio helpers such as
materializeNoiseCue, playNoiseCue, and primeNoiseEngine.
Release
Create a changeset for any user-facing package change:
bun run changesetVersioning and publishing are handled through GitHub Actions:
bun run version-packagesConfigure the repository NPM_TOKEN secret so the release workflow can publish
@jasonbelmonti/signal-ui to npm after the Changesets version PR merges.
