NameFields

npx shadcn@latest add https://gear5-ui.vercel.app/r/name-fields.json

"use client";

import { Field } from "./field";
import { cn } from "../lib/cn";
import { useLocale } from "../lib/use-locale";

export interface NameFieldsLabels {
  given: string;
  family: string;
}

const DEFAULT_LABELS: NameFieldsLabels = {
  given: "First name",
  family: "Last name",
};

/**
 * Languages that write the family name first.
 *
 * Covers the East Asian languages that do so as a rule (Japanese, Korean,
 * Chinese and its major varieties, Vietnamese), the European exceptions
 * (Hungarian), and the South Indian and other traditions where the family or
 * house name conventionally precedes the given name.
 *
 * Deliberately a list of languages rather than an attempt at a rule: naming
 * order is a cultural convention, not something derivable from a locale tag,
 * and a wrong guess here reorders a person's own name in front of them.
 */
const FAMILY_FIRST = new Set([
  "ja",
  "ko",
  "zh",
  "yue",
  "wuu",
  "hak",
  "nan",
  "vi",
  "hu",
  "km",
  "mn",
  "bo",
  "ii",
  "ta",
  "te",
  "kn",
  "ml",
]);

export interface NameFieldsProps {
  labels?: Partial<NameFieldsLabels>;
  required?: boolean;
  className?: string;
}

/**
 * Given-name and family-name inputs, ordered the way the reader's locale
 * orders them.
 *
 * A form that hardcodes "First name" then "Last name" asks half the world to
 * enter their name backwards, or to decide which of their names the form
 * considers "first". Order here follows the locale; the labels stay props, so
 * a Japanese form can say 姓 and 名 rather than translated Anglocentric ones.
 *
 * `autoComplete` is `given-name`/`family-name` regardless of visual order —
 * those tokens are semantic, not positional, and password managers rely on it.
 */
export function NameFields({ labels: labelOverrides, required, className }: NameFieldsProps) {
  const labels = { ...DEFAULT_LABELS, ...labelOverrides };
  const { locale } = useLocale();

  const language = locale.toLowerCase().split(/[-_]/)[0];
  const familyFirst = FAMILY_FIRST.has(language);

  const given = (
    <Field
      key="given"
      name="givenName"
      label={labels.given}
      autoComplete="given-name"
      required={required}
    />
  );

  const family = (
    <Field
      key="family"
      name="familyName"
      label={labels.family}
      autoComplete="family-name"
      required={required}
    />
  );

  return (
    <div className={cn("grid gap-4 sm:grid-cols-2", className)}>
      {familyFirst ? [family, given] : [given, family]}
    </div>
  );
}