ContextQMD
Back to Vendure

Login

docs/docs/reference/dashboard/extensions-api/login.mdx

3.7.02.6 KB
Original Source

DashboardLoginExtensions

<GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="60" packageName="@vendure/dashboard" since="3.4.0" />

Defines all available login page extensions.

ts
interface DashboardLoginExtensions {
    logo?: LoginLogoExtension;
    beforeForm?: LoginBeforeFormExtension;
    afterForm?: LoginAfterFormExtension;
}
<div className="members-wrapper">

<MemberInfo kind="property" type={<a href='/reference/dashboard/extensions-api/login#loginlogoextension'>LoginLogoExtension</a>} />

Custom logo component to replace the default Vendure logo.

beforeForm

<MemberInfo kind="property" type={<a href='/reference/dashboard/extensions-api/login#loginbeforeformextension'>LoginBeforeFormExtension</a>} />

Component to render before the login form.

afterForm

<MemberInfo kind="property" type={<a href='/reference/dashboard/extensions-api/login#loginafterformextension'>LoginAfterFormExtension</a>} />

Component to render after the login form.

</div> ## LoginLogoExtension <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="11" packageName="@vendure/dashboard" since="3.4.0" />

Defines a custom logo component for the login page.

ts
interface LoginLogoExtension {
    component: React.ComponentType;
}
<div className="members-wrapper">

component

<MemberInfo kind="property" type={React.ComponentType} />

A React component that will replace the default Vendure logo.

</div> ## LoginBeforeFormExtension <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="27" packageName="@vendure/dashboard" since="3.4.0" />

Defines content to display before the login form.

ts
interface LoginBeforeFormExtension {
    component: React.ComponentType;
}
<div className="members-wrapper">

component

<MemberInfo kind="property" type={React.ComponentType} />

A React component that will be rendered before the login form.

</div> ## LoginAfterFormExtension <GenerationInfo sourceFile="packages/dashboard/src/lib/framework/extension-api/types/login.ts" sourceLine="43" packageName="@vendure/dashboard" since="3.4.0" />

Defines content to display after the login form.

ts
interface LoginAfterFormExtension {
    component: React.ComponentType;
}
<div className="members-wrapper">

component

<MemberInfo kind="property" type={React.ComponentType} />

A React component that will be rendered after the login form.

</div>