blob: c5bf4cac504c95d9edc91cc1fc74c5962c0e5fcb (
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
49
50
51
52
53
54
55
56
57
58
59
60
|
import { FC, ReactNode } from 'react';
import styles from './heading.module.scss';
export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
export type HeadingProps = {
/**
* The heading body.
*/
children: ReactNode;
/**
* Set additional classnames.
*/
className?: string;
/**
* The heading id.
*/
id?: string;
/**
* Use an heading element or only its styles. Default: false.
*/
isFake?: boolean;
/**
* HTML heading level.
*/
level: HeadingLevel;
/**
* Adds margin. Default: true.
*/
withMargin?: boolean;
};
/**
* Heading component.
*
* Render an HTML heading element or a paragraph with heading styles.
*/
const Heading: FC<HeadingProps> = ({
children,
className,
id,
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]} ${className}`}
id={id}
>
{children}
</TitleTag>
);
};
export default Heading;
|
