summaryrefslogtreecommitdiffstats
path: root/src/components/Toolbar
diff options
context:
space:
mode:
Diffstat (limited to 'src/components/Toolbar')
0 files changed, 0 insertions, 0 deletions
'#n56'>56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
import { FC, ReactNode, useId } from 'react';
import styles from './description-list-item.module.scss';

export type ItemLayout = 'inline' | 'inline-values' | 'stacked';

export type DescriptionListItemProps = {
  /**
   * Set additional classnames to the list item wrapper.
   */
  className?: string;
  /**
   * Set additional classnames to the list item description.
   */
  descriptionClassName?: string;
  /**
   * The item label.
   */
  label: string;
  /**
   * The item layout.
   */
  layout?: ItemLayout;
  /**
   * Set additional classnames to the list item term.
   */
  termClassName?: string;
  /**
   * The item value.
   */
  value: ReactNode | ReactNode[];
  /**
   * If true, use a slash to delimitate multiple values.
   */
  withSeparator?: boolean;
};

/**
 * DescriptionListItem component
 *
 * Render a couple of dt/dd wrapped in a div.
 */
const DescriptionListItem: FC<DescriptionListItemProps> = ({
  className = '',
  descriptionClassName = '',
  label,
  termClassName = '',
  value,
  layout = 'stacked',
  withSeparator = false,
}) => {
  const id = useId();
  const layoutStyles = styles[`wrapper--${layout}`];
  const separatorStyles = withSeparator ? styles['wrapper--has-separator'] : '';
  const itemValues = Array.isArray(value) ? value : [value];

  return (
    <div
      className={`${styles.wrapper} ${layoutStyles} ${separatorStyles} ${className}`}
    >
      <dt className={`${styles.term} ${termClassName}`}>{label}</dt>
      {itemValues.map((currentValue, index) => (
        <dd
          key={`${id}-${index}`}
          className={`${styles.description} ${descriptionClassName}`}
        >
          {currentValue}
        </dd>
      ))}
    </div>
  );
};

export default DescriptionListItem;