blob: 136571def7e0082734a676934a7673c4c015cced (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
import { FC } from 'react';
import styles from './heading.module.scss';
export type HeadingProps = {
/**
* Adds additional classes.
*/
additionalClasses?: string;
/**
* Use an heading element or only its styles. Default: false.
*/
isFake?: boolean;
/**
* HTML heading level: 'h1', 'h2', 'h3', 'h4', 'h5' or 'h6'.
*/
level: 1 | 2 | 3 | 4 | 5 | 6;
/**
* Adds margin. Default: true.
*/
withMargin?: boolean;
};
/**
* Heading component.
*
* Render an HTML heading element or a paragraph with heading styles.
*/
const Heading: FC<HeadingProps> = ({
children,
additionalClasses,
isFake = false,
level,
withMargin = true,
}) => {
const TitleTag = isFake ? `p` : (`h${level}` as keyof JSX.IntrinsicElements);
const levelClass = `heading--${level}`;
const marginClass = withMargin ? 'heading--margin' : 'heading--regular';
return (
<TitleTag
className={`${styles.heading} ${styles[levelClass]} ${styles[marginClass]} ${additionalClasses}`}
>
{children}
</TitleTag>
);
};
export default Heading;
|