Loading API
The Loading API lets you display a loading indicator in the Shopify admin header. Use this to signal that a page is loading, data is being fetched, or an upload is processing. The indicator appears at the top of the admin and persists until you explicitly stop it.
Anchor to Use casesUse cases
- Page transitions: Show a loading indicator in the Shopify admin during page transitions or route changes.
- Data loading: Indicate data is being fetched from your backend or the Shopify API.
- Upload processing: Signal to merchants that an upload is being processed.
- Async operations: Provide visual feedback during any asynchronous operation that takes time.
Anchor to InputsInputs
The loading function controls the loading indicator in the Shopify admin header. The indicator persists until it's explicitly stopped.
- Anchor to isLoadingisLoadingisLoadingbooleanboolean
Pass
trueto show the loading indicator,falseto hide it.
Was this page helpful?