aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/organisms/widgets/image-widget.tsx
blob: 5de8dd83105feeccc4e16431f461ddef7170d887 (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
66
67
68
69
70
71
72
73
74
import NextImage, { type ImageProps as NextImageProps } from 'next/image';
import type { FC } from 'react';
import { Figure, Link, type FigureProps } from '../../atoms';
import { Collapsible, type CollapsibleProps } from '../../molecules';
import styles from './image-widget.module.scss';

export type Alignment = 'left' | 'center' | 'right';

export type Image = Pick<NextImageProps, 'alt' | 'height' | 'src' | 'width'>;

export type ImageWidgetProps = Omit<
  CollapsibleProps,
  'children' | 'onToggle'
> & {
  /**
   * The content alignment.
   */
  alignment?: Alignment;
  /**
   * Add a caption to the image.
   */
  description?: FigureProps['caption'];
  /**
   * An object describing the image.
   */
  image: Image;
  /**
   * Set additional classnames to the image wrapper.
   */
  imageClassName?: string;
  /**
   * Add a link to the image.
   */
  url?: string;
};

/**
 * ImageWidget component
 *
 * Renders a widget that print an image and an optional text.
 */
export const ImageWidget: FC<ImageWidgetProps> = ({
  alignment = 'left',
  className = '',
  description,
  image,
  imageClassName = '',
  isCollapsed,
  url,
  ...props
}) => {
  const alignmentClass = `widget--${alignment}`;

  return (
    <Collapsible
      {...props}
      className={`${styles[alignmentClass]} ${className}`}
    >
      <Figure
        caption={description}
        className={`${styles.figure} ${imageClassName}`}
        hasBorders
      >
        {url ? (
          <Link href={url}>
            <NextImage {...image} />
          </Link>
        ) : (
          <NextImage {...image} />
        )}
      </Figure>
    </Collapsible>
  );
};