Skip to main content

AssetSizeAppBlockJavascript

Prevents theme app extensions from using JavaScript files and external scripts with a compressed size greater than the configured threshold_in_bytes. Limiting the size of JavaScript files helps to improve the performance of your theme app extension.

You occasionally might need to load large JavaScript bundles. In these cases, you can use an import on interaction pattern to avoid having users who don't interact with a component execute the bundle.


In the following example, the size of assets/chat-widget.js is checked to make sure that it doesn't exceed the specified threshold_in_bytes:

{% schema %}
{
...
"javascript": "chat-widget.js"
}
{% endschema %}

The following example contains the default configuration for this check:

AssetSizeAppBlockJavaScript:
enabled: false
severity: suggestion
threshold_in_bytes: 10_000
ParameterDescription
enabledWhether the check is enabled.
severityThe severity of the check.
threshold_in_bytesThe maximum allowed compressed size, in bytes, for a single JavaScript file. Reflects the suggested limit for theme app extension JavaScript, and includes the app and remote scripts.

Anchor to Disabling this checkDisabling this check

This check is enabled by default when you run the Shopify CLI 3.x build command on an app that contains a theme app extension. This limit is not yet enforced, but disabling this check isn't recommended for theme app extensions.

This check is disabled by default when you run the Shopify CLI 2.x shopify theme check command.


Was this page helpful?