UNPKG

@payfit/unity-components

Version:

31 lines (30 loc) 1.29 kB
import { TextProps } from '../../text/Text.js'; export interface PageHeadingProps extends Omit<TextProps, 'variant' | 'color'> { /** * The variant of the page heading. * @default 'title' */ variant: 'title' | 'subtitle'; } /** * The PageHeading component provides typography for page titles and subtitles with consistent styling. * * You can create properly styled page titles and subtitles using this component, which ensures correct * font sizes, weights and colors according to the design system. * @param {PageHeadingProps} props - Props for the PageHeading component * @example * ```tsx * import { PageHeading } from '@payfit/unity-components' * * // For main page title * <PageHeading variant="title">Employee Management</PageHeading> * * // For page subtitle * <PageHeading variant="subtitle">View and manage employee information</PageHeading> * ``` * @see {@link PageHeadingProps} for all available props * @remarks * [API](https://unity-components.payfit.io/?path=/docs/layout-page-pageheading--docs) • [Design docs](https://www.payfit.design/24f360409/p/202477-page-header) */ declare const PageHeading: import('react').ForwardRefExoticComponent<PageHeadingProps & import('react').RefAttributes<HTMLHeadingElement>>; export { PageHeading };