aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/navbar/navbar.tsx
blob: ee379e9a8d0665fcecef1f0bb5e9033f7520b4ec (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
61
62
63
64
65
import {
  type ForwardRefRenderFunction,
  forwardRef,
  type ReactNode,
} from 'react';
import { List, type ListProps } from '../../atoms';
import { NavbarItem, type NavbarItemProps } from './navbar-item';
import styles from './navbar.module.scss';

export type NavbarItemData = Pick<
  NavbarItemProps,
  | 'icon'
  | 'id'
  | 'isActive'
  | 'label'
  | 'modalHeading'
  | 'modalVisibleFrom'
  | 'onDeactivate'
  | 'onToggle'
  | 'showIconOnModal'
> & {
  contents: ReactNode;
};

export type NavbarItems = [NavbarItemData, NavbarItemData?, NavbarItemData?];

export type NavbarProps = Omit<
  ListProps<false, false>,
  'children' | 'hideMarker' | 'isHierarchical' | 'isInline' | 'isOrdered'
> & {
  /**
   * The navbar items.
   *
   * The number of items should not exceed 3 because of the modal position on
   * small screens.
   */
  items: NavbarItems;
};

const NavbarWithRef: ForwardRefRenderFunction<HTMLUListElement, NavbarProps> = (
  { className = '', items, ...props },
  ref
) => {
  const wrapperClass = `${styles.wrapper} ${className}`;
  const navItems = items.filter(
    (item): item is NavbarItemData => item !== undefined
  );

  return (
    <List {...props} className={wrapperClass} hideMarker isInline ref={ref}>
      {navItems.map(({ contents, ...item }) => (
        <NavbarItem {...item} className={styles.item} key={item.id}>
          {contents}
        </NavbarItem>
      ))}
    </List>
  );
};

/**
 * Navbar component
 *
 * Render the website navbar.
 */
export const Navbar = forwardRef(NavbarWithRef);