import React from 'react';
/**
* Status: *finished*.
* Category: Style
*
* The Heading component should be used for page titles, sub-titles, etc.
* Currently, only h1, h2, h3 and h4 headings have been defined.
*
* Margin for headings should be handled in the components that make use of this component.
* See this sample page that make use of the
* RichText component to style headings in running text.
*
* Heading can be centered by applying heading--centered.
*/
export declare type HeadingTag = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'div' | 'span';
export declare type HeadingSize = 'mega' | 'xxl' | 'xl' | 'l' | 'm' | 's' | 'xs';
export interface HeadingProps {
/**
* This should always be provided. The visual size of the heading. Does not affect the semantic tag. Default size is `xxl` for h1 down to `xs` for h6 tags.
*/
size?: HeadingSize;
/**
* This should always be provided. Use `tag` to select semantic element (h1,h2 etc.) and `size` to set the visual heading size.
*/
tag?: HeadingTag;
/**
* @deprecated Use `tag` to select semantic element (h1,h2 etc.) and `size` to set the visual heading size.
*/
level?: 1 | 2 | 3 | 4 | 5 | 6;
/**
* @deprecated Use `tag` to select semantic element (h1,h2 etc.) and `size` to set the visual heading size.
*/
tagName?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
/**
* Additional custom CSS classes to provide to the component.
*/
className?: string;
id?: string;
/**
* Custom styling set on the Heading component.
*/
style?: React.CSSProperties;
/**
* The contents of the heading tag. `children` and `text` can be used interchangeably.
*/
text?: React.ReactNode;
/**
* The contents of the heading tag. `children` and `text` can be used interchangeably.
*/
children?: React.ReactNode;
/**
* If the Heading is used with a ref, for example to capture focus for accessibility, this should be set to -1
*/
tabIndex?: number;
}
declare const Heading: React.ForwardRefExoticComponent>;
export default Heading;