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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
|
import {
createElement,
ForwardedRef,
forwardRef,
ForwardRefRenderFunction,
ReactNode,
} from 'react';
import styles from './heading.module.scss';
export type HeadingLevel = 1 | 2 | 3 | 4 | 5 | 6;
export type HeadingProps = {
/**
* The title alignment. Default: left;
*/
alignment?: 'center' | 'left';
/**
* 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;
};
type TitleTagProps = Pick<HeadingProps, 'children' | 'className' | 'id'> & {
tagName: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'p';
};
const TitleTag = forwardRef<
HTMLHeadingElement | HTMLParagraphElement,
TitleTagProps
>(
(
{ children, tagName, ...props },
ref: ForwardedRef<HTMLHeadingElement | HTMLParagraphElement>
) => {
return createElement(tagName, { ...props, ref }, children);
}
);
TitleTag.displayName = 'TitleTag';
/**
* Heading component.
*
* Render an HTML heading element or a paragraph with heading styles.
*/
const Heading: ForwardRefRenderFunction<
HTMLHeadingElement | HTMLParagraphElement,
HeadingProps
> = (
{
alignment = 'left',
children,
className,
id,
isFake = false,
level,
withMargin = true,
},
ref: ForwardedRef<HTMLHeadingElement | HTMLParagraphElement>
) => {
const tagName = isFake ? 'p' : (`h${level}` as TitleTagProps['tagName']);
const levelClass = `heading--${level}`;
const alignmentClass = `heading--${alignment}`;
const marginClass = withMargin ? 'heading--margin' : 'heading--regular';
return (
<TitleTag
tagName={tagName}
className={`${styles.heading} ${styles[levelClass]} ${styles[alignmentClass]} ${styles[marginClass]} ${className}`}
id={id}
ref={ref}
>
{children}
</TitleTag>
);
};
export default forwardRef(Heading);
|
