createPublicSignInApp()

Home > @backstage/frontend-defaults > createPublicSignInApp

Creates an app that is suitable for the public sign-in page, for use in the index-public-experimental.tsx file.

Signature:

function createPublicSignInApp(options?: CreateAppOptions): {
    createRoot(): React.JSX.Element;
};

Parameters

Parameter	Type	Description
options	CreateAppOptions	(Optional)

Returns:

{ createRoot(): React.JSX.Element; }

Remarks

This app has an override for the app/layout extension, which means that most extension typically installed in an app will be ignored. However, you can still for example install API and root element extensions.

A typical setup of this app will only install a custom sign-in page.

Example

const app = createPublicSignInApp({
  features: [signInPageModule],
});