@refine-auth/kinde-react
v1.0.3
Published
Auth provider for refine with Kinde. refine is a React-based framework for building internal tools, rapidly. Kinde is auth provider for easy authentications.
Downloads
693
Maintainers
Readme
@refine-auth/kinde-react
@refine-auth/kinde-react
is an auth provider for refine
to integrate kinde
authentication.
Installation & Usage
You can install the library using npm or yarn:
npm install @refine-auth/kinde-react
# or
yarn add @refine-auth/kinde-react
Add Provider Component
Kinde uses a React Context Provider to maintain its internal state in your application.
Import the Kinde Provider component and wrap your application in it.
import { RefineKindeProvider } from "@refine-auth/kinde-react";
<RefineKindeProvider
clientId="KINDE_CLIENT_ID"
domain="KINDE_DOMAIN"
logoutUri={window.location.origin}
redirectUri={window.location.origin}
>
<App />
</RefineKindeProvider>
Basic Hook Usage
To use authProvider
with Refine App, use Hook.
import { useAuthProvider } from "@refine-auth/kinde-react";
const App = () => {
const { authProvider } = useAuthProvider();
return (
<Refine
authProvider={authProvider}
/* ... */
>
{/* ... */}
</Refine>
);
};
How to use login
Kinde is using redirection based authentication. So, instead of AuthPage
, we just need to use login
method.
import { useLogin } from "@refinedev/core";
const { mutate: login } = useLogin();
// ***
<Button onClick={() => login({redirectPath: "/"})}>
Sign in
</Button>
Properties
The useAuthProvider
hook returns the following properties:
authProvider
(AuthProvider): Object with methods fromAuthBinding
ofrefine
.isLoading
(boolean): A flag that indicates whether authentication is currently being loaded or fetched. You can use this property to conditionally render loading indicators or content.token
(string): Represents authentication token, to be used for API authentications.
Documentation
- For more detailed information and usage, refer to the refine auth provider documentation.
- Refer to documentation for more info about refine
- Step up to refine tutorials.
- To know more on Kinde