aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/molecules/colophon/colophon.tsx
blob: 9676eb2cb81fba0c548e48350e9e98fff2655f35 (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
import {
  type ForwardRefRenderFunction,
  forwardRef,
  type ReactNode,
} from 'react';
import { List, ListItem, type ListProps } from '../../atoms';
import { NavLink } from '../nav';
import styles from './colophon.module.scss';

export type ColophonLink = {
  id: string;
  href: string;
  label: ReactNode;
};

export type ColophonProps = Omit<ListProps<false, false>, 'children'> & {
  /**
   * The website copyright.
   */
  copyright: ReactNode;
  /**
   * The website license.
   */
  license?: ReactNode;
  /**
   * The colophon links (ie. legal notice)
   */
  links?: ColophonLink[];
};

const ColophonWithRef: ForwardRefRenderFunction<
  HTMLUListElement,
  ColophonProps
> = ({ className = '', copyright, license, links, ...props }, ref) => {
  const colophonClass = `${styles.list} ${className}`;

  return (
    <List
      {...props}
      className={colophonClass}
      isInline
      ref={ref}
      // eslint-disable-next-line react/jsx-no-literals -- Spacing allowed
      spacing="2xs"
    >
      <ListItem className={styles.legal} hideMarker>
        {copyright}
        {license}
      </ListItem>
      {links?.map(({ id, ...link }) => (
        <ListItem key={id}>
          <NavLink {...link} />
        </ListItem>
      ))}
    </List>
  );
};

export const Colophon = forwardRef(ColophonWithRef);