Skip to content

Commit 0e3dc6e

Browse files
authored
Merge pull request #3569 from Shopify/dc-64kb-limit
Add 64kb limit notes
2 parents 064de12 + 4e64c2d commit 0e3dc6e

File tree

6 files changed

+104
-0
lines changed

6 files changed

+104
-0
lines changed

packages/ui-extensions/docs/surfaces/admin/staticPages/admin-extensions.ext.doc.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,24 @@ If your app is using ESLint, update your configuration to include the new global
200200
},
201201
],
202202
},
203+
{
204+
type: 'Generic',
205+
anchorLink: 'limitations',
206+
title: 'Limitations',
207+
sectionContent: `
208+
As of \`2025-10\`, UI extensions have the following limitations:
209+
- **File size limit**: Extensions are limited to a maximum of 64 KB when deployed. This limit helps ensure fast loading times and optimal performance.
210+
`,
211+
sectionNotice: [
212+
{
213+
title: 'Note',
214+
sectionContent: `
215+
The 64 KB limit applies to the compiled extension bundle size upon deployment.
216+
`,
217+
type: 'info',
218+
},
219+
],
220+
},
203221
{
204222
type: 'Generic',
205223
title: 'Deploying',

packages/ui-extensions/docs/surfaces/checkout/staticPages/overview.doc.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,24 @@ Checkout UI extensions don’t have access to the real checkout DOM and can’t
223223
},
224224
],
225225
},
226+
{
227+
type: 'Generic',
228+
anchorLink: 'limitations',
229+
title: 'Limitations',
230+
sectionContent: `
231+
As of \`2025-10\`, UI extensions have the following limitations:
232+
- **File size limit**: Extensions are limited to a maximum of 64 KB when deployed. This limit helps ensure fast loading times and optimal performance for buyers during checkout.
233+
`,
234+
sectionNotice: [
235+
{
236+
title: 'Note',
237+
sectionContent: `
238+
The 64 KB limit applies to the compiled extension bundle size upon deployment.
239+
`,
240+
type: 'info',
241+
},
242+
],
243+
},
226244
{
227245
type: 'Generic',
228246
anchorLink: 'troubleshooting',

packages/ui-extensions/docs/surfaces/checkout/staticPages/upgrading-to-2025-10.doc.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,22 @@ This guide describes how to upgrade your checkout UI extension to API version \`
2828
],
2929
},
3030
},
31+
{
32+
type: 'Generic',
33+
anchorLink: 'file-size-limit',
34+
title: 'File size limit',
35+
sectionContent:
36+
'As of `2025-10`, UI extensions are subject to a **64 KB file size limit** upon deployment. This limit applies to the compiled extension bundle and is enforced to ensure fast loading times and optimal performance for buyers during checkout.',
37+
sectionNotice: [
38+
{
39+
title: 'Important',
40+
sectionContent: `
41+
If your extension exceeds 64 KB, deployment will fail.
42+
`,
43+
type: 'warning',
44+
},
45+
],
46+
},
3147
{
3248
type: 'GenericAccordion',
3349
anchorLink: 'adjust-dependencies',

packages/ui-extensions/docs/surfaces/customer-account/staticPages/overview.doc.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -281,6 +281,24 @@ Customer account UI extensions don’t have access to the real customer account
281281
},
282282
],
283283
},
284+
{
285+
type: 'Generic',
286+
anchorLink: 'limitations',
287+
title: 'Limitations',
288+
sectionContent: `
289+
As of \`2025-10\`, UI extensions have the following limitations:
290+
- **File size limit**: Extensions are limited to a maximum of 64 KB when deployed. This limit helps ensure fast loading times and optimal performance for customers.
291+
`,
292+
sectionNotice: [
293+
{
294+
title: 'Note',
295+
sectionContent: `
296+
The 64 KB limit applies to the compiled extension bundle size upon deployment.
297+
`,
298+
type: 'info',
299+
},
300+
],
301+
},
284302
{
285303
type: 'Generic',
286304
anchorLink: 'troubleshooting',

packages/ui-extensions/docs/surfaces/customer-account/staticPages/upgrading-to-2025-10.doc.ts

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,22 @@ const data: LandingTemplateSchema = {
2626
],
2727
},
2828
},
29+
{
30+
type: 'Generic',
31+
anchorLink: 'file-size-limit',
32+
title: 'File size limit',
33+
sectionContent:
34+
'As of `2025-10`, UI extensions are subject to a **64 KB file size limit** upon deployment. This limit applies to the compiled extension bundle and is enforced to ensure fast loading times and optimal performance for customers.',
35+
sectionNotice: [
36+
{
37+
title: 'Important',
38+
sectionContent: `
39+
If your extension exceeds 64 KB, deployment will fail.
40+
`,
41+
type: 'warning',
42+
},
43+
],
44+
},
2945
{
3046
type: 'GenericAccordion',
3147
anchorLink: 'adjust-dependencies',

packages/ui-extensions/docs/surfaces/point-of-sale/staticPages/pos-overview.doc.ts

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,24 @@ You can track new releases and update your extensions by referencing the [develo
109109
},
110110
],
111111
},
112+
{
113+
type: 'Generic',
114+
anchorLink: 'limitations',
115+
title: 'Limitations',
116+
sectionContent: `
117+
As of \`2025-10\`, UI extensions have the following limitations:
118+
- **File size limit**: Extensions are limited to a maximum of 64 KB when deployed. This limit helps ensure fast loading times and optimal performance for POS devices.
119+
`,
120+
sectionNotice: [
121+
{
122+
title: 'Note',
123+
sectionContent: `
124+
The 64 KB limit applies to the compiled extension bundle size upon deployment.
125+
`,
126+
type: 'info',
127+
},
128+
],
129+
},
112130
],
113131
};
114132

0 commit comments

Comments
 (0)