carbon-react 104.42.0 → 104.43.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,8 +1,7 @@
1
1
  function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
2
2
 
3
3
  import React from "react";
4
- import PropTypes from "prop-types";
5
- import propTypes from "@styled-system/prop-types";
4
+ import styledSystemPropTypes from "@styled-system/prop-types";
6
5
  import GridContainerStyle from "./grid-container.style";
7
6
  import GridItem from "../grid-item";
8
7
 
@@ -32,7 +31,7 @@ GridContainer.propTypes = {
32
31
  });
33
32
  return error;
34
33
  },
35
- ...propTypes.space,
36
- gridGap: PropTypes.oneOfType([PropTypes.string, PropTypes.number])
34
+ ...styledSystemPropTypes.space,
35
+ ...styledSystemPropTypes.grid
37
36
  };
38
37
  export default GridContainer;
@@ -1,5 +1,5 @@
1
1
  import * as React from "react";
2
- import { SpaceProps } from "styled-system";
2
+ import { SpaceProps, GridProps } from "styled-system";
3
3
  import { GridItemProps } from "../grid-item/grid-item";
4
4
 
5
5
  type GridContainerChild =
@@ -8,11 +8,9 @@ type GridContainerChild =
8
8
  | null
9
9
  | undefined;
10
10
 
11
- export interface GridContainerProps extends SpaceProps {
11
+ export interface GridContainerProps extends SpaceProps, GridProps {
12
12
  /** Defines the Components to be rendered within the GridContainer. Requires GridItemProps */
13
13
  children?: GridContainerChild | GridContainerChild[];
14
- /** Any valid CSS value to override default grid-gap */
15
- gridGap?: string;
16
14
  }
17
15
 
18
16
  declare function GridContainer(props: GridContainerProps): JSX.Element;
@@ -27,10 +27,7 @@ const GridContainerStyle = styled.div`
27
27
 
28
28
  @media screen {
29
29
  ${space}
30
- ${({
31
- gridGap
32
- }) => grid({
33
- gridGap
34
- })}
30
+ ${grid}
31
+ }
35
32
  `;
36
33
  export default GridContainerStyle;
@@ -5,6 +5,8 @@ declare namespace GridItem {
5
5
  const responsiveSettings: PropTypes.Requireable<(PropTypes.InferProps<{
6
6
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
7
7
  alignSelf: PropTypes.Requireable<string>;
8
+ /** Shorthand property for gridColumn and gridRow */
9
+ gridArea: PropTypes.Requireable<string | number>;
8
10
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
9
11
  gridColumn: PropTypes.Requireable<string | number>;
10
12
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
@@ -16,6 +18,7 @@ declare namespace GridItem {
16
18
  }> | null | undefined)[]>;
17
19
  const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
18
20
  const alignSelf: PropTypes.Requireable<string>;
21
+ const gridArea: PropTypes.Requireable<string | number>;
19
22
  const gridColumn: PropTypes.Requireable<string | number>;
20
23
  const gridRow: PropTypes.Requireable<string | number>;
21
24
  const justifySelf: PropTypes.Requireable<string>;
@@ -26,6 +26,9 @@ GridItem.propTypes = {
26
26
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
27
27
  alignSelf: PropTypes.string,
28
28
 
29
+ /** Shorthand property for gridColumn and gridRow */
30
+ gridArea: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
31
+
29
32
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
30
33
  gridColumn: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
31
34
 
@@ -39,6 +42,9 @@ GridItem.propTypes = {
39
42
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
40
43
  alignSelf: PropTypes.string,
41
44
 
45
+ /** Shorthand property for gridColumn and gridRow */
46
+ gridArea: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
47
+
42
48
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
43
49
  gridColumn: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
44
50
 
@@ -1,5 +1,10 @@
1
1
  import * as React from "react";
2
- import { PaddingProps } from "styled-system";
2
+ import {
3
+ PaddingProps,
4
+ GridAreaProps,
5
+ GridRowProps,
6
+ GridColumnProps,
7
+ } from "styled-system";
3
8
 
4
9
  interface ResponsiveSettingsShape extends PaddingProps {
5
10
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
@@ -8,10 +13,12 @@ interface ResponsiveSettingsShape extends PaddingProps {
8
13
  justifySelf?: string;
9
14
  /** Maximum width of the item */
10
15
  maxWidth?: string;
16
+ /** Shorthand property for gridColumn and gridRow */
17
+ gridArea?: GridAreaProps;
11
18
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
12
- gridColumn?: string | number;
19
+ gridColumn?: GridColumnProps;
13
20
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
14
- gridRow?: string | number;
21
+ gridRow?: GridRowProps;
15
22
  }
16
23
 
17
24
  export interface GridItemProps extends PaddingProps {
@@ -21,10 +28,12 @@ export interface GridItemProps extends PaddingProps {
21
28
  justifySelf?: string;
22
29
  /** Defines the Component(s) to be rendered within the GridItem */
23
30
  children?: React.ReactNode;
31
+ /** Shorthand property for gridColumn and gridRow */
32
+ gridArea?: GridAreaProps;
24
33
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
25
- gridColumn?: string | number;
34
+ gridColumn?: GridColumnProps;
26
35
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
27
- gridRow?: string | number;
36
+ gridRow?: GridRowProps;
28
37
  responsiveSettings?: ResponsiveSettingsShape[];
29
38
  }
30
39
 
@@ -9,6 +9,7 @@ function responsiveGridItem(responsiveSettings) {
9
9
  return responsiveSettings.map(setting => {
10
10
  const {
11
11
  alignSelf,
12
+ gridArea,
12
13
  gridColumn,
13
14
  gridRow,
14
15
  maxWidth,
@@ -23,6 +24,7 @@ function responsiveGridItem(responsiveSettings) {
23
24
  @media screen and (max-width: ${maxWidth}) {
24
25
  align-self: ${alignSelf || "stretch"};
25
26
  justify-self: ${justifySelf || "stretch"};
27
+ grid-area: ${gridArea};
26
28
  grid-column: ${gridColumn};
27
29
  grid-row: ${gridRow};
28
30
  padding: ${getSpacing(p)};
@@ -81,33 +83,30 @@ export function getSpacing(prop) {
81
83
  const paddingPropTypes = filterStyledSystemPaddingProps(styledSystemPropTypes.space);
82
84
  const GridItemStyle = styled.div`
83
85
  margin: 0;
86
+ ${padding}
84
87
 
85
88
  ${({
86
- justifySelf
87
- }) => flexbox({
89
+ alignSelf,
90
+ justifySelf,
91
+ gridArea,
92
+ gridColumn,
93
+ gridRow,
94
+ responsiveSettings
95
+ }) => css`
96
+ ${flexbox({
97
+ alignSelf,
88
98
  justifySelf
89
99
  })}
90
- ${({
91
- alignSelf
92
- }) => flexbox({
93
- alignSelf
94
- })}
95
- ${padding}
96
- ${({
100
+ ${grid({
101
+ gridArea,
102
+ gridColumn,
97
103
  gridRow
98
- }) => grid({
99
- gridRow
100
- })}
101
- ${({
102
- gridColumn
103
- }) => grid({
104
- gridColumn
105
- })}
106
- ${({
107
- responsiveSettings
108
- }) => responsiveSettings && css`
104
+ })};
105
+
106
+ ${responsiveSettings && css`
109
107
  ${responsiveGridItem(responsiveSettings)};
110
108
  `}
109
+ `}
111
110
  `;
112
111
  GridItemStyle.propTypes = {
113
112
  alignSelf: PropTypes.string,
@@ -117,6 +116,7 @@ GridItemStyle.propTypes = {
117
116
  ...paddingPropTypes,
118
117
  responsiveSettings: PropTypes.arrayOf(PropTypes.shape({
119
118
  alignSelf: PropTypes.string,
119
+ gridArea: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
120
120
  gridColumn: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
121
121
  gridRow: PropTypes.oneOfType([PropTypes.string, PropTypes.number]),
122
122
  justifySelf: PropTypes.string,
@@ -125,7 +125,6 @@ GridItemStyle.propTypes = {
125
125
  }))
126
126
  };
127
127
  GridItemStyle.defaultProps = {
128
- gridColumn: "1 / 13",
129
- gridRow: "auto"
128
+ gridArea: "auto / 1 / auto / 13"
130
129
  };
131
130
  export default GridItemStyle;
@@ -7,9 +7,7 @@ exports.default = void 0;
7
7
 
8
8
  var _react = _interopRequireDefault(require("react"));
9
9
 
10
- var _propTypes = _interopRequireDefault(require("prop-types"));
11
-
12
- var _propTypes2 = _interopRequireDefault(require("@styled-system/prop-types"));
10
+ var _propTypes = _interopRequireDefault(require("@styled-system/prop-types"));
13
11
 
14
12
  var _gridContainer = _interopRequireDefault(require("./grid-container.style"));
15
13
 
@@ -47,8 +45,8 @@ GridContainer.propTypes = {
47
45
 
48
46
  return error;
49
47
  },
50
- ..._propTypes2.default.space,
51
- gridGap: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number])
48
+ ..._propTypes.default.space,
49
+ ..._propTypes.default.grid
52
50
  };
53
51
  var _default = GridContainer;
54
52
  exports.default = _default;
@@ -1,5 +1,5 @@
1
1
  import * as React from "react";
2
- import { SpaceProps } from "styled-system";
2
+ import { SpaceProps, GridProps } from "styled-system";
3
3
  import { GridItemProps } from "../grid-item/grid-item";
4
4
 
5
5
  type GridContainerChild =
@@ -8,11 +8,9 @@ type GridContainerChild =
8
8
  | null
9
9
  | undefined;
10
10
 
11
- export interface GridContainerProps extends SpaceProps {
11
+ export interface GridContainerProps extends SpaceProps, GridProps {
12
12
  /** Defines the Components to be rendered within the GridContainer. Requires GridItemProps */
13
13
  children?: GridContainerChild | GridContainerChild[];
14
- /** Any valid CSS value to override default grid-gap */
15
- gridGap?: string;
16
14
  }
17
15
 
18
16
  declare function GridContainer(props: GridContainerProps): JSX.Element;
@@ -38,11 +38,8 @@ const GridContainerStyle = _styledComponents.default.div`
38
38
 
39
39
  @media screen {
40
40
  ${_styledSystem.space}
41
- ${({
42
- gridGap
43
- }) => (0, _styledSystem.grid)({
44
- gridGap
45
- })}
41
+ ${_styledSystem.grid}
42
+ }
46
43
  `;
47
44
  var _default = GridContainerStyle;
48
45
  exports.default = _default;
@@ -5,6 +5,8 @@ declare namespace GridItem {
5
5
  const responsiveSettings: PropTypes.Requireable<(PropTypes.InferProps<{
6
6
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
7
7
  alignSelf: PropTypes.Requireable<string>;
8
+ /** Shorthand property for gridColumn and gridRow */
9
+ gridArea: PropTypes.Requireable<string | number>;
8
10
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
9
11
  gridColumn: PropTypes.Requireable<string | number>;
10
12
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
@@ -16,6 +18,7 @@ declare namespace GridItem {
16
18
  }> | null | undefined)[]>;
17
19
  const children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
18
20
  const alignSelf: PropTypes.Requireable<string>;
21
+ const gridArea: PropTypes.Requireable<string | number>;
19
22
  const gridColumn: PropTypes.Requireable<string | number>;
20
23
  const gridRow: PropTypes.Requireable<string | number>;
21
24
  const justifySelf: PropTypes.Requireable<string>;
@@ -38,6 +38,9 @@ GridItem.propTypes = {
38
38
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
39
39
  alignSelf: _propTypes.default.string,
40
40
 
41
+ /** Shorthand property for gridColumn and gridRow */
42
+ gridArea: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
43
+
41
44
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
42
45
  gridColumn: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
43
46
 
@@ -51,6 +54,9 @@ GridItem.propTypes = {
51
54
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
52
55
  alignSelf: _propTypes.default.string,
53
56
 
57
+ /** Shorthand property for gridColumn and gridRow */
58
+ gridArea: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
59
+
54
60
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
55
61
  gridColumn: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.number]),
56
62
 
@@ -1,5 +1,10 @@
1
1
  import * as React from "react";
2
- import { PaddingProps } from "styled-system";
2
+ import {
3
+ PaddingProps,
4
+ GridAreaProps,
5
+ GridRowProps,
6
+ GridColumnProps,
7
+ } from "styled-system";
3
8
 
4
9
  interface ResponsiveSettingsShape extends PaddingProps {
5
10
  /** How the grid item is aligned along the block (column) axis. Values: start, end, center, stretch */
@@ -8,10 +13,12 @@ interface ResponsiveSettingsShape extends PaddingProps {
8
13
  justifySelf?: string;
9
14
  /** Maximum width of the item */
10
15
  maxWidth?: string;
16
+ /** Shorthand property for gridColumn and gridRow */
17
+ gridArea?: GridAreaProps;
11
18
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
12
- gridColumn?: string | number;
19
+ gridColumn?: GridColumnProps;
13
20
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
14
- gridRow?: string | number;
21
+ gridRow?: GridRowProps;
15
22
  }
16
23
 
17
24
  export interface GridItemProps extends PaddingProps {
@@ -21,10 +28,12 @@ export interface GridItemProps extends PaddingProps {
21
28
  justifySelf?: string;
22
29
  /** Defines the Component(s) to be rendered within the GridItem */
23
30
  children?: React.ReactNode;
31
+ /** Shorthand property for gridColumn and gridRow */
32
+ gridArea?: GridAreaProps;
24
33
  /** Starting and ending column position of the GridItem within the GridContainer separated by "/" */
25
- gridColumn?: string | number;
34
+ gridColumn?: GridColumnProps;
26
35
  /** Starting and ending row position of the GridItem within the GridContainer separated by "/" */
27
- gridRow?: string | number;
36
+ gridRow?: GridRowProps;
28
37
  responsiveSettings?: ResponsiveSettingsShape[];
29
38
  }
30
39
 
@@ -28,6 +28,7 @@ function responsiveGridItem(responsiveSettings) {
28
28
  return responsiveSettings.map(setting => {
29
29
  const {
30
30
  alignSelf,
31
+ gridArea,
31
32
  gridColumn,
32
33
  gridRow,
33
34
  maxWidth,
@@ -42,6 +43,7 @@ function responsiveGridItem(responsiveSettings) {
42
43
  @media screen and (max-width: ${maxWidth}) {
43
44
  align-self: ${alignSelf || "stretch"};
44
45
  justify-self: ${justifySelf || "stretch"};
46
+ grid-area: ${gridArea};
45
47
  grid-column: ${gridColumn};
46
48
  grid-row: ${gridRow};
47
49
  padding: ${getSpacing(p)};
@@ -101,33 +103,30 @@ function getSpacing(prop) {
101
103
  const paddingPropTypes = (0, _utils.filterStyledSystemPaddingProps)(_propTypes.default.space);
102
104
  const GridItemStyle = _styledComponents.default.div`
103
105
  margin: 0;
106
+ ${_space.padding}
104
107
 
105
108
  ${({
106
- justifySelf
107
- }) => (0, _styledSystem.flexbox)({
109
+ alignSelf,
110
+ justifySelf,
111
+ gridArea,
112
+ gridColumn,
113
+ gridRow,
114
+ responsiveSettings
115
+ }) => (0, _styledComponents.css)`
116
+ ${(0, _styledSystem.flexbox)({
117
+ alignSelf,
108
118
  justifySelf
109
119
  })}
110
- ${({
111
- alignSelf
112
- }) => (0, _styledSystem.flexbox)({
113
- alignSelf
114
- })}
115
- ${_space.padding}
116
- ${({
120
+ ${(0, _styledSystem.grid)({
121
+ gridArea,
122
+ gridColumn,
117
123
  gridRow
118
- }) => (0, _styledSystem.grid)({
119
- gridRow
120
- })}
121
- ${({
122
- gridColumn
123
- }) => (0, _styledSystem.grid)({
124
- gridColumn
125
- })}
126
- ${({
127
- responsiveSettings
128
- }) => responsiveSettings && (0, _styledComponents.css)`
124
+ })};
125
+
126
+ ${responsiveSettings && (0, _styledComponents.css)`
129
127
  ${responsiveGridItem(responsiveSettings)};
130
128
  `}
129
+ `}
131
130
  `;
132
131
  GridItemStyle.propTypes = {
133
132
  alignSelf: _propTypes2.default.string,
@@ -137,6 +136,7 @@ GridItemStyle.propTypes = {
137
136
  ...paddingPropTypes,
138
137
  responsiveSettings: _propTypes2.default.arrayOf(_propTypes2.default.shape({
139
138
  alignSelf: _propTypes2.default.string,
139
+ gridArea: _propTypes2.default.oneOfType([_propTypes2.default.string, _propTypes2.default.number]),
140
140
  gridColumn: _propTypes2.default.oneOfType([_propTypes2.default.string, _propTypes2.default.number]),
141
141
  gridRow: _propTypes2.default.oneOfType([_propTypes2.default.string, _propTypes2.default.number]),
142
142
  justifySelf: _propTypes2.default.string,
@@ -145,8 +145,7 @@ GridItemStyle.propTypes = {
145
145
  }))
146
146
  };
147
147
  GridItemStyle.defaultProps = {
148
- gridColumn: "1 / 13",
149
- gridRow: "auto"
148
+ gridArea: "auto / 1 / auto / 13"
150
149
  };
151
150
  var _default = GridItemStyle;
152
151
  exports.default = _default;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "carbon-react",
3
- "version": "104.42.0",
3
+ "version": "104.43.0",
4
4
  "description": "A library of reusable React components for easily building user interfaces.",
5
5
  "engineStrict": true,
6
6
  "engines": {