@stihl-design-system/components
Version:
Welcome to the STIHL Design System react component library.
29 lines (28 loc) • 1.08 kB
TypeScript
import { HTMLAttributes, JSX } from 'react';
import { Theme } from '../../types';
import { TitleSize, TitleTag } from './Title.utils';
export interface TitleProps extends HTMLAttributes<HTMLHeadingElement> {
/** Content of the title. */
children: React.ReactNode;
/** Size of the title.
* @default 'x-large'
*/
size?: TitleSize;
/** Specifies the HTML tag to be used for the title.
* @default 'h1'
*/
tag?: TitleTag;
/** Defines the theme.
* @default 'light'
*/
theme?: Theme;
}
/**
* The `DSTitle` component is specifically designed for `h1` and `h2` headlines.
* It's intended for primary emotional headlines that should be prominent,
* accompanied by a stand line for reinforcement.
* The component ensures impactful headline presentation in your application.
*
* Design in Figma: [Title](https://www.figma.com/design/Ie2r0R9QwjEc7O3nrFbXhV/Web-Pattern-Library?node-id=7-77&t=ZOQH7XUcmLFb8aah-11)
*/
export declare const DSTitle: ({ children, className, size, tag, theme, ...rest }: TitleProps) => JSX.Element;