@wordpress/components/src/heading/types.ts

UI components for WordPress.

/**
 * Internal dependencies
 */
import type { Props as TextProps } from '../text/types';

export type HeadingSize =
	| 1
	| 2
	| 3
	| 4
	| 5
	| 6
	| '1'
	| '2'
	| '3'
	| '4'
	| '5'
	| '6';

export type HeadingProps = Omit< TextProps, 'isBlock' | 'color' | 'weight' > & {
	/**
	 * Passing any of the heading levels to `level` will both render the correct
	 * typographic text size as well as the semantic element corresponding to
	 * the level (`h1` for `1` for example).
	 *
	 * @default 2
	 */
	level?: HeadingSize;
	/**
	 * Sets `Heading` to have `display: block`. Note: text truncation only works
	 * when `isBlock` is `false`.
	 *
	 * @default true
	 */
	isBlock?: TextProps[ 'isBlock' ];
	/**
	 * Adjusts the text color.
	 *
	 * @default '#1e1e1e'
	 */
	color?: TextProps[ 'color' ];
	/**
	 * Adjusts font-weight of the text.
	 *
	 * @default '600'
	 */
	weight?: TextProps[ 'weight' ];
};