src/components/atoms/visually-hidden/visually-hidden.tsx


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

import type { FC, HTMLAttributes, ReactNode } from 'react';
import styles from './visually-hidden.module.scss';

export type VisuallyHiddenProps = Omit<
  HTMLAttributes<HTMLSpanElement>,
  'children'
> & {
  /**
   * The contents to visually hide.
   */
  children: ReactNode;
};

export const VisuallyHidden: FC<VisuallyHiddenProps> = ({
  children,
  className = '',
  ...props
}) => {
  const wrapperClass = `${styles.wrapper} ${className}`;

  return (
    <span {...props} className={wrapperClass}>
      {children}
    </span>
  );
};