API Reference

Overview

KeycloakVue provides a comprehensive API for integrating Keycloak authentication into Vue 3 applications.

Main Exports

Functions

• createKeycloakPlugin() - Create Vue plugin
• initKeycloak() - Initialize Keycloak manually
• useKeycloak() - Main composable

Types

See Types for complete type definitions including:

• KeycloakConfig
• KeycloakInitOptions
• KeycloakLoginOptions
• KeycloakLogoutOptions
• KeycloakTokenParsed
• KeycloakProfile
• And many more...

Enums

See Enums for all available enums:

• KeycloakOnLoad
• KeycloakFlow
• KeycloakResponseMode
• KeycloakPkceMethod
• KeycloakAdapterType
• KeycloakPrompt
• KeycloakAction

Constants

See Constants for default values and injection keys:

• DEFAULT_INIT_OPTIONS
• DEFAULT_MIN_VALIDITY
• KEYCLOAK_INJECTION_KEY

Quick Reference

import {
  // Main functions
  createKeycloakPlugin,
  initKeycloak,
  useKeycloak,
  
  // Types
  type KeycloakConfig,
  type KeycloakInitOptions,
  type UseKeycloakReturn,
  
  // Enums
  KeycloakOnLoad,
  KeycloakFlow,
  
  // Constants
  DEFAULT_INIT_OPTIONS,
  KEYCLOAK_INJECTION_KEY
} from 'keycloak-vue'