Vida OAuth

Overview

Vida OAuth is a simple authentication provider for React applications. It allows users to authenticate via an external OAuth provider using a pop-up login flow.

Installation

npm install vida-oauth

or using Yarn:

yarn add vida-oauth

Usage

Wrap Your Application with VidaAuthProvider

Wrap your application with the VidaAuthProvider and provide the necessary authentication configuration.

import { VidaAuthProvider } from "vida-oauth";
import AuthComponent from "./AuthComponent";

function App() {
  return (
    <VidaAuthProvider
      clientId="your-client-id"
      clientSecret="your-client-secret"
      redirectUri="http://localhost:3000"
      isLive={false}
    >
      <AuthComponent />
    </VidaAuthProvider>
  );
}

export default App;

Using the useVidaAuth Hook

In your component, you can use the useVidaAuth hook to manage authentication state.

import { useVidaAuth } from "vida-oauth";

function AuthComponent() {
  const { user, login, logout } = useVidaAuth({
    onSuccess: (data) => console.log("Success:", data),
    onError: (error) => console.error("Error:", error),
  });

  return (
    <div>
      {user ? (
        <>
          <p>Welcome, {user.name}</p>
          <button onClick={logout}>Logout</button>
        </>
      ) : (
        <button onClick={login}>Login with Vida</button>
      )}
    </div>
  );
}

export default AuthComponent;

API

VidaAuthProvider

The authentication provider that wraps your application.

Props:

• clientId (string, required) – The client ID for authentication.
• clientSecret (string, required) – The client Secret for authentication.
• isLive (boolean, required) – The authentication environment.
• redirectUri (string, optional) – The redirect URI for OAuth.

useVidaAuth

A hook that provides authentication state and actions.

Returns:

• user (object | null) – The authenticated user.
• login (function) – Triggers the OAuth login flow.
• logout (function) – Logs the user out.

Callbacks:

• onSuccess(data) – Called when authentication succeeds.
• onError(error) – Called when authentication fails.

License

MIT

Contributing

Feel free to open issues and submit pull requests.