PaymentForm
- Status
- Implemented
- Family
- 3 of 13
- Registry
- @lopifi/payment-form
npx shadcn@latest add @lopifi/theme @lopifi/payment-formThe component, rendering
Real data, the shipped component. Switch the theme to check the claims the spec makes below.
The four-layer spec
amount → payee → method → date → memo. That order — the amount first, because it's what the user came to do and it contextualizes everything after.
- Progressive disclosure: memo, reference, and attachments behind "Add details".
- Validation on blur, never per-keystroke.
- Submit is bottom-anchored on phone, above the safe area and above the keyboard (
visualViewport), always visible. - The submit button states the amount:
Send $12,400.00. - Fee and arrival estimate update live below the amount, with a value crossfade — never a count-up.
Lifted verbatim from Payments. The doc and this page are the same paragraphs, so they cannot disagree.
What lands in your repository
One component is never one file. Everything below is copied into your project, where you own it.
- Files
components/ledger/payment-form.tsx
- Lopifi dependencies · 18
- amount-inputbuttoncnconfirm-payment-dialogcurrency-badgecurrency-selectentity-markfiscal-periodformat-moneyhold-to-confirmiconsmoneymoney.typespayee-selectpayment-method-listreferencetooltipuse-media-query
- npm packages
- @base-ui-components/reactclass-variance-authorityclsxtailwind-merge
- Registry entry
- /r/payment-form.json
The whole component
No compiled bundle, no black box. This is the file the registry copies, and the file you will edit.
"use client";
import * as React from "react";
import { cn } from "@/lib/ledger/cn";
import { formatDate } from "@/lib/ledger/fiscal-period";
import type { MoneyValue } from "@/lib/ledger/money.types";
import { AmountInput } from "@/components/ledger/amount-input";
import { Button } from "@/components/ledger/button";
import { ConfirmPaymentDialog } from "@/components/ledger/confirm-payment-dialog";
import { CurrencySelect } from "@/components/ledger/currency-select";
import { ChevronDownIcon } from "@/components/ledger/icons";
import { Money } from "@/components/ledger/money";
import { type Payee, PayeeSelect } from "@/components/ledger/payee-select";
import { type PaymentMethod, PaymentMethodList } from "@/components/ledger/payment-method-list";
export interface PaymentFormProps {
balance: MoneyValue;
className?: string;
methods: PaymentMethod[];
onSubmit?: (payload: {
amount: number;
currency: string;
payeeId: string;
methodId: string;
date: string;
memo: string;
}) => void;
payees: Payee[];
/** Computed by the caller — components never do arithmetic. */
quote?: (amount: number, methodId: string) => { fee: MoneyValue; arrival: Date };
}
/**
* amount → payee → method → date → memo. That order: the amount is what the
* user came to do, and it contextualizes everything after it.
*
* Validation on blur, never per keystroke. The submit button states the
* amount. On phone the submit is bottom-anchored above the safe area and
* above the keyboard.
*/
export function PaymentForm({ payees, methods, balance, quote, onSubmit, className }: PaymentFormProps) {
const [amount, setAmount] = React.useState<number | null>(null);
const [currency, setCurrency] = React.useState(balance.currency);
const [payeeId, setPayeeId] = React.useState<string | null>(null);
const [methodId, setMethodId] = React.useState(methods[0]?.id ?? "");
const [date, setDate] = React.useState(() => new Date().toISOString().slice(0, 10));
const [memo, setMemo] = React.useState("");
const [reference, setReference] = React.useState("");
const [showDetails, setShowDetails] = React.useState(false);
const [confirming, setConfirming] = React.useState(false);
const payee = payees.find((p) => p.id === payeeId);
const estimate = quote && amount != null ? quote(amount, methodId) : undefined;
const ready = amount != null && amount > 0 && payee != null && methodId !== "";
return (
<form
className={cn("flex flex-col gap-6", className)}
onSubmit={(e) => {
e.preventDefault();
if (ready) setConfirming(true);
}}
>
<div className="flex items-end gap-3">
<AmountInput
className="flex-1"
currency={currency}
max={balance}
onMaxClick={() => setAmount(Number(balance.amount))}
onValueChange={setAmount}
value={amount}
/>
<CurrencySelect
className="mb-1"
onValueChange={setCurrency}
recents={["USD", "EUR", "GBP"]}
value={currency}
/>
</div>
{/* Fee and arrival update live below the amount, with a crossfade —
never a count-up. */}
{estimate ? (
<p
className="ledger-crossfade -mt-4 flex items-center gap-2 text-caption text-text-secondary"
key={`${amount}-${methodId}`}
>
Fee <Money size="xs" tone="inherit" value={estimate.fee} />
<span aria-hidden="true">·</span>
Arrives {formatDate(estimate.arrival)}
</p>
) : null}
<Field label="Recipient">
<PayeeSelect onValueChange={setPayeeId} payees={payees} value={payeeId} />
</Field>
<Field label="Pay from">
<PaymentMethodList methods={methods} onValueChange={setMethodId} value={methodId} />
</Field>
<Field label="Send on">
<input
className="numeric h-10 w-full rounded-sm border border-border bg-surface px-3 text-body outline-none focus-visible:border-accent"
onChange={(e) => setDate(e.target.value)}
type="date"
value={date}
/>
</Field>
{/* Progressive disclosure: memo, reference and attachments. */}
<div>
<button
aria-expanded={showDetails}
className="flex items-center gap-1 text-label font-medium text-accent"
onClick={() => setShowDetails((v) => !v)}
type="button"
>
<ChevronDownIcon
aria-hidden="true"
className={cn(
"size-4 transition-transform duration-2 ease-standard",
showDetails && "rotate-180",
)}
/>
Add details
</button>
{showDetails ? (
<div className="mt-3 space-y-4">
<Field label="Memo">
<input
className="h-10 w-full rounded-sm border border-border bg-surface px-3 text-body outline-none focus-visible:border-accent"
maxLength={140}
onChange={(e) => setMemo(e.target.value)}
value={memo}
/>
</Field>
<Field label="Reference">
<input
className="reference-numeric h-10 w-full rounded-sm border border-border bg-surface px-3 text-body outline-none focus-visible:border-accent"
onChange={(e) => setReference(e.target.value)}
value={reference}
/>
</Field>
</div>
) : null}
</div>
<div
className="sticky bottom-0 -mx-6 border-t border-border-subtle bg-surface px-6 pt-4 md:static md:mx-0 md:border-0 md:px-0 md:pt-0"
style={{ paddingBottom: "max(16px, env(safe-area-inset-bottom))" }}
>
<Button className="w-full" disabled={!ready} size="lg" type="submit" variant="primary">
{amount != null && amount > 0 ? (
<>
Send <Money size="sm" tone="inherit" value={{ amount, currency }} />
</>
) : (
"Send payment"
)}
</Button>
</div>
{ready && payee ? (
<ConfirmPaymentDialog
amount={{ amount: amount ?? 0, currency }}
arrivalDate={estimate?.arrival ?? new Date()}
onConfirm={() =>
onSubmit?.({
amount: amount ?? 0,
currency,
date,
memo,
methodId,
payeeId: payee.id,
})
}
onOpenChange={setConfirming}
open={confirming}
payeeLast4={payee.last4}
payeeName={payee.name}
/>
) : null}
</form>
);
}
function Field({ label, children }: { label: string; children: React.ReactNode }) {
return (
<label className="block">
<span className="mb-2 block text-label font-medium text-text-secondary">{label}</span>
{children}
</label>
);
}
The accounting it encodes
Concepts this component renders. Each one is defined once, in the lexicon, and used identically in the code and the copy.
Also in Payments
- AmountInputThe hardest input in fintech.
- CurrencySelectSearchable, with recents.
- PayeeSelectRecipient picker with fuzzy search and last-paid.
- PaymentMethodListSelectable method cards.
- CheckoutSummaryItemized total with fees and tax.
- ConfirmPaymentDialogAmount, destination, timing. Hold-to-confirm.
- PaymentStatusTimelineSubmitted → sent → settled, with real timestamps.
- PaymentSuccessThe sanctioned delight moment.
- ReceiptSheetPrintable/shareable receipt.
- PayoutScheduleUpcoming payouts calendar.
- CardInputPAN / expiry / CVC with correct autocomplete.
- BankAccountInputRouting + account with checksum validation.
- RecurringScheduleFrequency, end condition, preview of next 3.
See also
A component is specified in one place, defined in another, and running in a third. All three, from here.
- Payments — the family specThe four-layer specification this component was built against, before it was written.Doc
- Payment forms, methods and receiptsThe family running, with real figures in it, in both themes and at every density.Live
- CatalogAll 179 components, specified before they are written.Doc
- PayeeThe party receiving a paymentTerm
Elsewhere in the system
Where PaymentForm sits in the rest of the system — the live section it renders in, the calculators that compute what it displays, and the ledger payloads it is fed from.
Components are copied into your repository and meant to be edited — rounding policy, fiscal calendar and compliance copy differ per company.
Told when Payments changes
Components are copied into your repo, so a fix here does not reach you on its own. One email when a component in this family changes in a way that needs a migration — and nothing when it does not.