Installation

Package Manager

Install KeycloakVue using your preferred package manager:

npm

npm install keycloak-vue keycloak-js

yarn

yarn add keycloak-vue keycloak-js

pnpm

pnpm add keycloak-vue keycloak-js

TIP

Both keycloak-vue and keycloak-js are required. The official Keycloak JavaScript adapter is a peer dependency.

Requirements

• Vue: 3.5 or higher
• Node.js: 16 or higher (recommended)
• TypeScript: 4.5 or higher (optional, but recommended)

Browser Support

KeycloakVue supports all modern browsers:

• Chrome (latest)
• Firefox (latest)
• Safari (latest)
• Edge (latest)

IE11 Not Supported

Internet Explorer 11 is not supported as Vue 3 requires modern JavaScript features.

TypeScript

KeycloakVue is written in TypeScript and includes complete type definitions. No additional @types packages are needed.

import type { UseKeycloakReturn, KeycloakConfig } from 'keycloak-vue'

CDN

While not recommended for production, you can use KeycloakVue via CDN:

<script src="https://unpkg.com/vue@3"></script>
<script src="https://unpkg.com/keycloak-js/dist/keycloak.min.js"></script>
<script src="https://unpkg.com/keycloak-vue"></script>

Next Steps

Once installed, proceed to Plugin Setup to configure Keycloak in your application.