An SDK for using FusionAuth in Vue applications.

Table of Contents

- Overview
- Getting Started
- Installation
- Usage
- Configuring the SDK
- Configuring with Nuxt
- useFusionAuth Composable
- State parameter
- UI Components
- Protecting Content
- Pre-built buttons
- Quickstart
- Documentation
- Known Issues
- Releases
- Upgrade Policy

Overview

This SDK provides helpful methods and reactive values that integrate with FusionAuth to help automatically manage authentication state in your Vue app.

Your users will be sent to FusionAuth’s themeable hosted login pages and
then log in. After that, they are sent back to your Vue application.

Once authentication succeeds, the following secure, HTTP-only cookies
will be set:

- app.at - an OAuth Access
Token

- app.rt - a Refresh
Token
used to obtain a new app.at. This cookie will only be set if
refresh tokens are enabled on your FusionAuth instance.

The access token can be presented to APIs to authorize the request and
the refresh token can be used to get a new access token.

There are 2 ways to interact with this SDK:
1. By hosting your own server that performs the OAuth token exchange and meets the server code requirements for FusionAuth Web SDKs.
2. By using the server hosted on your FusionAuth instance, i.e., not writing your own server code.

If you are hosting your own server, see server code requirements.

You can use this library against any version of FusionAuth or any OIDC
compliant identity server.

Getting Started

$3

NPM:

`bash
npm install @fusionauth/vue-sdk
`

Yarn:

`bash
yarn add @fusionauth/vue-sdk
`

Usage

$3

Configure and initialize the FusionAuthVuePlugin when you create your Vue app:

`typescript
import { createApp } from 'vue';
import FusionAuthVuePlugin, { type FusionAuthConfig } from '@fusionauth/vue-sdk';

const config: FusionAuthConfig = {
clientId: "", // Your app's FusionAuth client id
serverUrl: "", // The url of the server that performs the token exchange
redirectUri: "", // The URI that the user is directed to after the login/register/logout action
shouldAutoFetchUserInfo: true, // Automatically fetch userInfo when logged in. Defaults to false.
shouldAutoRefresh: true, // Enables automatic token refresh. Defaults to false.
onRedirect: (state?: string) => { }, // Optional callback invoked upon redirect back from login or register.
}

const app = createApp(App);

app.use(FusionAuthVuePlugin, config);
app.mount('#app')
`

If you want to use the pre-styled buttons, don't forget to import the css file:

`typescript
import '@fusionauth/vue-sdk/dist/style.css';
`

#### Configuring with Nuxt

If you're using the SDK in a nuxt app, pass the useCookie composable into the config object in your plugin definition.

`typescript
import { useCookie } from "#app";

export default defineNuxtPlugin((nuxtApp) => {
nuxtApp.vueApp.use(FusionAuthVuePlugin, {
...config
nuxtUseCookie: useCookie,
});
});
`

##### Alternate ways to define your nuxt plugin

Using createFusionAuth, the SDK can be configured more flexibly.

`typescript
export default defineNuxtPlugin({
setup(nuxtApp) {
const fusionauth = createFusionAuth(config);
nuxtApp.vueApp.use(FusionAuthVuePlugin, { instance: fusionauth })
return {
provide: { fusionauth }
};
},
})
`

$3

You can interact with the SDK by using the useFusionAuth, which leverages Vue's Composition API.
View the full API documentation

`html



`

#### State parameter

The login and register functions accept an optional string parameter: state, which will be passed back to the optional onRedirect callback specified on your FusionAuthConfig. Though you may pass any value you would like for the state parameter, it is often used to indicate which page the user was on before redirecting to login or registration, so that the user can be returned to that location after a successful authentication.

$3

#### Protecting Content

The RequireAuth and RequireAnonymous can be used to restrict content based on authentication and authorization.

`html



`

#### Pre-built buttons

There are three pre-styled buttons that are configured to perform
login/logout/registration. They can be placed anywhere in your app as
is.

`html



`

With the CSS variables, you can customize the buttons to match your app’s style.

Quickstart

See the FusionAuth Vue Quickstart for a full tutorial on using FusionAuth and Vue.

Documentation

Full library documentation

These docs are generated with typedoc and configured with typedoc-plugin-markdown.

Use backticks for code in this readme. This readme is included on the FusionAuth website, and backticks show the code in the best light there.

Known issues

Using shouldAutoRefresh with Nuxt may cause the first refresh attempt to fail with 403, if your plugin instance is instantiated on the server. This is likely because the FusionAuth authorization token is httpOnly and not present in the request sent by the server. Subsequent refresh requests queued up by SDK auto-refreshing should succeed.

You may prefer to invoke initAutoRefresh from the app:beforeMount hook, which runs client-side only.

`typescript
defineNuxtPlugin({
setup: (nuxtApp) => {
const fusionauth = createFusionAuth({
...config,
shouldAutoRefresh: false, // is false by default
});
nuxtApp.vueApp.use(FusionAuthVuePlugin, { instance: fusionauth })
return {
provide: { fusionauth }
};
},
hooks: {
"app:beforeMount"() {
const { $fusionauth } = useNuxtApp();
$fusionauth.initAutoRefresh();
},
}
})
``

Releases

This package is released via GitHub actions.

Upgrade Policy

This library may periodically receive updates with bug fixes, security patches, tests, code samples, or documentation changes.

These releases may also update dependencies, language engines, and operating systems, as we\'ll follow the deprecation and sunsetting policies of the underlying technologies that the libraries use.

This means that after a dependency (e.g. language, framework, or operating system) is deprecated by its maintainer, this library will also be deprecated by us, and may eventually be updated to use a newer version.