aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/layout/cards-list.tsx
blob: 4f920e8edd3c795c7b0f94f8ce6125ee53047395 (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 type { FC, ReactElement } from 'react';
import { List, ListItem } from '../../atoms';
import type { CardProps } from '../../molecules';
import styles from './cards-list.module.scss';

export type CardsListItem = {
  /**
   * The card.
   */
  card: ReactElement<CardProps<string> | CardProps<undefined>>;
  /**
   * The card id.
   */
  id: string;
};

export type CardsListProps = {
  /**
   * Set additional classnames to the list wrapper.
   */
  className?: string;
  /**
   * Should the cards list be ordered?
   *
   * @default false
   */
  isOrdered?: boolean;
  /**
   * The cards data.
   */
  items: CardsListItem[];
};

/**
 * CardsList component
 *
 * Return a list of Card components.
 */
export const CardsList: FC<CardsListProps> = ({
  className = '',
  isOrdered = false,
  items,
}) => {
  const kindModifier = `wrapper--${isOrdered ? 'ordered' : 'unordered'}`;

  return (
    <List
      className={`${styles.wrapper} ${styles[kindModifier]} ${className}`}
      hideMarker
      isInline
      isOrdered={isOrdered}
    >
      {items.map(({ id, card }) => (
        <ListItem className={styles.item} key={id}>
          {card}
        </ListItem>
      ))}
    </List>
  );
};