The address create modal is used to create a new address.

Loading...

Usage

import React from "react";

import {

AddressCreateModal,

PelcroModalController,

usePelcro,

} from "@pelcro/react-pelcro-js";

import "@pelcro/react-pelcro-js/dist/pelcro.css";

export const AddressCreateExample = () => {

const { switchView } = usePelcro();

return (

<>

<button onClick={() => switchView("address-create")}>

Create an address

</button>

<PelcroModalController>

<AddressCreateModal />

</PelcroModalController>

</>

);

};

Reference

Props

onDisplay

() ⇒ void

Callback function called when the modal is first displayed.

onClose

() ⇒ void

Callback function called when the modal is closed.

onSuccess

(userObject) ⇒ void

Callback function called when the address is created succesfully.

onGiftRedemptionSuccess

(userObject) ⇒ void

Callback function called when the user is redeeming a gift, and the gift is redeemed succesfully.

onFailure

(errorObject) ⇒ void

Callback function called when the address creation / gift redemption fails.

type

"shipping"|"billing"

Address type, default is "shipping".