@payfit/unity-components
Version:
32 lines (31 loc) • 1.04 kB
TypeScript
import { ReactNode } from 'react';
import * as React from 'react';
export interface DefinitionItemProps {
/**
* The term of the definition (label).
*/
term: string;
/**
* Optional content displayed next to the term (e.g., an action button).
*/
termSuffix?: ReactNode;
/**
* The description content associated with the term.
*/
description?: ReactNode;
/**
* Children of the component.
*/
children?: ReactNode;
/**
* The vertical alignment of the term.
* Note: Normally, you should not need to set this property, if you follow the design guidelines.
* @default 'undefined'
*/
verticalAlign?: 'start' | 'center';
}
/**
* DefinitionItem displays a term (`dt`) and its description (`dd`) within a `DefinitionList`.
* It adapts its layout based on the context provided by `DefinitionList`.
*/
export declare const DefinitionItem: React.ForwardRefExoticComponent<Omit<DefinitionItemProps, "children"> & React.RefAttributes<HTMLDivElement>>;