Skip to main content

Interface: AddressCardProps

Defined in: components/AddressCard.tsx:17

Properties​

address​

address: Address | CartAddress | WarehouseAddress | OrderAddress | null

Defined in: components/AddressCard.tsx:22

The address to display (Address | CartAddress | WarehouseAddress | OrderAddress)

addressType?​

optional addressType?: string

Defined in: components/AddressCard.tsx:103

Address type for new addresses (e.g., 'DELIVERY', 'INVOICE'). Used when creating, not editing.

afterDelete?​

optional afterDelete?: (addressId) => void

Defined in: components/AddressCard.tsx:79

Called after address deletion completes

Parameters​

addressId​

Address

Returns​

void

afterEdit?​

optional afterEdit?: (address) => void | Promise<void>

Defined in: components/AddressCard.tsx:73

Called after address edit completes

Parameters​

address​

Address

Returns​

void | Promise<void>

afterSetDefault?​

optional afterSetDefault?: (address) => void

Defined in: components/AddressCard.tsx:85

Called after address is set as default

Parameters​

address​

Address

Returns​

void

beforeSave?​

optional beforeSave?: () => void

Defined in: components/AddressCard.tsx:115

Called before save starts

Returns​

void

children?​

optional children?: ReactNode

Defined in: components/AddressCard.tsx:124

Compound mode opt-in for the read-only card region. When provided, the read-only card renders the compound subtree (using <AddressCard.X> subcomponents) instead of the default layout. Edit forms / modals stay monolithic regardless.

countries?​

optional countries?: object[]

Defined in: components/AddressCard.tsx:88

List of countries for the country dropdown [{code: 'NL', name: 'Netherlands'}, ...]

code​

code: string

name​

name: string

enableActions?​

optional enableActions?: boolean

Defined in: components/AddressCard.tsx:55

Display action buttons (edit, delete, set default)

Default​

true

enableDelete?​

optional enableDelete?: boolean

Defined in: components/AddressCard.tsx:61

Display Delete button

Default​

true

enableEdit?​

optional enableEdit?: boolean

Defined in: components/AddressCard.tsx:58

Display Edit button

Default​

true

enableSetDefault?​

optional enableSetDefault?: boolean

Defined in: components/AddressCard.tsx:64

Display Set Default button

Default​

true

graphqlClient?​

optional graphqlClient?: GraphQLClient

Defined in: components/AddressCard.tsx:19

GraphQL client for the Propeller SDK (only needed when editing)

inline?​

optional inline?: boolean

Defined in: components/AddressCard.tsx:100

When true, renders the form inline instead of in a modal overlay.

Default​

false

isNew?​

optional isNew?: boolean

Defined in: components/AddressCard.tsx:94

When true, renders in "new address" mode: auto-opens the edit form, hides the card body

labels?​

optional labels?: Record<string, string>

Defined in: components/AddressCard.tsx:112

Labels for form fields and buttons

onCancel?​

optional onCancel?: () => void

Defined in: components/AddressCard.tsx:97

Called when the form is cancelled in new mode

Returns​

void

onDelete?​

optional onDelete?: (addressId) => void

Defined in: components/AddressCard.tsx:76

Called when address is deleted; receives the address ID

Parameters​

addressId​

Address

Returns​

void

onEdit?​

optional onEdit?: (address) => void | Promise<void>

Defined in: components/AddressCard.tsx:70

Called when address is edited; receives the updated address object

Parameters​

address​

Address

Returns​

void | Promise<void>

onSetDefault?​

optional onSetDefault?: (address) => void

Defined in: components/AddressCard.tsx:82

Called when address is set as default

Parameters​

address​

Address

Returns​

void

showCity?​

optional showCity?: boolean

Defined in: components/AddressCard.tsx:43

Display city

Default​

true

showCompanyName?​

optional showCompanyName?: boolean

Defined in: components/AddressCard.tsx:25

Display company name

Default​

true

showCountry?​

optional showCountry?: boolean

Defined in: components/AddressCard.tsx:46

Display country name

Default​

true

showDefaultBadge?​

optional showDefaultBadge?: boolean

Defined in: components/AddressCard.tsx:67

Display the "Default ... Address" badge

Default​

false

showEmail?​

optional showEmail?: boolean

Defined in: components/AddressCard.tsx:49

Display email

Default​

false

showFullName?​

optional showFullName?: boolean

Defined in: components/AddressCard.tsx:31

Display full name

Default​

true

showIcp?​

optional showIcp?: boolean

Defined in: components/AddressCard.tsx:106

Show ICP/ICS (intra-community supply) checkbox.

Default​

false

showNumberExtension?​

optional showNumberExtension?: boolean

Defined in: components/AddressCard.tsx:37

Display house number and extension

Default​

true

showPhone?​

optional showPhone?: boolean

Defined in: components/AddressCard.tsx:52

Display phone

Default​

false

showPostalCode?​

optional showPostalCode?: boolean

Defined in: components/AddressCard.tsx:40

Display postal code

Default​

true

showSalutation?​

optional showSalutation?: boolean

Defined in: components/AddressCard.tsx:28

Display salutation (Mr./Mrs.)

Default​

true

showStreet?​

optional showStreet?: boolean

Defined in: components/AddressCard.tsx:34

Display street

Default​

true

title?​

optional title?: string

Defined in: components/AddressCard.tsx:109

Title for the form or section

user?​

optional user?: Contact | Customer | null

Defined in: components/AddressCard.tsx:118

The authenticated user (needed by useAddress for SDK operations)