Skip to content

Commit 3537b3a

Browse files
authored
[Layout foundations] Deprecate TextContainer (#8441)
Closes: #7404
1 parent 4018ee2 commit 3537b3a

File tree

16 files changed

+825
-802
lines changed

16 files changed

+825
-802
lines changed

.changeset/real-rules-shave.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@shopify/polaris': minor
3+
---
4+
5+
Deprecated TextContainer in favor of AlphaStack

polaris-react/playground/DetailsPage.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ import {
3636
SkeletonPage,
3737
Stack,
3838
Text,
39+
// eslint-disable-next-line import/no-deprecated
3940
TextContainer,
4041
TextField,
4142
Thumbnail,

polaris-react/src/components/CalloutCard/CalloutCard.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ import {CancelSmallMinor} from '@shopify/polaris-icons';
44
import {classNames} from '../../utilities/css';
55
import type {Action} from '../../types';
66
import {LegacyCard} from '../LegacyCard';
7+
// eslint-disable-next-line import/no-deprecated
78
import {TextContainer} from '../TextContainer';
89
import {ButtonGroup} from '../ButtonGroup';
910
import {Button, buttonFrom} from '../Button';

polaris-react/src/components/Layout/components/AnnotatedSection/AnnotatedSection.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React from 'react';
22

33
import {Box} from '../../../Box';
44
import {Text} from '../../../Text';
5+
// eslint-disable-next-line import/no-deprecated
56
import {TextContainer} from '../../../TextContainer';
67
import styles from '../../Layout.scss';
78

polaris-react/src/components/Layout/tests/Layout.test.tsx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React from 'react';
22
import {mountWithApp} from 'tests/utilities';
33

44
import {Text} from '../../Text';
5+
// eslint-disable-next-line import/no-deprecated
56
import {TextContainer} from '../../TextContainer';
67
import {Section} from '../components';
78
import {Layout} from '../Layout';
@@ -57,6 +58,7 @@ describe('<Layout />', () => {
5758
);
5859

5960
const annotedDescriptionTextContainer =
61+
// eslint-disable-next-line import/no-deprecated
6062
annotatedSection.find(TextContainer)!;
6163

6264
expect(annotedDescriptionTextContainer.find('div')).toContainReactText(
@@ -68,8 +70,8 @@ describe('<Layout />', () => {
6870
const annotatedSection = mountWithApp(
6971
<Layout.AnnotatedSection description={<MyComponent />} />,
7072
);
71-
7273
const annotedDescriptionTextContainer =
74+
// eslint-disable-next-line import/no-deprecated
7375
annotatedSection.find(TextContainer)!;
7476

7577
expect(annotedDescriptionTextContainer).toContainReactComponent(
@@ -85,8 +87,9 @@ describe('<Layout />', () => {
8587
);
8688

8789
const annotedDescriptionTextContainer =
90+
// eslint-disable-next-line import/no-deprecated
8891
annotatedSection.find(TextContainer)!;
89-
92+
// eslint-disable-next-line import/no-deprecated
9093
expect(annotatedSection).toContainReactComponent(TextContainer);
9194
expect(annotedDescriptionTextContainer).not.toContainReactComponent(
9295
'div',

polaris-react/src/components/Popover/components/Pane/tests/Pane.test.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React from 'react';
22
import {mountWithApp} from 'tests/utilities';
33

44
import {Scrollable} from '../../../../Scrollable';
5+
// eslint-disable-next-line import/no-deprecated
56
import {TextContainer} from '../../../../TextContainer';
67
import {Pane} from '../Pane';
78
import {Section} from '../../Section';

polaris-react/src/components/Popover/components/PopoverOverlay/tests/PopoverOverlay.test.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import React, {useRef} from 'react';
22
import {mountWithApp} from 'tests/utilities';
33

44
import {Key} from '../../../../../types';
5+
// eslint-disable-next-line import/no-deprecated
56
import {TextContainer} from '../../../../TextContainer';
67
import {TextField} from '../../../../TextField';
78
import {PositionedOverlay} from '../../../../PositionedOverlay';

polaris-react/src/components/Popover/components/Section/tests/Section.test.tsx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import React from 'react';
22
import {mountWithApp} from 'tests/utilities';
33

4+
// eslint-disable-next-line import/no-deprecated
45
import {TextContainer} from '../../../../TextContainer';
56
import {Section} from '../Section';
67

@@ -14,6 +15,7 @@ describe('<Section />', () => {
1415
it('renders its children', () => {
1516
const section = mountWithApp(<Section>{children}</Section>);
1617

18+
// eslint-disable-next-line import/no-deprecated
1719
expect(section.find(TextContainer)).toContainReactHtml('<p>Content</p>');
1820
});
1921

polaris-react/src/components/Popover/tests/Popover.test.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import {Popover} from '../Popover';
77
import type {PopoverPublicAPI} from '../Popover';
88
import {Pane, PopoverCloseSource, PopoverOverlay} from '../components';
99
import * as setActivatorAttributes from '../set-activator-attributes';
10+
// eslint-disable-next-line import/no-deprecated
1011
import {TextContainer} from '../../TextContainer';
1112

1213
describe('<Popover />', () => {

polaris-react/src/components/TextContainer/TextContainer.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ export interface TextContainerProps {
1313
children?: React.ReactNode;
1414
}
1515

16+
/** @deprecated Use AlphaStack instead */
1617
export function TextContainer({spacing, children}: TextContainerProps) {
1718
const className = classNames(
1819
styles.TextContainer,

0 commit comments

Comments
 (0)