customer
Ez az oldal még csak angolul érhető el.
The signed-in shopper: customer, addresses, orders, the account area and the sign-in forms.
Ezen az oldalon
import { … } from '@poltura/theme-sdk/customer';Hooks
| Name | What it is |
|---|---|
useCustomer | The signed-in shopper and the way out. |
useAccount | The account area's shell: the shopper and the account navigation, including installed apps' and store features' pages. |
useOrders | One page of the signed-in shopper's order history, newest first. |
useAddresses | The signed-in shopper's address book with the actions that change it. |
useOrder | One of the signed-in shopper's orders. |
useAuthForm | The state of a sign-in, registration or password form, for a theme that draws the form itself. |
useEmailCodeStep | The state of the verify page, for a theme that draws the step of an emailed code itself. |
Parts
| Name | What it is |
|---|---|
AccountDeletion | The account deletion card: what deleting means and the button that asks for it after a confirmation dialog. |
BusinessDetails | The shopper's company details, tier and applications under their own heading; nothing for a consumer-only store and shopper. |
EmailAddress | The shopper's sign-in email address; nothing until the shopper loads. |
PasswordChange | The shopper's password, changed in place or through an emailed link, and the passkeys that sign in without it. |
PersonalInfoForm | The shopper's name and phone number, changed in place; nothing until the shopper loads. |
AddressCard | A saved address: personal or company, the recipient, the address lines, the phone and its default badges. |
AddressForm | The address fields in the page language's name order, limited to the countries the store sells to, with a company tax id. |
AccountNav | The account navigation as a grid of cards: an icon for the kind of page, its name and a line about it. |
OrderCard | An order in a list: its number, status badge, date, product count, amount due, a preview of the products and a link to its page. |
OrderCardSkeleton | A placeholder shaped like OrderCard, for the time the orders load. |
OrderFilters | Buttons that narrow the order list to all orders or one status. |
OrderLines | The products of an order in a table: image, name, variant, quantity and line total. |
OrderDetailScope | Loads one order for the order parts inside; nothing when it is not found. |
OrderSummaryHeader | The order's number, date, status and documents, inside OrderDetailScope. |
OrderItems | The order's products with their digital keys and guides, inside OrderDetailScope. |
OrderTotals | The order's totals, inside OrderDetailScope. |
OrderReturns | The order's returns and the way to start one, inside OrderDetailScope. |
OrderDownloads | The files a paid order unlocks, inside OrderDetailScope. |
OrderInfo | The order's addresses and methods, inside OrderDetailScope. |
MarketingConsentToggle | The switch that subscribes the shopper to or unsubscribes them from marketing email, next to the always-on order updates. |
AuthInput | One field of an auth form: label, icon, input of the right type and autocomplete, and the field's error. |
AuthSubmit | The submit button of an auth form, labelled for the form and disabled while it sends. |
AuthError | Why the form did not send, in a notice box; nothing when there is no error. |
PasskeySignIn | Passkey sign-in button, for the address typed in the form; nothing without browser support. |
SocialSignIn | The external sign-in buttons, with the terms and privacy note; nothing when no provider is on. |
EmailCodeStep | The verify page's whole step: the field for the code from the email, then the password a sign-up chooses, with the button that finishes it. |
AuthFields | The sign-in or sign-up form the merchant placed on the page, drawn through the theme's override of it when there is one; nothing when the merchant hid it. |
BusinessSignUpFields | The company fields of a registration form: buyer type, company, tax number with its live check and tier applications; nothing without BusinessSignUp. |
OrdersScope | Hands a page of orders to the order history block placed inside it, so the section that pages and the block that lists read one page. |
Defaults
| Name | What it is |
|---|---|
AddressBook | The shopper's address book: every saved address, adding, changing and deleting them in dialogs. |
OrderDetail | One order's page: status, documents, products with digital key delivery, totals, returns, downloads and addresses. |
Constants
| Name | What it is |
|---|---|
accountRegions | The account template's regions, where merchants place blocks. |
authRegions | The sign-in and sign-up pages' regions, where merchants place blocks. |
Types
| Name | What it is |
|---|---|
AccountSettingsPartProps | Props of the settings parts, from PersonalInfoForm to AccountDeletion. |
AccountNavItem | One entry of the account navigation. |
AccountNavKind | Which kind of page an account navigation entry opens. |
AccountView | The account area's shell: the shopper and the account navigation. |
Address | A postal address from the shopper's address book or an order. |
AddressBookState | The signed-in shopper's address book with the actions that change it; the host stores every change. |
AddressInput | A postal address as the shopper enters it, before the address book stores it. |
AddressResult | The outcome of an address book action. |
AddressUse | What an address book default is set for. |
AuthField | A field of the sign-in, registration and password forms. |
AuthFormState | A sign-in, registration or password form's values, errors and submit; credentials, captcha and sessions stay with the host. |
AuthMode | Which sign-in form is shown. |
AuthTerms | The terms checkbox a registration form needs ticked before it sends. |
BusinessSignUp | Signing up as a company on a registration form: the buyer type, company and tax number the host checks, and the tier applications. |
Customer | A signed-in shopper. |
CustomerState | The signed-in shopper and the way out. |
EmailCodeKind | The emailed step a shopper finishes on the verify page: a new account, a sign-in, a new password, a moved store account, or an outside account's sign-in. |
EmailCodeStepState | The verify page's state: asking for the code, asking for what finishes the step, or a step that is gone. |
FulfillmentStatus | Where an order's delivery is. |
Order | A placed order as its buyer sees it. |
OrderDocument | A downloadable order document. |
OrderDocumentKind | What kind of document an order has. |
OrderFulfillment | An order's delivery state with its label and tracking. |
OrderLine | One line of a placed order. |
OrderPage | One page of the shopper's orders, newest first. |
OrderPayment | An order's payment state with its label. |
OrderPickupPoint | The parcel locker or pickup point an order is delivered to. |
OrderState | One of the signed-in shopper's orders, as it loads. |
OrderStatus | Where an order is, as the shopper sees it. |
OrderStatusFilter | The order list's status filter. |
OrderSummary | An order as the order list shows it: enough for a card, without the totals breakdown. |
OrderSummaryLine | A line of an order as the order list previews it. |
OrderTracking | One parcel's tracking. |
OrdersRequest | Which page of the order list to load. |
PaymentStatus | Where an order's payment is. |
AddressCardProps | Props of AddressCard. |
AddressFormProps | Props of AddressForm. |
AddressBookProps | Props of AddressBook. |
AccountNavProps | Props of AccountNav. |
OrderCardProps | Props of OrderCard. |
OrderCardSkeletonProps | Props of OrderCardSkeleton. |
OrderFiltersProps | Props of OrderFilters. |
OrderLinesProps | Props of OrderLines. |
OrderDetailProps | Props of OrderDetail. |
OrderDetailScopeProps | Props of OrderDetailScope. |
MarketingConsentToggleProps | Props of MarketingConsentToggle. |
AuthInputProps | Props of AuthInput. |
AuthSubmitProps | Props of AuthSubmit. |
AuthErrorProps | Props of AuthError. |
PasskeySignInProps | Props of PasskeySignIn. |
SocialSignInProps | Props of SocialSignIn. |
EmailCodeStepProps | Props of EmailCodeStep. |
AuthFieldsProps | Props of AuthFields. |
BusinessSignUpFieldsProps | Props of BusinessSignUpFields. |
OrdersScopeProps | Props of OrdersScope. |