1.1.3 • Published 3 years ago

@eduenano27/react-auth-hook v1.1.3

Weekly downloads
-
License
ISC
Repository
gitlab
Last release
3 years ago

React Auth Hook

Install

npm install @eduenano27/react-auth-hook

AuthProvider\ Attributes

AttributeTypeDescriptionDefault
user\User dataundefined
viewsIAuthViewsHook views (internal usage, definition only)-/-
hasUserbooleanHook has userfalse
hasTokenbooleanHook has tokenfalse
handleLogin(props: { token: string, user: T, permissions: string[] }) => voidSet hook data-/-
handleLogout() => voidReset hook data-/-
hasPermission(...permissions: string[]) => booleanUser has permission-/-
hasAnyPermission(...permissions: string[]) => booleanUser has any permission-/-

IAuthViews Attributes

AttributeTypeDescriptionDefault
loginJSX.ElementComponent to render when user is not allowedundefined
dashboardJSX.ElementComponent to render when has not permission / guest is not allowedundefined
loadingJSX.ElementComponent to render when user data is loadingundefined

Example

import React from "react";
import { AuthProvider } from "@eduenano27/react-auth-hook";

export default function AppComponent() {
    return (
        <AuthProvider
            api={ 'auth/user' }
        
            views={{
                loading:    <LoadingComponent/>,

                login:      <Navigate to={ 'login' }/>,
                dashboard:  <Navigate to={ 'dashboard' }/>
            }}
        >
            ...
        </AuthProvider>
    );
}
1.1.3

3 years ago

1.1.2

3 years ago

1.1.1

3 years ago

1.1.0

3 years ago

1.0.0

3 years ago