Skip to content
This repository was archived by the owner on Jan 6, 2026. It is now read-only.

Commit 8044489

Browse files
authored
[Contextual banners + Interstitial Modal] Add Polaris React Deprecation Elements (#14148)
### WHY are these changes introduced? We've moved over to Polaris Web Components, we need a way to make it clear that the default way to built Shopify apps is now the Web components and that Polaris React is now deprecated. ### WHAT is this pull request doing? This adds an interstitial page that occurs on each new session prompting users to use Polaris Web Components, an alternative to use Polaris React still remains. A contextual banner is added on the page of components that are available as Web components. The banner includes the new component name (e.g. s-button) + a link to the Web component documentation of that specific component. ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#install-dependencies-and-build-workspaces) 🗒 [General tophatting guidelines](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md) 📄 [Changelog guidelines](https://github.com/Shopify/polaris/blob/main/.github/CONTRIBUTING.md#changelog) ### 🎩 checklist - [ ] Tested a [snapshot](https://github.com/Shopify/polaris/blob/main/documentation/Releasing.md#-snapshot-releases) - [ ] Tested on [mobile](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting.md#cross-browser-testing) - [ ] Tested on [multiple browsers](https://help.shopify.com/en/manual/shopify-admin/supported-browsers) - [ ] Tested for [accessibility](https://github.com/Shopify/polaris/blob/main/documentation/Accessibility%20testing.md) - [ ] Updated the component's `README.md` with documentation changes - [ ] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide
1 parent fb50966 commit 8044489

56 files changed

Lines changed: 2304 additions & 9 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.changeset/twelve-trees-play.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

polaris.shopify.com/content/components/actions/account-connection.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Account connection
33
shortDescription: Used for connecting or disconnecting a store to various accounts, like Facebook for the sales channel.
44
category: Actions
5+
webComponent:
6+
name: Account connection
7+
url: https://shopify.dev/docs/api/app-home/patterns/compositions/account-connection
8+
type: pattern
59
keywords:
610
- AccountConnection
711
- connect
@@ -29,6 +33,13 @@ The account connection component is used so merchants can connect or disconnect
2933

3034
</Lede>
3135

36+
<WebComponentBanner
37+
componentName={frontmatter.title}
38+
webComponentName={frontmatter.webComponent.name}
39+
webComponentUrl={frontmatter.webComponent.url}
40+
type={frontmatter.webComponent.type}
41+
/>
42+
3243
<Examples />
3344

3445
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/actions/button-group.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Button group
33
shortDescription: Displays multiple related actions stacked or in a horizontal row for arrangement and spacing.
44
category: Actions
5+
webComponent:
6+
name: s-button-group
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/actions/buttongroup
8+
type: polaris
59
keywords:
610
- ButtonGroup
711
- choices
@@ -39,6 +43,13 @@ Button group displays multiple related actions stacked or in a horizontal row to
3943

4044
</Lede>
4145

46+
<WebComponentBanner
47+
componentName={frontmatter.title}
48+
webComponentName={frontmatter.webComponent.name}
49+
webComponentUrl={frontmatter.webComponent.url}
50+
type={frontmatter.webComponent.type}
51+
/>
52+
4253
<Examples />
4354

4455
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/actions/button.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Button
33
shortDescription: Used primarily for actions like 'Add', 'Close', 'Cancel', or 'Save'. Plain buttons are used for less important actions.
44
category: Actions
5+
webComponent:
6+
name: s-button
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/button
8+
type: polaris
59
keywords:
610
- CTA
711
- call to action
@@ -83,10 +87,17 @@ previewImg: /images/components/actions/button.png
8387

8488
<Lede>
8589

86-
Buttons are used primarily for actions, such as Add”, “Close”, “Cancel, or Save. Plain buttons, which look similar to links, are used for less important or less commonly used actions, such as view shipping settings.
90+
Buttons are used primarily for actions, such as "Add", "Close", "Cancel", or "Save". Plain buttons, which look similar to links, are used for less important or less commonly used actions, such as "view shipping settings".
8791

8892
</Lede>
8993

94+
<WebComponentBanner
95+
componentName={frontmatter.title}
96+
webComponentName={frontmatter.webComponent.name}
97+
webComponentUrl={frontmatter.webComponent.url}
98+
type={frontmatter.webComponent.type}
99+
/>
100+
90101
<Examples />
91102

92103
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/feedback-indicators/badge.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Badge
33
shortDescription: Used to inform merchants of the tone of an object or an action taken.
44
category: Feedback indicators
5+
webComponent:
6+
name: s-badge
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/titles-and-text/badge
8+
type: polaris
59
keywords:
610
- pills
711
- tone indicators
@@ -59,6 +63,13 @@ Badges are used to inform merchants of the tone of an object or of an action tha
5963

6064
</Lede>
6165

66+
<WebComponentBanner
67+
componentName={frontmatter.title}
68+
webComponentName={frontmatter.webComponent.name}
69+
webComponentUrl={frontmatter.webComponent.url}
70+
type={frontmatter.webComponent.type}
71+
/>
72+
6273
<Examples />
6374

6475
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/feedback-indicators/banner.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Banner
33
shortDescription: Informs merchants about important changes or persistent conditions in a prominent way.
44
category: Feedback indicators
5+
webComponent:
6+
name: s-banner
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/feedback/banner
8+
type: polaris
59
keywords:
610
- inform
711
- update
@@ -66,6 +70,13 @@ Informs merchants about important changes or persistent conditions. Use this com
6670

6771
</Lede>
6872

73+
<WebComponentBanner
74+
componentName={frontmatter.title}
75+
webComponentName={frontmatter.webComponent.name}
76+
webComponentUrl={frontmatter.webComponent.url}
77+
type={frontmatter.webComponent.type}
78+
/>
79+
6980
<Examples />
7081

7182
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/feedback-indicators/spinner.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ title: Spinner
33
shortDescription: Used to notify merchants that their action is being processed. Used for content that can’t be represented with skeleton loading components.
44
category: Feedback indicators
55
releasedIn: 1.7.0
6+
webComponent:
7+
name: s-spinner
8+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/feedback/spinner
9+
type: polaris
610
keywords:
711
- spinner
812
- loader
@@ -29,6 +33,13 @@ Spinners are used to notify merchants that their action is being processed. For
2933

3034
</Lede>
3135

36+
<WebComponentBanner
37+
componentName={frontmatter.title}
38+
webComponentName={frontmatter.webComponent.name}
39+
webComponentUrl={frontmatter.webComponent.url}
40+
type={frontmatter.webComponent.type}
41+
/>
42+
3243
<Examples />
3344

3445
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/images-and-icons/avatar.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Avatar
33
shortDescription: Used to show a thumbnail representation of an individual or business in the interface.
44
category: Images and icons
5+
webComponent:
6+
name: s-avatar
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/media/avatar
8+
type: polaris
59
keywords:
610
- photo
711
- profile
@@ -39,6 +43,13 @@ Avatars are used to show a thumbnail representation of an individual or business
3943

4044
</Lede>
4145

46+
<WebComponentBanner
47+
componentName={frontmatter.title}
48+
webComponentName={frontmatter.webComponent.name}
49+
webComponentUrl={frontmatter.webComponent.url}
50+
type={frontmatter.webComponent.type}
51+
/>
52+
4253
<Examples />
4354

4455
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/images-and-icons/icon.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Icon
33
shortDescription: Used to visually communicate core parts of the product and available actions, acting as wayfinding tools.
44
category: Images and icons
5+
webComponent:
6+
name: s-icon
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/media/icon
8+
type: polaris
59
keywords:
610
- iconography
711
- visual indicator
@@ -37,6 +41,13 @@ Icons are used to visually communicate core parts of the product and available a
3741

3842
</Lede>
3943

44+
<WebComponentBanner
45+
componentName={frontmatter.title}
46+
webComponentName={frontmatter.webComponent.name}
47+
webComponentUrl={frontmatter.webComponent.url}
48+
type={frontmatter.webComponent.type}
49+
/>
50+
4051
<Examples />
4152

4253
<Props componentName={frontmatter.title} />

polaris.shopify.com/content/components/images-and-icons/thumbnail.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
title: Thumbnail
33
shortDescription: Used as a visual anchor and identifier for an object, along with text to provide context.
44
category: Images and icons
5+
webComponent:
6+
name: s-thumbnail
7+
url: https://shopify.dev/docs/api/app-home/polaris-web-components/media/thumbnail
8+
type: polaris
59
keywords:
610
- photo
711
- picture
@@ -37,6 +41,13 @@ Use thumbnails as a visual anchor and identifier for an object. They should be u
3741

3842
</Lede>
3943

44+
<WebComponentBanner
45+
componentName={frontmatter.title}
46+
webComponentName={frontmatter.webComponent.name}
47+
webComponentUrl={frontmatter.webComponent.url}
48+
type={frontmatter.webComponent.type}
49+
/>
50+
4051
<Examples />
4152

4253
<Props componentName={frontmatter.title} />

0 commit comments

Comments
 (0)