Skip to main content
Version: 3.xx.xxSwizzle Ready

<AuthPage>

<AuthPage> component from refine for Material UI contains authentication pages that can be used to login, register, forgot password and update password.

Before using <AuthPage> component you need to add authProvider that will be used to handle authentication.

Swizzle

You can swizzle this component to customize it with the refine CLI

Usage​

<AuthPage> component can be used like below πŸ‘‡πŸ»

http://localhost:3000
import { Refine } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
routerProvider={{
...routerProvider,
routes: [
{
path: "/register",
element: <AuthPage type="register" />,
},
{
path: "/forgot-password",
element: <AuthPage type="forgotPassword" />,
},
],
}}
authProvider={authProvider}
LoginPage={AuthPage}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

Types​

<AuthPage> component has the following types:

Login​

login will be used as the default type of the <AuthPage> component. The login page will be used to log in to the system.

http://localhost:3000/login
import { Refine } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
routerProvider={routerProvider}
authProvider={authProvider}
LoginPage={AuthPage}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

Register​

The register page will be used to register new users. You can use the following props for the <AuthPage> component when the type is "register":

http://localhost:3000/register
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{
path: "/register",
element: <AuthPage type="register" />,
},
],
}}
LoginPage={AuthPage}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

ForgotPassword​

The forgotPassword type is a page that allows users to reset their passwords. You can use this page to reset your password.

http://localhost:3000/forgot-password
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{
path: "/forgot-password",
element: <AuthPage type="forgotPassword" />,
},
],
}}
LoginPage={AuthPage}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

UpdatePassword​

The updatePassword type is the page used to update the password of the user.

http://localhost:3000/update-password
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{
path: "/update-password",
element: <AuthPage type="updatePassword" />,
},
],
}}
LoginPage={AuthPage}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

Props​

providers​

info

providers property is only available for types login and register.

providers property defines the list of providers used to handle login authentication. providers accepts an array of Provider type. Check out the Interface section for more information.

http://localhost:3000/login
import { Refine, useRouterContext, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={routerProvider}
LoginPage={() => (
<AuthPage
providers={[
{
name: "google",
icon: GoogleIcon,
label: "Sign in with Google",
},
{
name: "github",
icon: GithubIcon,
label: "Sign in with GitHub",
},
]}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

rememberMe​

info

rememberMe property is only available for type login.

rememberMe property defines to render your own remember me component or you can pass false to don't render it.

http://localhost:3000/login
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout, Form, FormControlLabel, Checkbox } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";
import { useFormContext } from "@pankod/refine-react-hook-form";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const RememberMe = () => {
const { register } = useFormContext();

return (
<FormControlLabel
sx={{
span: {
fontSize: "12px",
color: "text.secondary",
},
}}
color="secondary"
control={
<Checkbox
size="small"
id="rememberMe"
{...register("rememberMe")}
/>
}
label="Remember me"
/>
);
};

const App = () => {
return (
<Refine
routerProvider={routerProvider}
authProvider={authProvider}
LoginPage={() => (
<AuthPage
rememberMe={<RememberMe />}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};
info

loginLink property is only available for types register and forgotPassword.

loginLink property defines the link to the login page and also you can give a node to render. Default value is "/login".

http://localhost:3000/register
import { Refine, useRouterContext } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const Auth = (props) => {
const { Link } = useRouterContext();

return (
<AuthPage
{...props}
loginLink={
<span
style={{
border: "1px dashed cornflowerblue",
padding: 3,
}}
>
<Link to="/login">Login</Link>
</span>
}
/>
);
};

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{
path: "/register",
element: <Auth type="register" />,
},
],
}}
LoginPage={Auth}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};
info

registerLink property is only available for type login.

registerLink property defines the link to the registration page and also you can give a node to render. Default value is "/register".

http://localhost:3000/login
import { Refine, useRouterContext } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const Auth = (props) => {
const { Link } = useRouterContext();

return (
<AuthPage
{...props}
registerLink={
<div
style={{
border: "1px dashed cornflowerblue",
marginTop: 5,
padding: 5,
}}
>
<Link to="/register">Register</Link>
</div>
}
/>
);
};

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{ path: "/register", element: <Auth type="register" /> },
]
}}
LoginPage={Auth}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};
info

forgotPasswordLink property is only available for type login.

forgotPasswordLink property defines the link to the forgot password page and also you can give a node to render. Default value is "/forgot-password".

http://localhost:3000/login
import { Refine, useRouterContext } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const Auth = (props) => {
const { Link } = useRouterContext();

return (
<AuthPage
{...props}
forgotPasswordLink={
<div
style={{
border: "1px dashed cornflowerblue",
marginTop: 5,
padding: 5,
}}
>
<Link to="/register">Forgot Password</Link>
</div>
}
/>
);
};

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={{
...routerProvider,
routes: [
{ path: "/forgot-password", element: <Auth type="forgotPassword" /> },
]
}}
LoginPage={Auth}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

wrapperProps​

wrapperProps uses for passing props to the wrapper component. In the example below you can see that the background color is changed with wrapperProps

http://localhost:3000/login
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
authProvider={authProvider}
routerProvider={routerProvider}
LoginPage={() => (
<AuthPage
wrapperProps={{
style: {
background: "#331049",
},
}}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

contentProps​

contentProps uses for passing props to the content component which is the card component. In the example below you can see that the title, header and content styles are changed with contentProps.

http://localhost:3000/login
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
routerProvider={routerProvider}
authProvider={authProvider}
LoginPage={() => (
<AuthPage
contentProps={{
title: "Login",
headStyle: {
background: "cornflowerblue",
color: "white",
},
bodyStyle: {
background: "#673ab742",
},
}}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

formProps​

formProps uses for passing props to the form component. In the example below you can see that the initialValues are changed with formProps and also the onSubmit function is changed.

http://localhost:3000/login
import { Refine, useNavigation } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
routerProvider={routerProvider}
authProvider={authProvider}
LoginPage={() => (
<AuthPage
formProps={{
onSubmit: (formValues) => {
alert(JSON.stringify(formValues, null, 2));
},
defaultValues: {
email: "test@mail.com",
},
}}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

renderContent​

renderContent uses to render the form content. You can use this property to render your own content or renderContent gives you default content you can use to add some extra elements to the content.

http://localhost:3000/login
import { Refine, useRouterContext } from "@pankod/refine-core";
import { AuthPage, Layout } from "@pankod/refine-mui";
import routerProvider from "@pankod/refine-react-router-v6";

import { authProvider } from "./authProvider";
import { DashboardPage } from "./pages/dashboard";

const App = () => {
return (
<Refine
routerProvider={routerProvider}
authProvider={authProvider}
LoginPage={() => (
<AuthPage
contentProps={{
style: {
width: "400px",
},
}}
renderContent={(content: React.ReactNode) => {
return (
<div
style={{
display: "flex",
flexDirection: "column",
justifyContent: "center",
alignItems: "center",
}}
>
<h1 style={{ color: "white" }}>Extra Header</h1>
{content}
<h1 style={{ color: "white" }}>Extra Footer</h1>
</div>
);
}}
/>
)}
DashboardPage={DashboardPage}
Layout={Layout}
resources={[{ name: "posts" }]}
/>
);
};

API Reference​

Properties​

Interface​

interface IProvider {
name: string;
icon?: React.ReactNode;
label?: string;
}
import { UseFormProps } from "@pankod/refine-react-hook-form";

interface FormPropsType extends UseFormProps {
onSubmit?: (values: any) => void;
}