Skip to content

Remove omitAppProvider #6753

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

Merged
merged 3 commits into from
Jul 23, 2022
Merged

Remove omitAppProvider #6753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
23e1b86
Remove omitAppProvider
alex-page Jul 23, 2022
17e6f70
Update polaris-readme-loader.js
alex-page Jul 23, 2022
d3434f2
Create chilly-birds-switch.md
alex-page Jul 23, 2022
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
6 changes: 6 additions & 0 deletions .changeset/chilly-birds-switch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@shopify/polaris': patch
'polaris.shopify.com': patch
---

Remove omitAppProvider front matter
11 changes: 6 additions & 5 deletions polaris-react/.storybook/polaris-readme-loader.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,19 @@ module.exports = function loader(source) {
readme.name,
);

const omitAppProvider = ['Frame', 'AppProvider', 'CustomProperties'].includes(
readme.name,
);

const csfExports = readme.examples.map((example) => {
return `
const ${example.storyName}Component = (${example.code})();
export function ${example.storyName}() {
return <div data-omit-app-provider="${readme.omitAppProvider}"><${
example.storyName
}Component /></div>;
return <${example.storyName}Component />;
}

${example.storyName}.storyName = ${JSON.stringify(example.name)};
${example.storyName}.args = {omitAppProvider: ${readme.omitAppProvider}};
${example.storyName}.args = {omitAppProvider: ${omitAppProvider}};
${example.storyName}.parameters = {
layout: '${hasFullscreenLayout ? 'fullscreen' : 'padded'}',
docs: {
Expand Down Expand Up @@ -253,7 +255,6 @@ function parseCodeExamples(data) {
category: matter.data.category,
component: examples.length ? toPascalCase(matter.data.name) : undefined,
examples,
omitAppProvider: matter.data.omitAppProvider || false,
};
}

Expand Down
1 change: 0 additions & 1 deletion polaris-react/src/components/AppProvider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ keywords:
- application wrapper
- wrapper
- sdk
omitAppProvider: true
---

# App provider
Expand Down
1 change: 0 additions & 1 deletion polaris-react/src/components/CustomProperties/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ keywords:
- color scheme
- light mode
- dark mode
omitAppProvider: true
---

# Custom Properties
Expand Down
1 change: 0 additions & 1 deletion polaris-react/src/components/Frame/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ keywords:
- top bar
- menu
- toast
omitAppProvider: true
---

# Frame
Expand Down
1 change: 0 additions & 1 deletion polaris.shopify.com/src/scripts/migrate-content.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ const migrateFile = async (filePath) => {
const contentNoExample = fileContent
.replace(exampleContent, "")
.replace("---\n\n## Examples", "")
.replace("\nomitAppProvider: true", "")
.replace("\n---", `\n${exampleFrontMatter}\n---`);

fs.writeFileSync(fileDir, contentNoExample);
Expand Down