Skip to content

Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.

4.0 KB
Raw Blame
import React from 'react';

import Icon from '@/components/shared/Icon';

/** Button colors. */
export type ButtonColor = 'primary' | 'secondary' | 'danger' | 'success' | 'outline';

/** Button sizes: `md` for in-page actions, `lg` for the main action of the full-screen auth pages. */
export type ButtonSize = 'md' | 'lg';

/** Direction of the arrow a button can show: forward after the label, back before it. */
export type ButtonArrowDirection = 'forward' | 'back';

type ButtonProps = {
  children: React.ReactNode;
  onClick?: () => void;
  isDisabled?: boolean;
  type?: 'button' | 'submit' | 'reset';
  color?: ButtonColor;
  size?: ButtonSize;
  additionalClasses?: string;
  display?: 'inline' | 'flex';
  id?: string;
  arrow?: ButtonArrowDirection;
};

/** Base classes shared by every button-styled element. */
export const BUTTON_BASE_CLASSES = 'max-w-full items-center justify-center gap-2 text-center font-medium rounded-lg focus:outline-none focus:ring-4';

/** Display class of a button: `inline-block` (never `inline`) so a label that wraps keeps one solid box. */
export const getButtonDisplayClass = (display: 'inline' | 'flex'): string => display === 'flex' ? 'flex' : 'inline-block';

/**
 * The padding and text size of a button size.
 * @param size - the size
 */
export const getButtonSizeClasses = (size: ButtonSize): string => size === 'lg' ? 'px-5 py-2 text-base' : 'px-3 py-2 text-sm';
const DISABLED_CLASSES = 'text-white bg-gray-400 cursor-not-allowed';

/**
 * The color classes of a button.
 * @param color - the color
 */
export const getButtonColorClasses = (color: ButtonColor): string => {
  switch (color) {
    case 'primary':
      return 'text-white bg-primary-700 hover:bg-primary-800 focus:ring-primary-300 dark:bg-primary-600 dark:hover:bg-primary-700 dark:focus:ring-primary-800';
    case 'danger':
      return 'text-white bg-red-700 hover:bg-red-800 focus:ring-red-300 dark:bg-red-600 dark:hover:bg-red-700 dark:focus:ring-red-800';
    case 'success':
      return 'text-white bg-green-700 hover:bg-green-800 focus:ring-green-300 dark:bg-green-600 dark:hover:bg-green-700 dark:focus:ring-green-800';
    case 'outline':
      // A ring instead of a border, so the outline button is exactly as tall as the filled ones.
      return 'text-gray-700 bg-white ring-1 ring-inset ring-gray-300 hover:bg-gray-50 focus:ring-gray-200 dark:text-gray-200 dark:bg-gray-800 dark:ring-gray-600 dark:hover:bg-gray-700 dark:focus:ring-gray-700';
    default:
      return 'text-white bg-gray-700 hover:bg-gray-800 focus:ring-gray-300 dark:bg-gray-600 dark:hover:bg-gray-700 dark:focus:ring-gray-800';
  }
};

/**
 * A small arrow icon for a button that moves through a process.
 */
export const ButtonArrow: React.FC<{ direction: ButtonArrowDirection }> = ({ direction }) => (
  <Icon name={direction === 'forward' ? 'arrow-right' : 'arrow-left'} className="w-4 h-4 flex-shrink-0 opacity-80" />
);

/**
 * Button label with an optional arrow, forward after the label and back before it.
 */
export const ButtonLabel: React.FC<{ children: React.ReactNode; arrow?: ButtonArrowDirection }> = ({ children, arrow }) => {
  if (!arrow) {
    return <>{children}</>;
  }
  return (
    <span className="inline-flex items-center justify-center gap-2">
      {arrow === 'back' && <ButtonArrow direction="back" />}
      <span>{children}</span>
      {arrow === 'forward' && <ButtonArrow direction="forward" />}
    </span>
  );
};

/**
 * Generic button.
 */
const Button: React.FC<ButtonProps> = ({ children, onClick, isDisabled = false, type = 'button', color = 'primary', size = 'md', additionalClasses = '', display = 'inline', id, arrow }) => {
  const classes = `${getButtonDisplayClass(display)} ${BUTTON_BASE_CLASSES} ${getButtonSizeClasses(size)} ${isDisabled ? DISABLED_CLASSES : getButtonColorClasses(color)} ${additionalClasses}`.trim();

  return (
    <button type={type} id={id} onClick={isDisabled ? undefined : onClick} disabled={isDisabled} className={classes}>
      <ButtonLabel arrow={arrow}>{children}</ButtonLabel>
    </button>
  );
};

export default Button;