go-auth-lib v2.4.3

Go Marketing Auth Library

This is a user account authentication library for Go Marketing apps.\ This library is built with firebase auth backend services.

Quick Start

Install with npm:

npm i go-auth-lib

Usage

import { componentName } from "go-auth-lib";

Required Parameters:

• email
• password
• userName

Required if navigate is used:

• navPath - path to navigate to after successful api call e.g. "/homepage"

Optional Parameters:

• setLoad - implement with React State hook to represent loading
• setStatus - implement with React State hook to set and display results of the functions
• navigate - implement with React Router useNavigate hook to update the location when rendered

register-auth.js

RegisterAuth(email, password, userName, setLoad, setStatus, navigate, navPath)

login-auth.js

LoginAuth(email, password, setLoad, setStatus, navigate, navPath);

logout-auth.js

LogoutAuth(navigate, navPath);

reset-pass.js

ResetPasswordAuth(email, setLoad, setStatus);

verify-current.js

VerifyCurrentUser(navigate, navPath);

protected-route.js

<ProtectedRoute returnPath={"/routePath"}>/*children*/</ProtectedRoute>

Note:

• Protected routes must be wrapped in a router component.

Examples

import { useState } from "react";
import { useNavigate } from "react-router-dom";
import { RegisterAuth } from "go-auth-lib";

export const Signup = () => {
  let navigate = useNavigate();

  const [userName, setUserName] = useState("");
  const [email, setEmail] = useState("");
  const [password, setPassword] = useState("");
  const [status, setStatus] = useState(null);
  const [load, setLoad] = useState(false);

  const handleSubmit = async (e) => {
    e.preventDefault();
    setLoad(true);
    RegisterAuth(email, password, userName, setLoad, setStatus, navigate, "/login");
  };

  /*

  .......

  */

All contents @ 2022 Go Markets. All rights reserved.