Blocks / Address field

Address field

A postal address: two lines, postcode, city, country. Typed, with the browser's autocomplete, no lookup and no network.

import { AddressField } from "@forgeron/ui";
/01 → Default
{}
import { AddressField, type FormAddress } from "@forgeron/ui";
import { useState } from "react";

export default function Default() {
  const [address, setAddress] = useState<FormAddress>({});
  return (
    <div style={{ display: "grid", gap: 12 }}>
      <AddressField label="Delivery address" value={address} onChange={setAddress} />
      <pre style={{ margin: 0, font: "12px/18px var(--font-mono)", color: "var(--ink-muted)" }}>
        {JSON.stringify(address)}
      </pre>
    </div>
  );
}
/02 → Countries

Required

Required

import { AddressField } from "@forgeron/ui";

// A list of countries and the problems of a required address, said part by part.
export default function Countries() {
  return (
    <AddressField
      label="Billing address"
      required
      defaultValue={{ line1: "12 Example Street", city: "Lyon" }}
      countries={[
        { value: "France", label: "France" },
        { value: "Belgium", label: "Belgium" },
        { value: "Switzerland", label: "Switzerland" },
      ]}
      errors={{ postcode: "Required", country: "Required" }}
    />
  );
}
API → Props
PropTypeDefaultDescription
labelstring—Names the group for assistive technology: the question.
value / defaultValue{ line1?, line2?, postcode?, city?, country? }—The address. Controlled or not.
onChange(address) => void—After every keystroke.
countries{ value, label }[]—A searchable list for the country; absent, it is typed.
errorsPartial<Record<part, string>>—What is wrong, by part.
requiredboolean—Marks the second line as optional; the rest is expected.
disabledboolean—Locks the fields.
classNamestring—Extra classes.