@pagamio/frontend-commons-lib
Version:
Pagamio library for Frontend reusable components like the form engine and table container
46 lines (45 loc) • 1.46 kB
TypeScript
/**
* Reusable authentication page layout component with consistent styling and branding.
* Provides a standardized layout for all auth-related pages (login, forgot password, etc.).
*
* @example
* ```tsx
* <AuthPageLayout
* title="Forgot Password"
* subtitle="Enter your email to reset your password"
* errorMessage={error}
* >
* <form>...</form>
* </AuthPageLayout>
* ```
*/
import type { ReactNode } from 'react';
interface AuthPageLayoutProps {
/** Main title/heading for the page */
title: string;
/** Subtitle or description text */
subtitle: string;
appLabel?: string;
/** Error message to display (if any) */
errorMessage?: string | null;
/** Whether to show the logo */
showLogo?: boolean;
/** Logo configuration */
logo?: {
src: string;
alt: string;
width: number;
height: number;
className?: string;
};
/** Whether to render within app layout (adjusts height accordingly) */
renderInAppLayout?: boolean;
/** Custom class names */
className?: string;
/** Child components */
children: ReactNode;
/** Whether to use horizontal layout (image on side) */
horizontal?: boolean;
}
export declare function AuthPageLayout({ title, subtitle, errorMessage, showLogo, logo, renderInAppLayout, className, horizontal, children, appLabel, }: Readonly<AuthPageLayoutProps>): import("react/jsx-runtime").JSX.Element;
export {};