Skip to content
GitHubXDiscord

@triggery/vue

Vue 3 bindings for Triggery. Same useEvent / useCondition / useAction shape as @triggery/react, native to Vue’s Composition API and effectScope. Zero runtime dependencies — a thin lifecycle layer over @triggery/core.

npm bundle

pnpm add @triggery/core @triggery/vue vue

Peer deps: vue >= 3.0.0.

ExportPurpose
useEventTyped event emitter, stable function identity.
useConditionRegister a pull-only condition getter. Reads refs naturally.
useActionRegister an action handler. Auto-cleans via onScopeDispose.
useInlineTriggerOne-off triggers inside a <script setup>.
<TriggerRuntimeProvider> / provideTriggerRuntimeInject a runtime via provide/inject.
<TriggerScope> / provideTriggerScopeScope registrations to a feature subtree.

Three small components. The trigger reads like a spec, each component only knows about its own port.

src/triggers/messageTrigger.ts
import { createTrigger } from '@triggery/core';

export type Settings = { sound: boolean; notifications: boolean };

export const messageTrigger = createTrigger<{
  events: { 'new-message': { text: string; author: string } };
  conditions: { settings: Settings };
  actions: { showToast: { title: string; body: string } };
}>({
  id: 'message-received',
  events: ['new-message'],
  required: ['settings'],
  handler({ event, conditions, actions }) {
    if (!conditions.settings.notifications) return;
    actions.showToast?.({
      title: event.payload.author,
      body:  event.payload.text,
    });
  },
});
src/App.vue
<script setup lang="ts">
import { createRuntime } from '@triggery/core';
import { TriggerRuntimeProvider } from '@triggery/vue';
import SettingsProvider from './SettingsProvider.vue';
import Chat from './Chat.vue';
import Toast from './Toast.vue';

const runtime = createRuntime();
</script>

<template>
  <TriggerRuntimeProvider :runtime="runtime">
    <SettingsProvider />
    <Chat />
    <Toast />
  </TriggerRuntimeProvider>
</template>
src/SettingsProvider.vue
<script setup lang="ts">
import { ref } from 'vue';
import { useCondition } from '@triggery/vue';
import { messageTrigger, type Settings } from './triggers/messageTrigger';

const settings = ref<Settings>({ sound: true, notifications: true });
useCondition(messageTrigger, 'settings', () => settings.value);
</script>

<template></template>
src/Chat.vue
<script setup lang="ts">
import { useEvent } from '@triggery/vue';
import { messageTrigger } from './triggers/messageTrigger';

const fire = useEvent(messageTrigger, 'new-message');
</script>

<template>
  <button @click="fire({ text: 'hi', author: 'Alice' })">send</button>
</template>
src/Toast.vue
<script setup lang="ts">
import { useAction } from '@triggery/vue';
import { messageTrigger } from './triggers/messageTrigger';

useAction(messageTrigger, 'showToast', ({ title, body }) => {
  console.log(`[${title}] ${body}`);
});
</script>

<template></template>

Click the button — Toast logs. Toggle settings.value.notifications to false — silent.

Composables work both inside component setup() and inside detached effectScope()s. useCondition does not subscribe via watch — it’s pull-only, so dispatches never re-render the host component. If a component also needs to render the same data, use a normal computed or ref alongside.

Everything auto-cleans via onScopeDispose — works in setup scope, detached scopes, and inside <KeepAlive> correctly.