aboutsummaryrefslogtreecommitdiffstats
path: root/src/components/atoms/notice/notice.tsx
blob: 0c8a60c2cf39b4f0a248895a87f09c0e81a5a9fe (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
import type { FC, HTMLAttributes, ReactNode } from 'react';
import styles from './notice.module.scss';

export type NoticeKind = 'error' | 'info' | 'success' | 'warning';

export type NoticeProps = Omit<HTMLAttributes<HTMLElement>, 'children'> & {
  /**
   * The notice body.
   */
  children: ReactNode;
  /**
   * The notice kind.
   */
  kind: NoticeKind;
};

/**
 * Notice component
 *
 * Render a colored message depending on notice kind.
 */
export const Notice: FC<NoticeProps> = ({
  className = '',
  children,
  kind,
  ...props
}) => {
  const kindClass = styles[`notice--${kind}`];
  const noticeClass = `${styles.notice} ${kindClass} ${className}`;

  return (
    <div {...props} className={noticeClass}>
      {children}
    </div>
  );
};