Skip to content

DEVDOCS-6355 - added pre-render check out pages info to stencil overview #1056

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

DEVDOCS-6355 - added pre-render check out pages info to stencil overview #1056

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
28d8e2b
added pre-render check out pages info to stencil overview
chris-nowicki Aug 19, 2025
5df801c
fixed grammatical errors
chris-nowicki Aug 20, 2025
3cda343
Update docs/storefront/stencil/start/index.mdx
chris-nowicki Aug 20, 2025
9847cde
Merge branch 'main' into DEVDOCS-6355
chris-nowicki Aug 20, 2025
39ae90a
added definition of what pre-rendering is
chris-nowicki Aug 20, 2025
d452517
Updated for non-custom checkout limitation
chris-nowicki Sep 16, 2025
e52eca8
Merge branch 'main' into DEVDOCS-6355
chris-nowicki Sep 16, 2025
a3a9ce8
Update for Vince's Comment
chris-nowicki Sep 16, 2025
86e4fa7
Merge branch 'main' into DEVDOCS-6355
chris-nowicki Sep 16, 2025
d133972
Update for Charles Ho comment
chris-nowicki Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/storefront/stencil/start/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,27 @@ Stencil's use of **YAML Front Matter** allows developers to request only the obj

Stencil themes can access remote objects through event hook and use the hooks to trigger defined events based on shopper behavior. This will allow you to collect product data and optimize a shopper's experience. To facilitate theme-building, BigCommerce provides [stencil-utils](/docs/storefront/stencil/utils/reference) -- a client-side library for managing event hooks.

## Pre-rendered Checkout pages

All stencil themes utilize the [Speculation Rules API](https://developer.mozilla.org/en-US/docs/Web/API/Speculation_Rules_API) to pre-render checkout pages, improving performance and user experience.

**Pre-rendering** means the browser begins loading a page in the background (for example, when a shopper hovers over or is likely to click a checkout link) so that it appears almost instantly when opened.

### Limitations

- Currently only works for non-custom checkout pages.
- Currently only works if the shopper is using Google Chrome and Edge based browsers. Check [browser compatibility](https://developer.mozilla.org/en-US/docs/Web/API/Speculation_Rules_API#browser_compatibility) to see latest browser support.
- Does not work on iOS.
- The checkout won't pre-render if the shopper updates their cart on the cart page.

<Callout type="info">
If you are hosting your own analytics you'll need to make changes to your implementation to ensure compatibility. See our [hosted analytics documentation](https://developer.bigcommerce.com/docs/integrations/hosted-analytics) for more information.
</Callout>

<Callout type="info">
Custom checkout pages are not supported. This includes the B2B Edition checkout and any custom checkout pages built with the [Checkout SDK](https://github.com/bigcommerce/checkout-sdk-js) or forked from [Open Checkout](https://github.com/bigcommerce/checkout-js).
</Callout>

## Blueprint (Legacy framework)


Expand Down