Checkbox Field Input

1
2
3
4
5
6
import { type ClassValue, clsx } from "clsx";
import { twMerge } from "tailwind-merge";
 
export function cn(...inputs: ClassValue[]) {
  return twMerge(clsx(inputs));
}

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
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
"use client";
 
import {
  forwardRef,
  useCallback,
  useId,
  useState,
  type ChangeEvent,
  type ComponentPropsWithoutRef,
} from "react";
 
import { Check } from "lucide-react";
 
import { cn } from "@/lib/cn";
 
export type CheckboxFieldInputProps = Readonly<
  {
    label?: string;
    hint?: string;
    error?: boolean;
    errorMessage?: string;
    containerClassName?: string;
    onCheckedChange?: (checked: boolean, event: ChangeEvent<HTMLInputElement>) => void;
  } & Omit<ComponentPropsWithoutRef<"input">, "size" | "type" | "onChange">
>;
 
export const CheckboxFieldInput = forwardRef<
  HTMLInputElement,
  CheckboxFieldInputProps
>(function CheckboxFieldInput(
  {
    className,
    containerClassName,
    id,
    label = "I agree to the terms and privacy policy",
    hint,
    error = false,
    errorMessage = "You must accept before continuing.",
    disabled,
    required,
    checked,
    defaultChecked = false,
    onCheckedChange,
    ...props
  },
  ref,
) {
  const generatedId = useId();
  const inputId = id ?? generatedId;
  const hintId = `${inputId}-hint`;
  const errorId = `${inputId}-error`;
 
  const isControlled = checked !== undefined;
  const [internal, setInternal] = useState(defaultChecked);
  const isChecked = isControlled ? checked : internal;
 
  const handleChange = useCallback(
    (event: ChangeEvent<HTMLInputElement>) => {
      const next = event.target.checked;
      if (!isControlled) setInternal(next);
      onCheckedChange?.(next, event);
    },
    [isControlled, onCheckedChange],
  );
 
  return (
    <div
      data-slot="checkbox-field-input"
      data-error={error || undefined}
      className={cn("w-full max-w-sm font-sans", containerClassName)}
    >
      <label
        htmlFor={inputId}
        className={cn(
          "flex cursor-pointer items-start gap-3",
          disabled && "cursor-not-allowed opacity-60",
        )}
      >
        <span className="relative mt-0.5 shrink-0">
          <input
            ref={ref}
            id={inputId}
            type="checkbox"
            disabled={disabled}
            required={required}
            checked={isControlled ? isChecked : undefined}
            defaultChecked={isControlled ? undefined : defaultChecked}
            aria-invalid={error || undefined}
            aria-describedby={
              error ? errorId : hint ? hintId : undefined
            }
            onChange={handleChange}
            className={cn(
              "peer absolute size-4 cursor-pointer opacity-0 disabled:cursor-not-allowed",
              className,
            )}
            {...props}
          />
          <span
            aria-hidden
            className={cn(
              "flex size-4 items-center justify-center rounded border transition-[border-color,background-color] duration-200",
              error
                ? "border-rose-300 bg-white peer-focus:border-rose-400"
                : "border-neutral-300 bg-white peer-focus:border-neutral-900",
              "peer-checked:border-neutral-900 peer-checked:bg-neutral-900",
              "peer-disabled:border-neutral-200 peer-disabled:bg-neutral-100",
            )}
          >
            <Check
              size={12}
              strokeWidth={3}
              className={cn(
                "text-white transition-opacity duration-150",
                isChecked ? "opacity-100" : "opacity-0",
              )}
            />
          </span>
        </span>
 
        <span className="min-w-0">
          <span className="block text-sm text-neutral-900">
            {label}
            {required ? (
              <span className="ml-0.5 text-rose-500" aria-hidden>
                *
              </span>
            ) : null}
          </span>
          {hint ? (
            <span id={hintId} className="mt-0.5 block text-xs text-neutral-500">
              {hint}
            </span>
          ) : null}
        </span>
      </label>
 
      {error ? (
        <p id={errorId} role="alert" className="mt-1.5 text-xs text-rose-600">
          {errorMessage}
        </p>
      ) : null}
    </div>
  );
});
 
CheckboxFieldInput.displayName = "CheckboxFieldInput";