aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules/layout/page-header.tsx
blob: 174e246b176245a5dee8f211db7bdc59a6103646 (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
import Heading from '@components/atoms/headings/heading';
import styles from './page-header.module.scss';
import Meta, { type MetaMap } from './meta';
import { FC } from 'react';

export type PageHeaderProps = {
  /**
   * Set additional classnames to the header element.
   */
  className?: string;
  /**
   * The page introduction.
   */
  intro?: string;
  /**
   * The page metadata.
   */
  meta?: MetaMap;
  /**
   * The page title.
   */
  title: string;
};

/**
 * PageHeader component
 *
 * Render a header element with page title, meta and intro.
 */
const PageHeader: FC<PageHeaderProps> = ({
  className = '',
  intro,
  meta,
  title,
}) => {
  return (
    <header className={`${styles.wrapper} ${className}`}>
      <div className={styles.body}>
        <Heading level={1} className={styles.title} withMargin={false}>
          {title}
        </Heading>
        {meta && <Meta data={meta} className={styles.meta} layout="inline" />}
        {intro && <div>{intro}</div>}
      </div>
    </header>
  );
};

export default PageHeader;