A design system for Streamlabs-related products.
Vue 2 (default):
pnpm add streamlabs-beakerVue 3 (opt-in, pre-release):
pnpm add streamlabs-beaker@nextInstall the peer dependencies: fuse.js, vue-final-modal, vue-multiselect, vue-router, and vue-slider-component. vue-final-modal also needs @vueuse/core, @vueuse/integrations, and focus-trap.
Import the Beaker styles and install the plugins that some components rely on. vue-final-modal provides the modals. floating-vue provides the v-tooltip directive that FormGroupH and FormGroupV use for their tooltip prop.
import { createApp } from 'vue';
import { createVfm } from 'vue-final-modal';
import FloatingVue from 'floating-vue';
import App from './App.vue';
import 'streamlabs-beaker/style.css';
import 'vue-final-modal/style.css';
import 'floating-vue/dist/style.css';
createApp(App)
.use(createVfm())
.use(FloatingVue)
.mount('#app');Then import the components you need. With <script setup>, you don't register them:
<script setup lang="ts">
import { Accordion, Button, ProgressBar } from 'streamlabs-beaker';
</script>Publishing is tag-driven: pushing a git tag matching v* triggers .github/workflows/publish.yml.
- Tags starting with
v0.(e.g.v0.11.16) publish to thelatestnpm dist-tag — this is the Vue 2 line, maintained on thev0.xbranch. - Any other tag (e.g.
v1.0.0) publishes to thenextnpm dist-tag — this is the Vue 3 line, developed onmaster.
next will be promoted to latest once Vue 3 is stable enough to become the default install.
Vue 3 (master): releases are cut with a button, not a manual tag push. Go to the repo's Actions tab → Release workflow → Run workflow, pick a bump type (patch/minor/major), and run it. master requires all changes to go through a pull request, so the workflow opens a PR bumping package.json's version rather than pushing to master directly — review and merge that PR to actually cut the release. Merging it triggers .github/workflows/tag-release.yml, which tags the commit and triggers publish.yml above automatically. The docs site on GitHub Pages also redeploys automatically on every push to master, independent of releases.
Vue 2 (v0.x): stays fully manual — bump package.json's version by hand, commit, then git tag v0.x.y && git push --follow-tags to trigger publish.yml.
pnpm installpnpm devpnpm buildpnpm build:publishpnpm lintAutomatic — .github/workflows/deploy-pages.yml rebuilds and redeploys the docs site on every push to master. No manual step needed.