UNPKG

@stihl-design-system/components

Version:

Welcome to the STIHL Design System react component library.

27 lines (26 loc) 1.02 kB
import { HTMLAttributes, JSX } from 'react'; import { Theme } from '../../types'; import { HeadingSize, HeadingTag } from './Heading.utils'; export interface HeadingProps extends HTMLAttributes<HTMLHeadingElement> { /** Content within the heading. */ children: React.ReactNode; /** Size of the heading. * @default 'medium' */ size?: HeadingSize; /** Specifies the HTML tag to be used for the heading. * @default 'h2' */ tag?: HeadingTag; /** Defines the theme. * @default 'light' */ theme?: Theme; } /** * The `DSHeading` component is used to specify heading styling and hierarchy in documents. * It allows for consistent heading styles across different parts of your application. * * Design in Figma: [Heading](https://www.figma.com/design/d9wrOp4aCplDsV9AVC87Xn/Typography-%F0%9F%85%B0%EF%B8%8F?node-id=3-2186&t=TeSgud7dB5pnld5s-11) * */ export declare const DSHeading: ({ children, className, size, tag, theme, ...rest }: HeadingProps) => JSX.Element;