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

Stanford Biodesign Digital Health Spezi Web Design System

import { ComponentProps, ReactNode } from 'react';
import { Button } from '../../components/Button';
/**
 * Icon component for the 404 not found state.
 */
export declare const NotFoundIcon: ({ className, ...props }: Omit<ComponentProps<"div">, "children">) => import("react").JSX.Element;
/**
 * Container component that centers and arranges not found content vertically.
 */
export declare const NotFoundContainer: ({ className, ...props }: ComponentProps<"div">) => import("react").JSX.Element;
/**
 * Title component for the not found state.
 * Displays the main error message.
 */
export declare const NotFoundTitle: ({ className, ...props }: ComponentProps<"h1">) => import("react").JSX.Element;
/**
 * Paragraph component for the not found state.
 * Provides additional context and instructions to the user.
 */
export declare const NotFoundParagraph: ({ className, ...props }: ComponentProps<"p">) => import("react").JSX.Element;
interface NotFoundActionProps extends ComponentProps<typeof Button> {
}
/**
 * Action component that provides navigation options from the not found state.
 * Renders as a small button.
 */
export declare const NotFoundAction: (props: NotFoundActionProps) => import("react").JSX.Element;
export interface NotFoundProps {
    /**
     * Configures where the user should go instead.
     *
     * @example
     * ```ts
     * { name: "users list", href: "/user" }
     * ```
     */
    backPage: {
        name: ReactNode;
        href: string;
    };
    /**
     * Singular name of accessed entity.
     * @example "user"
     */
    entityName: ReactNode;
    className?: string;
}
/**
 * A complete 404 page component for handling non-existent resources.
 *
 * Ensures consistent error messaging and clear navigation options.
 *
 * @example
 * ```ts
 * // Basic usage
 * <NotFound
 *   entityName="user"
 *   backPage={{ name: "users list", href: "/users" }}
 * />
 * ```
 */
export declare const NotFound: ({ backPage, entityName, className, }: NotFoundProps) => import("react").JSX.Element;
export {};