Types
Glossary of Types in Checkout components & utilities.
LifecycleStatus
type LifecycleStatus =
| {
statusName: 'init';
statusData: LifecycleStatusDataShared;
}
| {
statusName: 'error';
statusData: TransactionError;
}
| {
statusName: 'fetchingData';
statusData: LifecycleStatusDataShared;
}
| {
statusName: 'ready';
statusData: {
chargeId: string;
contracts: ContractFunctionParameters[];
};
}
| {
statusName: 'pending';
statusData: LifecycleStatusDataShared;
}
| {
statusName: 'success'; // if the last mutation attempt was successful
statusData: {
transactionReceipts: TransactionReceipt[];
chargeId: string;
receiptUrl: string;
};
};
CheckoutButtonReact
type CheckoutButtonReact = {
className?: string;
coinbaseBranded?: boolean;
disabled?: boolean;
icon?: React.ReactNode;
text?: string;
};
CheckoutReact
type CheckoutReact = {
chargeHandler?: () => Promise<string>;
children: React.ReactNode;
className?: string;
isSponsored?: boolean;
onStatus?: (status: LifecycleStatus) => void;
productId?: string;
};
CheckoutStatusReact
type CheckoutStatusReact = { className?: string };