Skip to content

Commit c71382e

Browse files
committed
[Layout foundations] Remove description from children props
1 parent f0cb52b commit c71382e

File tree

7 files changed

+4
-11
lines changed

7 files changed

+4
-11
lines changed

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ type CardBackgroundColorTokenScale = Extract<
1515
>;
1616

1717
export interface AlphaCardProps {
18-
/** Elements to display inside card */
1918
children?: React.ReactNode;
2019
/** Background color
2120
* @default 'surface'

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,11 @@ type Element = 'div' | 'ul' | 'ol' | 'fieldset';
1717
type Gap = ResponsiveProp<SpacingSpaceScale>;
1818

1919
export interface AlphaStackProps {
20+
children?: React.ReactNode;
2021
/** HTML Element type
2122
* @default 'div'
2223
*/
2324
as?: Element;
24-
/** Elements to display inside stack */
25-
children?: React.ReactNode;
2625
/** Vertical alignment of children
2726
* @default 'start'
2827
*/

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ import {sanitizeCustomProperties} from '../../utilities/css';
66
import styles from './Bleed.scss';
77

88
export interface BleedProps {
9-
/** Elements to display inside bleed */
10-
children: React.ReactNode;
9+
children?: React.ReactNode;
1110
/** Negative horizontal space around children
1211
* @default '5'
1312
*/

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,11 @@ export type BackgroundColors =
6969
| ColorsSurfaceTokenAlias;
7070

7171
export interface BoxProps {
72+
children?: React.ReactNode;
7273
/** HTML Element type
7374
* @default 'div'
7475
*/
7576
as?: Element;
76-
/** Elements to display inside box */
77-
children?: React.ReactNode;
7877
/** Background color */
7978
background?: BackgroundColors;
8079
/** Border style */

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ type Columns = {
1919
type Gap = ResponsiveProp<SpacingSpaceScale>;
2020

2121
export interface ColumnsProps {
22-
/** Elements to display inside columns */
2322
children?: React.ReactNode;
2423
/** The number of columns to display
2524
* @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ type Align =
1313
type BlockAlign = 'start' | 'center' | 'end' | 'baseline' | 'stretch';
1414

1515
export interface InlineProps {
16-
/** Elements to display inside stack */
1716
children?: React.ReactNode;
1817
/** Horizontal alignment of children
1918
* @default 'start'

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ type Gap = {
1515
};
1616

1717
export interface TilesProps {
18-
/** Elements to display inside tiles */
19-
children: React.ReactNode;
18+
children?: React.ReactNode;
2019
/** The number of columns to display
2120
* @default {xs: 6, sm: 6, md: 6, lg: 6, xl: 6}
2221
*/

0 commit comments

Comments
 (0)