Skip to content

Commit c28c615

Browse files
authored
Add ability to pass the editable boolean to shopify.dev (#3464)
* Add ability to pass the editable boolean to shopify.dev * Update @shopify/generate-docs to use type from there instead * Add editable to examples too * Temporarily remove my npmrc to it grabs the public package
1 parent 8c2a74f commit c28c615

File tree

4 files changed

+20
-8
lines changed

4 files changed

+20
-8
lines changed

packages/ui-extensions/docs/surfaces/admin/build-docs.mjs

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,15 @@ const transformJson = async (filePath, isExtensions) => {
187187
: templates.default(tab.code, tab.customStyles);
188188

189189
newTabs.push(
190-
{code: tab.code, language: 'html'},
191-
{code: previewHTML, language: 'preview'},
190+
{
191+
code: tab.code,
192+
language: 'html',
193+
editable: tab.editable || false,
194+
},
195+
{
196+
code: previewHTML,
197+
language: 'preview',
198+
},
192199
);
193200
});
194201

@@ -207,7 +214,11 @@ const transformJson = async (filePath, isExtensions) => {
207214
const newTabs = [];
208215

209216
newTabs.push(
210-
{code: tab.code, language: 'html'},
217+
{
218+
code: tab.code,
219+
language: 'html',
220+
editable: tab.editable || false,
221+
},
211222
{code: previewHTML, language: 'preview'},
212223
);
213224

packages/ui-extensions/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@
129129
],
130130
"devDependencies": {
131131
"@remote-ui/async-subscription": "^2.1.16",
132-
"@shopify/generate-docs": "0.19.6",
132+
"@shopify/generate-docs": "0.19.7",
133133
"@quilted/react-testing": "^0.6.11",
134134
"typescript": "^4.9.0",
135135
"@faker-js/faker": "^8.4.1",

packages/ui-extensions/src/surfaces/admin/components/Button/Button.doc.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ const data: AdminReferenceEntityTemplateSchema = {
3232
code: './examples/default.html',
3333
language: 'preview',
3434
layout: 'inline',
35+
editable: true,
3536
},
3637
],
3738
},

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1916,10 +1916,10 @@
19161916
pkg-dir "^5.0.0"
19171917
pluralize "^8.0.0"
19181918

1919-
"@shopify/[email protected].6":
1920-
version "0.19.6"
1921-
resolved "https://registry.yarnpkg.com/@shopify/generate-docs/-/generate-docs-0.19.6.tgz#c7083644f6115b6e138d1022342e284143c2dd0a"
1922-
integrity sha512-pBlE0/ydehfwM+f5d7IXrUbb5yZeC9sivIaU+Thd0ySpoDFhvj93fQNeImmmP5uOndbg8L24y8RNxZ+IAsO5Vg==
1919+
"@shopify/[email protected].7":
1920+
version "0.19.7"
1921+
resolved "https://registry.yarnpkg.com/@shopify/generate-docs/-/generate-docs-0.19.7.tgz#b6a16d24db9a920099f7d524d0db8d4fe4a73331"
1922+
integrity sha512-rQ79OtzcObhcvOUy8Yx3wa2qi4/CwA+LZL2ut9LxlK+9ZQYZE+54/rubuejLdY1AslPZ4+qAMHnRGEI5MfYjcA==
19231923
dependencies:
19241924
"@types/react" "^18.0.21"
19251925
globby "^11.1.0"

0 commit comments

Comments
 (0)