@toneflix/vue-auth

Vue Authenticator

Advanced authentication plugin for Vue 3.

Documentation

Read the full documentation here: http://greysoft.toneflix.net/vue-auth

Installation

npm install @toneflix/vue-auth
#or
yarn add @toneflix/vue-auth
#or
pnpm add @toneflix/vue-auth

Usage

Registration

To get started with Vue Authenticator, you’ll first need to register the library with your Vue app. This step ensures that authentication methods are available across your application. Here’s how to initialize the library:

main.js or main.ts

import { createApp } from 'vue'
import App from './App.vue'
import { createPinia } from 'pinia'
import { authPlugin } from '@toneflix/vue-auth'

// Create your app instance
const app = createApp(App)

// Initialize Pinia for state management
app.use(createPinia())

// Register Vue Authenticator with custom configuration
const authenticator = authPlugin({
  baseUrl: 'https://your-api.com',
  endpoints: {
    login: '/auth/login',
    register: '/auth/register',
    logout: '/auth/logout'
  },
  storageKey: 'auth_token', // The key used to store the token in localStorage
  transformResponse: (data) => ({ user: data.data, token: data.token }) // Customize the response handling
})

app.use(authenticator)

// Mount the app
app.mount('#app')

Usage

Once registered, Vue Authenticator is now ready to handle authentication across your application.

SomeLoginPage.vue

<script setup>
import { reactive, ref } from 'vue'
import { useAuth } from '@toneflix/vue-auth'
import { useRouter } from 'vue-router'

const router = useRouter()
const { login } = useAuth()

const form = reactive({ email: 'test@example.com', password: 'password' })
const data = ref({ user: {}, token: null, error: null })

const handleLogin = async () => {
  data.value = await login(form)
  if (!data.value.error) router.replace('/auth/profile')
}
</script>

<template>
  <div class="column-container">
    <input v-model="form.email" placeholder="Email Address" />

    <p class="error" v-if="data.error?.email">
      {{ data.error.errors.email }}
    </p>

    <input v-model="form.password" placeholder="Password" type="password" />

    <p class="error" v-if="data.error?.password">
      {{ data.error.errors.password }}
    </p>

    <button @click="handleLogin">Login</button>
  </div>
</template>

Inline Mode Usage

The useInlineAuth composable extends and shares all methods that are available from the useAuth composable and is the recommended way to use the plugin.

SomeLoginPage.vue

<script setup lang="ts">
import { reactive } from 'vue'
import { useInlineAuth } from '@toneflix/vue-auth'
import { useRouter } from 'vue-router'

const router = useRouter()
const { login } = useInlineAuth()

const form = reactive({ email: '', password: '' })

const { error, send, onSuccess, onError } = login(form)

onSuccess(() => {
  router.replace('/auth/profile')
})

onError((error) => {
  console.log(error)
})
</script>

<template>
  <div class="login-container">
    <input v-model="form.email" placeholder="Email Address" />
    <p class="error" v-if="error?.errors?.email">{{ error.errors.email }}</p>

    <input v-model="form.password" placeholder="Password" type="password" />
    <p class="error" v-if="error?.errors?.password">{{ error.errors.password }}</p>

    <button @click="send">Login</button>
  </div>
</template>

For full usage and implementation details visit the documentation page

TODO

1. Add form reset handler