diff --git a/API.md b/API.md index 72b88dd..902db1d 100644 --- a/API.md +++ b/API.md @@ -4,15 +4,16 @@ - [AuthProvider](#authprovider) - [Securing routes with Asgardeo](#securing-routes-with-asgardeo) - - [SecureApp](#2-secureapp) - - [AuthenticatedComponent](#3-authenticatedcomponent) + - [SecureApp](#1-secureapp) + - [AuthenticatedComponent](#2-authenticatedcomponent) + - [Bring Your Own Router](#3-bring-your-own-router) - [useAuthContext React Hook](#useauthcontext-react-hook) - [`state` Object](#state-object) - [Consuming the `isLoading` State of the Auth Flow](#consuming-the-isloading-state-of-the-auth-flow) - [List of supported APIs](#list-of-supported-apis) - [signIn](#signin) - [isAuthenticated](#isauthenticated) - - [autoSignIn](#autoSignIn) + - [autoSignIn](#autosignin) - [getBasicUserInfo](#getbasicuserinfo) - [signOut](#signout) - [getIDToken](#getidtoken) @@ -152,23 +153,6 @@ This component is used to wrap the components that need authentication. This off If the user is authenticated, the component renders the wrapped component. If the user is not authenticated, the component renders the `fallback` prop which accepts any **React element**. -### 3. Bring Your Own Router - -It's also possible to implement your own routing logic to secure the protected routes, based on the routing library you use. - -#### React Router - - - -#### Tanstack Router - - - -#### Reach Router - - - - #### Example ```TypeScript import { AuthenticatedComponent } from "@asgardeo/auth-react"; @@ -197,6 +181,63 @@ In this case, `
` and `