@baseplate-dev/ui-components
Version:
Shared UI component library
25 lines • 836 B
TypeScript
import React from 'react';
interface ErrorDisplayProps {
/**
* Optional class name to be applied to the loader or error div
*/
className?: string;
/**
* Header to be displayed (if not passed, a generic error header will be displayed)
*/
header?: React.ReactNode;
/**
* Error to be displayed (if a string is passed, it will be displayed as-is, otherwise a generic error message will be displayed)
*/
error?: unknown;
/**
* Optional actions to be displayed below the error message
*/
actions?: React.ReactNode;
}
/**
* Displays a generic error state with a header and error message.
*/
declare function ErrorDisplay({ className, header, error, actions, }: ErrorDisplayProps): React.ReactElement;
export { ErrorDisplay };
//# sourceMappingURL=error-display.d.ts.map