SDK

Vue SDK

@authon/vue — Authon認証のためのVue 3プラグイン、コンポーザブル、コンポーネント。Composition APIと <script setup>.

npm: @authon/vueVue 3+TypeScript

インストール

bash

npm install @authon/vue

プラグイン設定

アプリエントリーファイルにAuthon Vueプラグインを登録。これにより、すべてのファイルでインポートせずにすべてのコンポーザブルとコンポーネントをグローバルに使用できます。

src/main.ts

import { createApp } from "vue";
import { AuthonPlugin } from "@authon/vue";
import App from "./App.vue";
import router from "./router";

const app = createApp(App);

app.use(router);
app.use(AuthonPlugin, {
  publishableKey: "pk_live_your_publishable_key",

  // Optional — override API base URL
  apiUrl: "https:1

  2
  theme: "auto",

  3
  locale: "en",
});

app.mount("#app");

コンポーザブル

useAuthon()

認証アクションのメインコンポーザブル。リアクティブなrefsと非同期メソッドを返します。

components/Header.vue

<template>
  <header>
    <nav v-if="!isLoading">
      <template v-if="isSignedIn">
        <span>Hello, {{ user?.displayName }}</span>
        <button @click="signOut">Sign out</button>
      </template>
      <template v-else>
        <button @click="openSignIn">Sign in</button>
        <button @click="openSignUp">Sign up</button>
      </template>
    </nav>
  </header>
</template>

<script setup lang="ts">
import { useAuthon } from "@authon/vue";

const {
  isSignedIn,
  isLoading,
  user,
  openSignIn,
  openSignUp,
  signOut,
  getToken,
} = useAuthon();
</script>

useUser()

ユーザーデータの読み取りに集中したコンポーザブル。プロファイル情報のみを表示するコンポーネントで便利。

<template>
  <div v-if="!isLoading && user" class="profile">
    <img v-if="user.avatarUrl" :src="user.avatarUrl" :alt="user.displayName ?? 0" />
    <h2>{{ user.displayName }}</h2>
    <p>{{ user.email }}</p>
  </div>
</template>

<script setup lang="ts">
import { useUser } from "@authon/vue";

const { user, isLoading } = useUser();
</script>

コンポーネント

プラグインのインストール時にすべてのAuthon Vueコンポーネントがグローバルに登録されます。名前の競合を避けるために Authon プレフィックスが付いています。

AuthonSignedIn / AuthonSignedOut

認証状態に基づいてスロットコンテンツを表示または非表示にする条件付きラッパー。

App.vue

<template>
  <div>
    <AuthonSignedIn>
      <!-- Rendered only when user is signed in -->
      <Dashboard />
      <AuthonUserButton />
    </AuthonSignedIn>

    <AuthonSignedOut>
      <!-- Rendered only when user is NOT signed in -->
      <LandingPage />
    </AuthonSignedOut>
  </div>
</template>

<template>
  <div>
    <!-- Popup mode — opens modal on mount -->
    <AuthonSignIn mode="popup" />
    <AuthonSignUp mode="popup" />

    <!-- Embedded mode — renders inline form container -->
    <AuthonSignIn mode="embedded" />
  </div>
</template>

AuthonUserButton

サインアウトドロップダウン付きのドロップインアバターボタン。ユーザーがサインインしていない場合は何もレンダリングしません。

<template>
  <header class="app-header">
    <AppLogo />
    <AuthonUserButton />
  </header>
</template>

ルーターガード

authonGuard で認証が必要なルートを保護。 meta.requiresAuth:

src/router/index.ts

import { createRouter, createWebHistory } from "vue-router";
import { authonGuard } from "@authon/vue";
import Home from "@/views/Home.vue";
import Dashboard from "@/views/Dashboard.vue";
import Settings from "@/views/Settings.vue";

const router = createRouter({
  history: createWebHistory(),
  routes: [
    {
      path: "/",
      component: Home,
    },
    {
      path: "/dashboard",
      component: Dashboard,
      meta: { requiresAuth: true },
    },
    {
      path: "/settings",
      component: Settings,
      meta: { requiresAuth: true },
    },
  ],
});

// Redirect to /sign-in when meta.requiresAuth is true and user is not signed in
router.beforeEach(authonGuard({ signInPath: "/sign-in" }));

export default router;

トークンの使用

getToken() の useAuthon() でAPIリクエストにJWTを添付：

<script setup lang="ts">
import { useAuthon } from "@authon/vue";
import { ref, onMounted } from "vue";

const { getToken } = useAuthon();
const items = ref([]);

onMounted(async () => {
  const token = getToken();
  const res = await fetch("/api/items", {
    headers: {
      Authorization: token ? `Bearer ${token}` : "",
    },
  });
  items.value = await res.json();
});
</script>