Skip to content

Commit 9edddf7

Browse files
committed
Refactor order success functions to use 'Checkout' terminology
Updated function names and exports in commerce-checkout and commerce-checkout-success modules to replace 'Order' with 'Checkout' for consistency. Adjusted README documentation accordingly to reflect these changes.
1 parent d199df0 commit 9edddf7

File tree

3 files changed

+15
-15
lines changed

3 files changed

+15
-15
lines changed

blocks/commerce-checkout-success/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,19 +29,19 @@ No localStorage keys are used by this block.
2929
## Public API
3030

3131
- `default export decorate(block)` — Renders the success view into the provided block element.
32-
- `export async function renderOrderSuccess(container, { orderData } = {})` — Renders the success view into `container`. Pass `orderData` to provide pre-fetched order data; otherwise the Order drop-in will fetch it when possible (not possible when placing an order as a guest using an email address that’s already associated with an existing account).
33-
- `export function preloadOrderSuccess()` — Preloads the order success CSS. Call this before `renderOrderSuccess`.
32+
- `export async function renderCheckoutSuccess(container, { orderData } = {})` — Renders the success view into `container`. Pass `orderData` to provide pre-fetched order data; otherwise the Order drop-in will fetch it when possible (not possible when placing an order as a guest using an email address that’s already associated with an existing account).
33+
- `export function preloadCheckoutSuccess()` — Preloads the checkout success CSS. Call this before `renderCheckoutSuccess`.
3434

3535
Example (programmatic):
3636

3737
```js
38-
import { preloadOrderSuccess, renderOrderSuccess } from './blocks/commerce-checkout-success/commerce-checkout-success.js';
38+
import { preloadCheckoutSuccess, renderCheckoutSuccess } from './blocks/commerce-checkout-success/commerce-checkout-success.js';
3939

4040
// Load CSS
41-
preloadOrderSuccess();
41+
preloadCheckoutSuccess();
4242

4343
// Pass pre-fetched order data
44-
await renderOrderSuccess(container, { orderData });
44+
await renderCheckoutSuccess(container, { orderData });
4545
```
4646

4747
## Behavior
@@ -111,7 +111,7 @@ Add the block to your confirmation page template:
111111
<div class="block commerce-checkout-success"></div>
112112
```
113113

114-
When used via the decorator system, the block will automatically render the confirmation experience into the block container. For programmatic usage, use the `renderOrderSuccess` export and pass `orderData`.
114+
When used via the decorator system, the block will automatically render the confirmation experience into the block container. For programmatic usage, use the `renderCheckoutSuccess` export and pass `orderData`.
115115

116116
## File Structure
117117

blocks/commerce-checkout-success/commerce-checkout-success.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ async function renderOrderConfirmationFooterButton(container) {
216216
})(container);
217217
}
218218

219-
async function renderOrderSuccessContent(container, { orderData } = {}) {
219+
async function renderCheckoutSuccessContent(container, { orderData } = {}) {
220220
// Scroll to top on success view
221221
window.scrollTo(0, 0);
222222

@@ -263,14 +263,14 @@ async function renderOrderSuccessContent(container, { orderData } = {}) {
263263
await renderOrderConfirmationFooterButton($continueBtn);
264264
}
265265

266-
export function preloadOrderSuccess() {
266+
export function preloadCheckoutSuccess() {
267267
return loadCSS(`${window.hlx.codeBasePath}/blocks/commerce-checkout-success/commerce-checkout-success.css`);
268268
}
269269

270-
export async function renderOrderSuccess(container, { orderData } = {}) {
271-
return renderOrderSuccessContent(container, { orderData });
270+
export async function renderCheckoutSuccess(container, { orderData } = {}) {
271+
return renderCheckoutSuccessContent(container, { orderData });
272272
}
273273

274274
export default async function decorate(block) {
275-
await renderOrderSuccessContent(block);
275+
await renderCheckoutSuccessContent(block);
276276
}

blocks/commerce-checkout/commerce-checkout.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,10 +77,10 @@ import '../../scripts/initializers/checkout.js';
7777
import '../../scripts/initializers/order.js';
7878
import '../../scripts/initializers/payment-services.js';
7979

80-
// Order success block import and CSS preload
81-
import { renderOrderSuccess, preloadOrderSuccess } from '../commerce-checkout-success/commerce-checkout-success.js';
80+
// Checkout success block import and CSS preload
81+
import { renderCheckoutSuccess, preloadCheckoutSuccess } from '../commerce-checkout-success/commerce-checkout-success.js';
8282

83-
preloadOrderSuccess();
83+
preloadCheckoutSuccess();
8484

8585
export default async function decorate(block) {
8686
// Container and component references
@@ -363,7 +363,7 @@ export default async function decorate(block) {
363363

364364
window.history.pushState({}, '', url);
365365

366-
await renderOrderSuccess(block, { orderData });
366+
await renderCheckoutSuccess(block, { orderData });
367367
}
368368

369369
events.on('authenticated', handleAuthenticated);

0 commit comments

Comments
 (0)