@payfit/unity-components
Version:
38 lines (37 loc) • 1.44 kB
TypeScript
import { ComponentPropsWithoutRef, ReactNode } from 'react';
import { EmptyState } from '../EmptyState.js';
export interface EmptyStateUpgradeRequiredProps extends Omit<ComponentPropsWithoutRef<typeof EmptyState>, 'children'> {
/**
* Custom title text. If not provided, uses the default i18n message.
*/
title?: string;
/**
* Description text explaining why an upgrade is required.
* Defaults to placeholder text if not provided.
*/
description?: string;
/**
* Optional action elements (buttons, links) to display.
* Pass Button or Link components as children.
* Typically uses a primary link for the upgrade action.
*/
actions?: ReactNode;
}
/**
* EmptyStateUpgradeRequired is a preset for prompting users to upgrade for feature access.
* It displays a lock icon and provides an optional actions slot.
* @param {EmptyStateUpgradeRequiredProps} props - The component props
* @example
* ```tsx
* import { EmptyStateUpgradeRequired } from '@payfit/unity-components'
*
* <EmptyStateUpgradeRequired
* description="Unlock advanced reporting features with a premium plan."
* actions={
* <Link href="/upgrade">Upgrade now</Link>
* }
* />
* ```
*/
declare const EmptyStateUpgradeRequired: import('react').ForwardRefExoticComponent<EmptyStateUpgradeRequiredProps & import('react').RefAttributes<HTMLDivElement>>;
export { EmptyStateUpgradeRequired };