@stanfordspezi/spezi-web-design-system/dist/src/molecules/DashboardLayout/PageTitle.d.ts

Stanford Biodesign Digital Health Spezi Web Design System

import { ReactNode } from 'react';
interface PageTitleProps {
    /**
     * Main title text.
     */
    title?: ReactNode;
    /**
     * Optional subtitle text.
     */
    subTitle?: ReactNode;
    /**
     * Optional icon to display before the title
     */
    icon?: ReactNode;
}
/**
 * A component for displaying page titles with optional icon and subtitle.
 * Used in the {@link DashboardLayoutProps#title|DashboardLayout's title} slot to provide consistent title styling.
 *
 * @example
 * ```tsx
 * // Basic usage
 * <PageTitle
 *   title="Dashboard"
 *   icon={<Home />}
 * />
 * ```
 *
 * @example
 * ```tsx
 * // Helps to identify a resource
 * <PageTitle
 *   title="Edit user"
 *   subTitle="example@example.com"
 *   icon={<User />}
 * />
 * ```
 */
export declare const PageTitle: ({ title, subTitle, icon }: PageTitleProps) => import("react").JSX.Element;
export {};