commerce-ui advanced
Everything else the package exports, for when you go beyond its components and hooks, such as your own queries or cache updates. Most projects never need these.
Schemas5
createAddressFormSchema | Build the address schema for a config + country. @evolve-storefront/commerce-ui/schemas |
withStrictPhone | Wrap any address schema with strict phone validation. @evolve-storefront/commerce-ui/schemas |
AddressFormSchema | The default-config schema — the public, statically-typed instance consumers already depend on. @evolve-storefront/commerce-ui/schemas |
SALUTATIONS | The salutations the form offers, in menu order. @evolve-storefront/commerce-ui/schemas |
StrictAddressFormSchema | Strict phone variant of the default AddressFormSchema, for the server.@evolve-storefront/commerce-ui/schemas |
Other functions and constants20
layoutForCountry | The layout for a country, falling back to DEFAULT_LAYOUT.@evolve-storefront/commerce-ui/address-config |
resolveFieldRequirement | Resolve one field's requiredness for a country. @evolve-storefront/commerce-ui/address-config |
resolveFieldRequirements | Every field's requiredness for a country, as one map. @evolve-storefront/commerce-ui/address-config |
ADDRESS_LAYOUT | Per-country address layout. @evolve-storefront/commerce-ui/address-config |
COUNTRY_FIELD_RULES | Country-specific requiredness. @evolve-storefront/commerce-ui/address-config |
DEFAULT_ADDRESS_CONFIG | The configuration without an AddressConfigProvider: every ISO country, and the shipped fields and layout.@evolve-storefront/commerce-ui/address-config |
DEFAULT_FIELD_REQUIREMENTS | Requiredness with no provider. @evolve-storefront/commerce-ui/address-config |
DEFAULT_LAYOUT | Street, then number: the Belgian shape, and the one for a country with no entry. @evolve-storefront/commerce-ui/address-config |
LAYOUT_FIELDS | The fields the layout map arranges — name and contact sit outside it. @evolve-storefront/commerce-ui/address-config |
NARROW_FIELDS | Narrow grid columns for the short, fixed-length fields, so a row of street + number + suffix, or postal code + city, keeps its proportions instead of splitting into equal parts. @evolve-storefront/commerce-ui/address-config |
SALUTATIONS | The salutations the form offers, in menu order. @evolve-storefront/commerce-ui/address-form |
createAddressLookup | An AddressLookup on the framework's addressLookup query, for AddressConfigProvider's addressLookup.@evolve-storefront/commerce-ui/address-lookup |
createAddressLookupConfig | Every way of asking the framework for an address, for AddressConfigProvider's addressLookup: postal code and number, then search.@evolve-storefront/commerce-ui/address-lookup |
AddressLookupDocument | The addresses at a postal code and house number; null when it cannot answer.@evolve-storefront/commerce-ui/address-lookup |
AddressResolveDocument | The address behind a suggestion; null when it no longer resolves.@evolve-storefront/commerce-ui/address-lookup |
AddressSuggestDocument | Addresses matching what the shopper has typed; null when it cannot answer.@evolve-storefront/commerce-ui/address-lookup |
localizedCountries | Localized country options: preferred first in its own order, then the rest sorted with Intl.Collator, because alphabetical order differs per locale.@evolve-storefront/commerce-ui/countries |
EEA_COUNTRY_CODES | The EEA: the EU plus Iceland, Liechtenstein and Norway. @evolve-storefront/commerce-ui/countries |
EU_COUNTRY_CODES | The 27 EU member states, post-Brexit — so no GB, which is the mistake this constant exists to stop being made by hand.@evolve-storefront/commerce-ui/countries |
ISO_COUNTRY_CODES | ISO-3166-1 alpha-2 region codes. @evolve-storefront/commerce-ui/countries |
Types30
AddressBookEntry | One saved address, as the book lists it. @evolve-storefront/commerce-ui/address-book |
AddressConfig | @evolve-storefront/commerce-ui/address-config |
AddressEntryMode | How the form asks for the address: postal code and number, a search, or by hand. @evolve-storefront/commerce-ui/address-config |
AddressField | @evolve-storefront/commerce-ui/address-config |
AddressFieldConfig | Per-field configuration. @evolve-storefront/commerce-ui/address-config |
AddressLayout | Rows of field groups; each row renders as one grid row. @evolve-storefront/commerce-ui/address-config |
AddressLookup | Finds the addresses at a postal code and house number. @evolve-storefront/commerce-ui/address-config |
AddressLookupConfig | What the backend can answer. @evolve-storefront/commerce-ui/address-config |
AddressLookupMatch | One address the lookup found, with field names as on an address. @evolve-storefront/commerce-ui/address-config |
AddressLookupQuery | What a lookup is asked: the postal code and house number of one country. @evolve-storefront/commerce-ui/address-config |
AddressResolve | The full address behind a suggestion, or null when it cannot be had.@evolve-storefront/commerce-ui/address-config |
AddressSuggest | Addresses matching what the shopper has typed so far. @evolve-storefront/commerce-ui/address-config |
AddressSuggestion | An address offered while the shopper types, resolved once chosen. @evolve-storefront/commerce-ui/address-config |
AlwaysOnField | Structurally required: may be reordered, never switched off. @evolve-storefront/commerce-ui/address-config |
ConfigurableField | Switchable: a client may turn these off entirely. @evolve-storefront/commerce-ui/address-config |
FieldRequirement | Whether a field is absent, present-and-optional, or present-and-required. @evolve-storefront/commerce-ui/address-config |
FieldSetting | false = off; true = the field's resolved default requiredness.@evolve-storefront/commerce-ui/address-config |
OnRequestField | Optional fields that can wait behind an "Add …" button until the shopper asks. @evolve-storefront/commerce-ui/address-config |
ResolvedAddressConfig | @evolve-storefront/commerce-ui/address-config |
AddressFormBinding | The props a save hook supplies — spread onto <AddressForm>.@evolve-storefront/commerce-ui/address-form |
AddressFormContextValue | Context seeded by AddressForm, so the composed pieces (Fields, Submit) read what they need without prop-drilling.@evolve-storefront/commerce-ui/address-form |
AddressFormInput | @evolve-storefront/commerce-ui/address-form |
Salutation | @evolve-storefront/commerce-ui/address-form |
ApprovalStatus | Mirrors the framework's OrderApprovalStatusType enum verbatim.@evolve-storefront/commerce-ui/approval-status-badge |
CountryCode | A 2-letter ISO-3166-1 alpha-2 region code. @evolve-storefront/commerce-ui/countries |
PaymentMethod | A payment method as the framework offers it. @evolve-storefront/commerce-ui/payment-methods |
PaymentMethodInput | A chosen method, in the shape every payment mutation takes. @evolve-storefront/commerce-ui/payment-methods |
AddressFormInput | @evolve-storefront/commerce-ui/schemas |
Salutation | @evolve-storefront/commerce-ui/schemas |
StrictAddressFormInput | @evolve-storefront/commerce-ui/schemas |
Not listed: 16 props and options types. They appear as the tables on the pages of what they type.