@fixwire/vue

Fixwire SDK for Vue

Welcome to @fixwire/vue, the official Vue SDK for Fixwire: the errors Vue catches (renders, watchers, lifecycle hooks, event handlers), with their component, and pages and navigations named after vue-router's routes (/users/:id). It builds on @fixwire/browser and exports all of it. It is part of the Fixwire SDK for JavaScript, whose README has the full guide. For Nuxt, use @fixwire/nuxt.

📦 Getting started

Prerequisites

• A Fixwire account and project: sign up at fixwire.io.
• Vue 3.3 or newer; vue-router 4 or 5 for route names (CI tests both).

Installation

npm install @fixwire/vue
pnpm add @fixwire/vue
yarn add @fixwire/vue

Basic configuration

// src/main.ts
import { createApp } from "vue";
import * as Fixwire from "@fixwire/vue";
import App from "./App.vue";
import router from "./router";

const app = createApp(App);
app.use(router);

Fixwire.init({
  app,
  router,
  dsn: "https://<publishable key>@ingest.eu.fixwire.io",
  release: "web@1.4.0",
  tracesSampleRate: 0.2, // record 20% of page loads and navigations
});

app.mount("#app");

Call init() before mount(), so errors in the first render are reported too. The DSN is your project's publishable key and the ingest host; the key is safe in a bundle. Without a DSN, the SDK does nothing. init() never throws: a broken DSN or option is said in a warning on the console and the SDK stays off.

Quick usage example

<script setup lang="ts">
import * as Fixwire from "@fixwire/vue";

async function pay() {
  try {
    await charge();
  } catch (error) {
    Fixwire.captureException(error); // handled: the page carries on
  }
}

function checkout() {
  throw new Error("Checkout failed"); // Vue catches it, Fixwire reports it
}
</script>

✨ Why Fixwire

• Errors carry their place. The component, its parents and where in it (render, setup, a hook, an event handler) come with every error Vue catches; the route it happened on is its transaction.
• Your handler keeps working. An errorHandler the app set stays and runs after Fixwire's; without one, errors are still logged as Vue logs them.
• Secrets stay in the browser. Props are sent only with attachProps: true, and secrets and personal data are masked before sending.
• It never gets in your app's way. Reporting never throws, and the SDK stays small (about 20 KB gzipped, tracing included).
• Your data stays where you want it. Fixwire keeps it in the region you choose for your project: the EU today, more regions soon.

🧩 Integrations

⚙️ Configuration

init() takes the browser SDK's options, listed in the repository README, and:

For hosts that hand Vue's errors over another way, captureVueError(error, vm, info) reports one with the same context. @fixwire/vue/shared has the parts that don't need the browser SDK (reporting Vue's errors, naming routes), for server rendering.

🧪 Examples

• vue: an app made with create-vue (Vue 3, vue-router 5, Vite), whose pages, buttons and router guard fail on purpose; its test builds it for production and checks what Fixwire receives in Chromium.

📚 Documentation

The full guide lives in the repository README and the examples.

• Configuration
• Examples
• Changelog
• Security policy
• Contributing guide

🚧 Coming from another error tracker?

init({ app, router }), attachErrorHandler and browserTracingIntegration({ router }) work the way most error-tracking SDKs' Vue packages do. npx @fixwire/cli migrate . shows the changes and --write makes them.

🙌 Want to contribute?

We'd love your help, whether it's a bug report, a fix or a new integration. Start with the contributing guide, then pick from the open issues or the good first issues.

🛟 Need help?

• Questions: ask on Discord or Slack.
• Bugs: open a GitHub issue.
• Found a security issue? Please don't open an issue; follow the security policy.

🔗 Resources

• Website
• Pricing
• Discord
• Slack
• (https://fixwire.io/x)
• Changelog
• Examples
• Security policy

📃 License

The SDK is open source under the MIT license; see LICENSE. Parts are derived from other MIT-licensed SDKs; see NOTICE.

😘 Contributors

Thanks to everyone who helps make Fixwire better!