@payfit/unity-components
Version:
42 lines (41 loc) • 1.51 kB
TypeScript
import { ComponentPropsWithoutRef, ReactNode } from 'react';
import { EmptyState } from '../EmptyState.js';
export interface EmptyStateGetStartedProps extends Omit<ComponentPropsWithoutRef<typeof EmptyState>, 'children'> {
/**
* Custom title text. If not provided, uses the default i18n message.
*/
title?: string;
/**
* Description text providing context about getting started.
* Defaults to placeholder text if not provided.
*/
description?: string;
/**
* Optional action elements (buttons, links) to display.
* Pass Button or Link components as children.
*/
actions?: ReactNode;
}
/**
* EmptyStateGetStarted is a preset for encouraging users to create their first item.
* It displays a puzzle piece icon and provides an optional actions slot for buttons or links.
* @param {EmptyStateGetStartedProps} props - The component props
* @example
* ```tsx
* import { EmptyStateGetStarted, Button } from '@payfit/unity-components'
*
* <EmptyStateGetStarted
* description="Create your first project to get started with the platform."
* actions={
* <>
* <Button variant="ghost" onPress={() => console.log('Create')}>
* Create item
* </Button>
* <Link href="/help">Learn more</Link>
* </>
* }
* />
* ```
*/
declare const EmptyStateGetStarted: import('react').ForwardRefExoticComponent<EmptyStateGetStartedProps & import('react').RefAttributes<HTMLDivElement>>;
export { EmptyStateGetStarted };