Skip to main content

Login

LoginLogoExtension​

@vendure/dashboardlogin.ts
v3.4.0

Defines a custom logo component for the login page.

Signature
interface LoginLogoExtension {
    component: React.ComponentType;
}

component​

property
React.ComponentType

A React component that will replace the default Vendure logo.

LoginBeforeFormExtension​

@vendure/dashboardlogin.ts
v3.4.0

Defines content to display before the login form.

Signature
interface LoginBeforeFormExtension {
    component: React.ComponentType;
}

component​

property
React.ComponentType

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

LoginAfterFormExtension​

@vendure/dashboardlogin.ts
v3.4.0

Defines content to display after the login form.

Signature
interface LoginAfterFormExtension {
    component: React.ComponentType;
}

component​

property
React.ComponentType

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

LoginImageExtension​

@vendure/dashboardlogin.ts
v3.4.0

Defines a custom login image component that replaces the default image panel.

Signature
interface LoginImageExtension {
    component: React.ComponentType;
}

component​

property
React.ComponentType

A React component that will replace the default login image panel.

DashboardLoginExtensions​

@vendure/dashboardlogin.ts
v3.4.0

Defines all available login page extensions.

Signature
interface DashboardLoginExtensions {
    logo?: LoginLogoExtension;
    beforeForm?: LoginBeforeFormExtension;
    afterForm?: LoginAfterFormExtension;
    loginImage?: LoginImageExtension;
}
property
LoginLogoExtension

Custom logo component to replace the default Vendure logo.

beforeForm​

property
LoginBeforeFormExtension

Component to render before the login form.

afterForm​

property
LoginAfterFormExtension

Component to render after the login form.

loginImage​

property
LoginImageExtension

Custom login image component to replace the default image panel.