Skip to content

Commit 8ee61e3

Browse files
authored
[Layout foundations] Mark components with API changes as alpha (#8962)
### WHY are these changes introduced? Resolves #8951. `VerticalStack`, `HorizontalStack` and `HorizontalGrid` will have upcoming API changes so reverting changes to move them to beta so that they remain alpha until the next major release. ### WHAT is this pull request doing? Marks `VerticalStack`, `HorizontalStack`, `HorizontalGrid`, `Box`, and `Card` as alpha. <details> <summary>Alpha layout components</summary> <img src="https://user-images.githubusercontent.com/26749317/231876628-e0d629a3-d73d-4284-b047-4817e5cdea16.png" alt="Alpha layout components"> </details> ### How to 🎩 🖥 [Local development instructions](https://github.com/Shopify/polaris/blob/main/README.md#local-development) 🗒 [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 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 - [x] [Tophatted documentation](https://github.com/Shopify/polaris/blob/main/documentation/Tophatting%20documentation.md) changes in the style guide
1 parent c9219ad commit 8ee61e3

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

polaris.shopify.com/content/components/layout-and-structure/box.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ keywords:
88
- responsive
99
- tokens
1010
status:
11-
value: Beta
12-
message: This component is ready for wider adoption, usage is encouraged for most cases. Breaking changes are possible in minor version updates. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
11+
value: Alpha
12+
message: This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
1313
examples:
1414
- fileName: box-with-color.tsx
1515
title: Color

polaris.shopify.com/content/components/layout-and-structure/card.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ keywords:
2323
- callout
2424
- call out
2525
status:
26-
value: Beta
27-
message: This component is ready for wider adoption, usage is encouraged for most cases. Breaking changes are possible in minor version updates. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
26+
value: Alpha
27+
message: This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
2828
examples:
2929
- fileName: card-default.tsx
3030
title: Default

polaris.shopify.com/content/components/layout-and-structure/horizontal-grid.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ keywords:
88
- grid
99
- responsive
1010
status:
11-
value: Beta
12-
message: This component is ready for wider adoption, usage is encouraged for most cases. Breaking changes are possible in minor version updates. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
11+
value: Alpha
12+
message: This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
1313
examples:
1414
- fileName: horizontal-grid-with-varying-gap.tsx
1515
title: Gap

polaris.shopify.com/content/components/layout-and-structure/horizontal-stack.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ keywords:
1515
- horizontal row of components
1616
- stack
1717
status:
18-
value: Beta
19-
message: This component is ready for wider adoption, usage is encouraged for most cases. Breaking changes are possible in minor version updates. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
18+
value: Alpha
19+
message: This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
2020
examples:
2121
- fileName: horizontal-stack-with-non-wrapping.tsx
2222
title: Non-wrapping

polaris.shopify.com/content/components/layout-and-structure/vertical-stack.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ keywords:
1212
- right-aligned stack
1313
- stack layout
1414
status:
15-
value: Beta
16-
message: This component is ready for wider adoption, usage is encouraged for most cases. Breaking changes are possible in minor version updates. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
15+
value: Alpha
16+
message: This component is a work in progress and ready for exploratory usage, with breaking changes expected in minor version updates. Please use with caution. Learn more about our [component lifecycles](/getting-started/components-lifecycle).
1717
examples:
1818
- fileName: vertical-stack-with-gap.tsx
1919
title: Gap

0 commit comments

Comments
 (0)