@payfit/unity-components
Version:
33 lines (32 loc) • 2.04 kB
TypeScript
import { TextProps } from '../../text/Text.js';
export type NavigationCardLabelProps = Omit<TextProps, 'variant' | 'color' | 'className' | 'style'>;
/**
* Displays the primary label text for a NavigationCard component.
* Use this component to provide the main identifying text for your navigation card, which serves as the accessible label for the entire card.
* The label automatically connects to the parent NavigationCard for proper accessibility semantics.
* @param {NavigationCardLabelProps} props - Standard text element props (excluding variant, color, className, and style which are preset)
* @example
* ```tsx
* import { RawNavigationCard, NavigationCardLabel } from '@payfit/unity-components'
*
* function Example() {
* return (
* <RawNavigationCard href="/team">
* <NavigationCardLabel>Team Members</NavigationCardLabel>
* </RawNavigationCard>
* )
* }
* ```
* @remarks
* - Must be used within a `NavigationCard` component to function correctly
* - The label text is styled with the "action" typography variant for consistency
* - Automatically receives proper accessibility IDs from the parent NavigationCard
* - Supports all standard HTML text element props except styling props which are managed by the component
* @see {@link NavigationCardLabelProps} for all available props
* @see Source code in {@link https://github.com/PayFit/hr-apps/tree/master/libs/shared/unity/components/src/components/navigation-card/parts GitHub}
* @see Design specs {@link https://www.figma.com/design/poaMyU7abAgL9VRhx4ygyy/Unity-DS-%3E-Components-Library?node-id=14505-64292 Figma}
* @see Design docs in {@link https://www.payfit.design/ Payfit.design}
* @see Developer docs in {@link https://unity-components.payfit.io/?path=/docs/navigation-navigationcard-navigationcardlabel--docs unity-components.payfit.io}
*/
declare const NavigationCardLabel: import('react').ForwardRefExoticComponent<NavigationCardLabelProps & import('react').RefAttributes<HTMLElement>>;
export { NavigationCardLabel };