@primer/components 32.1.1-rc.b4502a34 → 33.0.0-rc.b3e4ccee

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. package/CHANGELOG.md +11 -1
  2. package/contributor-docs/CONTRIBUTING.md +14 -58
  3. package/dist/browser.esm.js +104 -108
  4. package/dist/browser.esm.js.map +1 -1
  5. package/dist/browser.umd.js +104 -108
  6. package/dist/browser.umd.js.map +1 -1
  7. package/docs/content/BranchName.md +6 -5
  8. package/docs/content/Details.md +4 -8
  9. package/docs/content/Heading.md +5 -10
  10. package/docs/content/Label.md +6 -7
  11. package/docs/content/ProgressBar.mdx +7 -6
  12. package/docs/content/Text.md +0 -6
  13. package/docs/content/status.mdx +1 -1
  14. package/docs/content/system-props.mdx +1 -1
  15. package/docs/src/@primer/gatsby-theme-doctocat/nav.yml +1 -1
  16. package/lib/Avatar.d.ts +1 -2
  17. package/lib/Avatar.js +1 -1
  18. package/lib/BranchName.d.ts +1 -2
  19. package/lib/BranchName.js +1 -1
  20. package/lib/Details.d.ts +1 -2
  21. package/lib/Details.js +1 -3
  22. package/lib/Dropdown.d.ts +2 -66
  23. package/lib/Heading.d.ts +1 -2
  24. package/lib/Heading.js +1 -6
  25. package/lib/ProgressBar.d.ts +16 -11
  26. package/lib/ProgressBar.js +6 -10
  27. package/lib/Spinner.d.ts +1 -2
  28. package/lib/Spinner.js +1 -3
  29. package/lib/__tests__/Avatar.test.js +4 -2
  30. package/lib/__tests__/Avatar.types.test.d.ts +3 -0
  31. package/lib/__tests__/Avatar.types.test.js +31 -0
  32. package/lib/__tests__/BranchName.types.test.d.ts +3 -0
  33. package/lib/__tests__/BranchName.types.test.js +28 -0
  34. package/lib/__tests__/Details.types.test.d.ts +3 -0
  35. package/lib/__tests__/Details.types.test.js +28 -0
  36. package/lib/__tests__/Heading.test.js +63 -30
  37. package/lib/__tests__/Heading.types.test.d.ts +3 -0
  38. package/lib/__tests__/Heading.types.test.js +28 -0
  39. package/lib-esm/Avatar.d.ts +1 -2
  40. package/lib-esm/Avatar.js +2 -2
  41. package/lib-esm/BranchName.d.ts +1 -2
  42. package/lib-esm/BranchName.js +2 -2
  43. package/lib-esm/Details.d.ts +1 -2
  44. package/lib-esm/Details.js +1 -2
  45. package/lib-esm/Dropdown.d.ts +2 -66
  46. package/lib-esm/Heading.d.ts +1 -2
  47. package/lib-esm/Heading.js +2 -6
  48. package/lib-esm/ProgressBar.d.ts +16 -11
  49. package/lib-esm/ProgressBar.js +7 -11
  50. package/lib-esm/Spinner.d.ts +1 -2
  51. package/lib-esm/Spinner.js +1 -2
  52. package/lib-esm/__tests__/Avatar.test.js +4 -2
  53. package/lib-esm/__tests__/Avatar.types.test.d.ts +3 -0
  54. package/lib-esm/__tests__/Avatar.types.test.js +16 -0
  55. package/lib-esm/__tests__/BranchName.types.test.d.ts +3 -0
  56. package/lib-esm/__tests__/BranchName.types.test.js +13 -0
  57. package/lib-esm/__tests__/Details.types.test.d.ts +3 -0
  58. package/lib-esm/__tests__/Details.types.test.js +13 -0
  59. package/lib-esm/__tests__/Heading.test.js +62 -30
  60. package/lib-esm/__tests__/Heading.types.test.d.ts +3 -0
  61. package/lib-esm/__tests__/Heading.types.test.js +13 -0
  62. package/package.json +1 -1
  63. package/src/Avatar.tsx +2 -4
  64. package/src/BranchName.tsx +3 -3
  65. package/src/Details.tsx +1 -5
  66. package/src/Heading.tsx +2 -9
  67. package/src/ProgressBar.tsx +11 -10
  68. package/src/Spinner.tsx +1 -3
  69. package/src/__tests__/Avatar.test.tsx +1 -1
  70. package/src/__tests__/Avatar.types.test.tsx +11 -0
  71. package/src/__tests__/BranchName.types.test.tsx +11 -0
  72. package/src/__tests__/Details.types.test.tsx +11 -0
  73. package/src/__tests__/Heading.test.tsx +71 -25
  74. package/src/__tests__/Heading.types.test.tsx +11 -0
  75. package/stats.html +1 -1
@@ -12,15 +12,16 @@ BranchName is a label-type component rendered as an `<a>` tag by default with mo
12
12
 
13
13
  ## Props
14
14
 
15
- | Name | Type | Default | Description |
16
- | :--- | :----- | :-----: | :---------------------------------- |
17
- | as | String | `<a>` | sets the HTML tag for the component |
18
- | href | String | | a URL to link the component to |
15
+ | Name | Type | Default | Description |
16
+ | :--- | :---------------- | :-----: | :----------------------------------- |
17
+ | as | String | `<a>` | sets the HTML tag for the component |
18
+ | href | String | | a URL to link the component to |
19
+ | sx | SystemStyleObject | {} | Style to be applied to the component |
19
20
 
20
21
  ## Component status
21
22
 
22
23
  <ComponentChecklist
23
- items={{
24
+ items={{
24
25
  propsDocumented: true,
25
26
  noUnnecessaryDeps: true,
26
27
  adaptsToThemes: true,
@@ -79,15 +79,11 @@ In previous versions of Primer React Components, we allowed users to pass in a c
79
79
  </State>
80
80
  ```
81
81
 
82
- ## `Details` System props
82
+ ## Details props
83
83
 
84
- <Note variant="warning">
85
-
86
- System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
87
-
88
- </Note>
89
-
90
- Details components get `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
84
+ | Name | Type | Default | Description |
85
+ | :--- | :---------------- | :-----: | :----------------------------------- |
86
+ | sx | SystemStyleObject | {} | Style to be applied to the component |
91
87
 
92
88
  ## `useDetails` hook configuration options
93
89
 
@@ -10,17 +10,12 @@ The Heading component will render an html `h2` tag without any default styling.
10
10
  ## Default example
11
11
 
12
12
  ```jsx live
13
- <Heading fontSize={1} mb={2}>
14
- H2 heading with fontSize={1}
15
- </Heading>
13
+ <Heading sx={{fontSize: 1, mb: 2}}>H2 heading with fontSize={1}</Heading>
16
14
  ```
17
15
 
18
- ## System props
19
-
20
- Heading components get `TYPOGRAPHY` and `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
21
-
22
16
  ## Component props
23
17
 
24
- | Prop name | Type | Description |
25
- | :-------- | :---------------------- | :---------------------------------- |
26
- | as | String or React element | sets the HTML tag for the component |
18
+ | Name | Type | Default | Description |
19
+ | :--- | :---------------------- | :-----: | :----------------------------------- |
20
+ | as | String or React element | | sets the HTML tag for the component |
21
+ | sx | SystemStyleObject | {} | Style to be applied to the component |
@@ -41,10 +41,9 @@ The Label component is used to add contextual metadata to a design. Visually it
41
41
 
42
42
  ## Component props
43
43
 
44
- | Name | Type | Default | Description |
45
- | :--------- | :---------------- | :--------------------: | :----------------------------------------------------------------------------- |
46
- | outline | Boolean | | Creates an outline style label |
47
- | variant | String | 'medium' | Can be one of `small`, `medium` (default), `large` or `xl` . |
48
- | dropshadow | Boolean | | Adds a dropshadow to the label |
49
- | bg | String | 'label.primary.border' | Part of the `COMMON` system props, used to change the background of the label. |
50
- | sx | SystemStyleObject | {} | Style to be applied to the component |
44
+ | Name | Type | Default | Description |
45
+ | :--------- | :---------------- | :------: | :----------------------------------------------------------- |
46
+ | outline | Boolean | | Creates an outline style label |
47
+ | variant | String | 'medium' | Can be one of `small`, `medium` (default), `large` or `xl` . |
48
+ | dropshadow | Boolean | | Adds a dropshadow to the label |
49
+ | sx | SystemStyleObject | {} | Style to be applied to the component |
@@ -22,9 +22,10 @@ If you'd like to use ProgressBar inline, pass the `inline` boolean prop & **be s
22
22
 
23
23
  ## Component props
24
24
 
25
- | Name | Type | Default | Description |
26
- | :------- | :------ | :-----------------: | :------------------------------------------------------------------------------------------------------------------------------- |
27
- | progress | Number | | Used to set the size of the green bar |
28
- | barSize | String | 'default' | Controls the height of the progress bar. Can be 'small', 'large', or 'default'. If omitted, height is set to the default height. |
29
- | inline | Boolean | false | Styles the progress bar inline |
30
- | bg | String | 'bg.successInverse' | Set the progress bar color, defaults to bg-green |
25
+ | Name | Type | Default | Description |
26
+ | :------- | :---------------- | :-----------------: | :------------------------------------------------------------------------------------------------------------------------------- |
27
+ | progress | Number | | Used to set the size of the green bar |
28
+ | barSize | String | 'default' | Controls the height of the progress bar. Can be 'small', 'large', or 'default'. If omitted, height is set to the default height. |
29
+ | inline | Boolean | false | Styles the progress bar inline |
30
+ | bg | String | 'bg.successInverse' | Set the progress bar color, defaults to bg-green |
31
+ | sx | SystemStyleObject | {} | Style to be applied to the component |
@@ -23,12 +23,6 @@ The Text component is a wrapper component that will apply typography styles to t
23
23
 
24
24
  ## System props
25
25
 
26
- <Note variant="warning">
27
-
28
- System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
29
-
30
- </Note>
31
-
32
26
  Text components get `TYPOGRAPHY` and `COMMON` system props. Read our [System Props](/system-props) doc page for a full list of available props.
33
27
 
34
28
  ## Component props
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: Component statuses
2
+ title: Component status
3
3
  description: Check the current status of Primer React components
4
4
  ---
5
5
 
@@ -6,7 +6,7 @@ import {PropsList, COMMON, LAYOUT, BORDER, TYPOGRAPHY, FLEX, POSITION, GRID} fro
6
6
 
7
7
  <Note variant="warning">
8
8
 
9
- System props are deprecated in all components except [Box](/Box). Please use the [`sx` prop](/overriding-styles) instead.
9
+ System props are deprecated in all components except [Box](/Box) and [Text](/Text). Please use the [`sx` prop](/overriding-styles) instead.
10
10
 
11
11
  </Note>
12
12
 
@@ -19,7 +19,7 @@
19
19
  url: /overriding-styles
20
20
  - title: Server-side rendering
21
21
  url: /ssr
22
- - title: Component statuses
22
+ - title: Component status
23
23
  url: /status
24
24
  - title: Hooks
25
25
  children:
package/lib/Avatar.d.ts CHANGED
@@ -1,4 +1,3 @@
1
- import { SystemCommonProps } from './constants';
2
1
  import { SxProp } from './sx';
3
2
  import { ComponentProps } from './utils/types';
4
3
  declare const Avatar: import("styled-components").StyledComponent<"img", any, {
@@ -10,6 +9,6 @@ declare const Avatar: import("styled-components").StyledComponent<"img", any, {
10
9
  src: string;
11
10
  /** Provide alt text when the Avatar is used without the user's name next to it. */
12
11
  alt?: string | undefined;
13
- } & SystemCommonProps & SxProp, never>;
12
+ } & SxProp, never>;
14
13
  export declare type AvatarProps = ComponentProps<typeof Avatar>;
15
14
  export default Avatar;
package/lib/Avatar.js CHANGED
@@ -30,7 +30,7 @@ const Avatar = _styledComponents.default.img.attrs(props => ({
30
30
  })).withConfig({
31
31
  displayName: "Avatar",
32
32
  componentId: "sc-1waaaky-0"
33
- })(["display:inline-block;overflow:hidden;line-height:", ";vertical-align:middle;border-radius:", ";", ";", ""], (0, _constants.get)('lineHeights.condensedUltra'), props => getBorderRadius(props), _constants.COMMON, _sx.default);
33
+ })(["display:inline-block;overflow:hidden;line-height:", ";vertical-align:middle;border-radius:", ";", ""], (0, _constants.get)('lineHeights.condensedUltra'), props => getBorderRadius(props), _sx.default);
34
34
 
35
35
  Avatar.defaultProps = {
36
36
  size: 20,
@@ -1,6 +1,5 @@
1
- import { SystemCommonProps } from './constants';
2
1
  import { SxProp } from './sx';
3
2
  import { ComponentProps } from './utils/types';
4
- declare const BranchName: import("styled-components").StyledComponent<"a", any, SystemCommonProps & SxProp, never>;
3
+ declare const BranchName: import("styled-components").StyledComponent<"a", any, SxProp, never>;
5
4
  export declare type BranchNameProps = ComponentProps<typeof BranchName>;
6
5
  export default BranchName;
package/lib/BranchName.js CHANGED
@@ -16,7 +16,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
16
16
  const BranchName = _styledComponents.default.a.withConfig({
17
17
  displayName: "BranchName",
18
18
  componentId: "sc-167ouzm-0"
19
- })(["display:inline-block;padding:2px 6px;font-size:", ";font-family:", ";color:", ";background-color:", ";border-radius:", ";", ";", ";"], (0, _constants.get)('fontSizes.0'), (0, _constants.get)('fonts.mono'), (0, _constants.get)('colors.fg.muted'), (0, _constants.get)('colors.accent.subtle'), (0, _constants.get)('radii.2'), _constants.COMMON, _sx.default);
19
+ })(["display:inline-block;padding:2px 6px;font-size:", ";font-family:", ";color:", ";background-color:", ";border-radius:", ";", ";"], (0, _constants.get)('fontSizes.0'), (0, _constants.get)('fonts.mono'), (0, _constants.get)('colors.fg.muted'), (0, _constants.get)('colors.accent.subtle'), (0, _constants.get)('radii.2'), _sx.default);
20
20
 
21
21
  var _default = BranchName;
22
22
  exports.default = _default;
package/lib/Details.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { SystemCommonProps } from './constants';
2
1
  import { SxProp } from './sx';
3
2
  import { ComponentProps } from './utils/types';
4
- declare const Details: import("styled-components").StyledComponent<"details", any, SystemCommonProps & SxProp, never>;
3
+ declare const Details: import("styled-components").StyledComponent<"details", any, SxProp, never>;
5
4
  export declare type DetailsProps = ComponentProps<typeof Details>;
6
5
  export default Details;
package/lib/Details.js CHANGED
@@ -7,8 +7,6 @@ exports.default = void 0;
7
7
 
8
8
  var _styledComponents = _interopRequireDefault(require("styled-components"));
9
9
 
10
- var _constants = require("./constants");
11
-
12
10
  var _sx = _interopRequireDefault(require("./sx"));
13
11
 
14
12
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -16,7 +14,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
16
14
  const Details = _styledComponents.default.details.withConfig({
17
15
  displayName: "Details",
18
16
  componentId: "ssy9qz-0"
19
- })(["& > summary{list-style:none;}& > summary::-webkit-details-marker{display:none;}", " ", ";"], _constants.COMMON, _sx.default);
17
+ })(["& > summary{list-style:none;}& > summary::-webkit-details-marker{display:none;}", ";"], _sx.default);
20
18
 
21
19
  Details.displayName = 'Details';
22
20
  var _default = Details;
package/lib/Dropdown.d.ts CHANGED
@@ -15,46 +15,14 @@ export declare type DropdownMenuProps = ComponentProps<typeof DropdownMenu>;
15
15
  export declare type DropdownItemProps = ComponentProps<typeof DropdownItem>;
16
16
  declare const _default: {
17
17
  ({ children, className, ...rest }: {
18
- backgroundColor?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
19
- color?: (string & import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>>) | undefined;
20
- display?: import("styled-system").ResponsiveValue<import("csstype").Property.Display, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
21
- marginBottom?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
22
- marginLeft?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
23
- marginRight?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
24
- marginTop?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
25
- opacity?: import("styled-system").ResponsiveValue<import("csstype").Property.Opacity, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
26
- paddingBottom?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
27
- paddingLeft?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
28
- paddingRight?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
29
- paddingTop?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
18
+ color?: string | undefined;
30
19
  translate?: "yes" | "no" | undefined;
31
- margin?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
32
- padding?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
33
20
  hidden?: boolean | undefined;
34
21
  children?: React.ReactNode;
35
22
  ref?: ((instance: HTMLElement | null) => void) | React.RefObject<HTMLElement> | null | undefined;
36
- p?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
37
23
  slot?: string | undefined;
38
24
  style?: React.CSSProperties | undefined;
39
25
  title?: string | undefined;
40
- bg?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
41
- m?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
42
- mt?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
43
- mr?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
44
- mb?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
45
- ml?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
46
- mx?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
47
- marginX?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
48
- my?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
49
- marginY?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
50
- pt?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
51
- pr?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
52
- pb?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
53
- pl?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
54
- px?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
55
- paddingX?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
56
- py?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
57
- paddingY?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
58
26
  open?: boolean | undefined;
59
27
  role?: React.AriaRole | undefined;
60
28
  sx?: import("./sx").BetterSystemStyleObject | undefined;
@@ -313,46 +281,14 @@ declare const _default: {
313
281
  theme?: any;
314
282
  }): JSX.Element;
315
283
  defaultProps: Partial<{
316
- backgroundColor?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
317
- color?: (string & import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>>) | undefined;
318
- display?: import("styled-system").ResponsiveValue<import("csstype").Property.Display, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
319
- marginBottom?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
320
- marginLeft?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
321
- marginRight?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
322
- marginTop?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
323
- opacity?: import("styled-system").ResponsiveValue<import("csstype").Property.Opacity, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
324
- paddingBottom?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
325
- paddingLeft?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
326
- paddingRight?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
327
- paddingTop?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
284
+ color?: string | undefined;
328
285
  translate?: "yes" | "no" | undefined;
329
- margin?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
330
- padding?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
331
286
  hidden?: boolean | undefined;
332
287
  children?: React.ReactNode;
333
288
  ref?: ((instance: HTMLElement | null) => void) | React.RefObject<HTMLElement> | null | undefined;
334
- p?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
335
289
  slot?: string | undefined;
336
290
  style?: React.CSSProperties | undefined;
337
291
  title?: string | undefined;
338
- bg?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
339
- m?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
340
- mt?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
341
- mr?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
342
- mb?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
343
- ml?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
344
- mx?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
345
- marginX?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
346
- my?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
347
- marginY?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
348
- pt?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
349
- pr?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
350
- pb?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
351
- pl?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
352
- px?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
353
- paddingX?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
354
- py?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
355
- paddingY?: import("styled-system").ResponsiveValue<string | number | symbol, Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>> | undefined;
356
292
  open?: boolean | undefined;
357
293
  role?: React.AriaRole | undefined;
358
294
  sx?: import("./sx").BetterSystemStyleObject | undefined;
package/lib/Heading.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { SystemCommonProps, SystemTypographyProps } from './constants';
2
1
  import { SxProp } from './sx';
3
2
  import { ComponentProps } from './utils/types';
4
- declare const Heading: import("styled-components").StyledComponent<"h2", any, SystemTypographyProps & SystemCommonProps & SxProp, never>;
3
+ declare const Heading: import("styled-components").StyledComponent<"h2", any, SxProp, never>;
5
4
  export declare type HeadingProps = ComponentProps<typeof Heading>;
6
5
  export default Heading;
package/lib/Heading.js CHANGED
@@ -11,17 +11,12 @@ var _constants = require("./constants");
11
11
 
12
12
  var _sx = _interopRequireDefault(require("./sx"));
13
13
 
14
- var _theme = _interopRequireDefault(require("./theme"));
15
-
16
14
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
17
15
 
18
16
  const Heading = _styledComponents.default.h2.withConfig({
19
17
  displayName: "Heading",
20
18
  componentId: "sc-1cjoo9h-0"
21
- })(["font-weight:", ";font-size:", ";margin:0;", ";", ";", ";"], (0, _constants.get)('fontWeights.bold'), (0, _constants.get)('fontSizes.5'), _constants.TYPOGRAPHY, _constants.COMMON, _sx.default);
19
+ })(["font-weight:", ";font-size:", ";margin:0;", ";"], (0, _constants.get)('fontWeights.bold'), (0, _constants.get)('fontSizes.5'), _sx.default);
22
20
 
23
- Heading.defaultProps = {
24
- theme: _theme.default
25
- };
26
21
  var _default = Heading;
27
22
  exports.default = _default;
@@ -1,17 +1,22 @@
1
1
  /// <reference types="react" />
2
2
  import { WidthProps } from 'styled-system';
3
- import { SystemCommonProps } from './constants';
4
3
  import { SxProp } from './sx';
5
- import { ComponentProps } from './utils/types';
6
- declare const Bar: import("styled-components").StyledComponent<"span", any, {
7
- progress?: string | number | undefined;
8
- } & SystemCommonProps, never>;
9
- declare const ProgressContainer: import("styled-components").StyledComponent<"span", any, {
10
- inline?: boolean | undefined;
11
- barSize?: "small" | "default" | "large" | undefined;
12
- } & WidthProps<Required<import("styled-system").Theme<import("styled-system").TLengthStyledSystem>>, import("csstype").Property.Width<import("styled-system").TLengthStyledSystem>> & SystemCommonProps & SxProp, never>;
13
- export declare type ProgressBarProps = ComponentProps<typeof ProgressContainer> & ComponentProps<typeof Bar>;
14
- declare function ProgressBar({ progress, bg, theme, ...rest }: ProgressBarProps): JSX.Element;
4
+ declare type ProgressProp = {
5
+ progress?: string | number;
6
+ };
7
+ declare const sizeMap: {
8
+ small: string;
9
+ large: string;
10
+ default: string;
11
+ };
12
+ declare type StyledProgressContainerProps = {
13
+ inline?: boolean;
14
+ barSize?: keyof typeof sizeMap;
15
+ } & WidthProps & SxProp;
16
+ export declare type ProgressBarProps = {
17
+ bg: string;
18
+ } & StyledProgressContainerProps & ProgressProp;
19
+ declare function ProgressBar({ progress, bg, ...rest }: ProgressBarProps): JSX.Element;
15
20
  declare namespace ProgressBar {
16
21
  var defaultProps: {
17
22
  bg: string;
@@ -17,12 +17,10 @@ var _sx = _interopRequireDefault(require("./sx"));
17
17
 
18
18
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
19
19
 
20
- 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); }
21
-
22
20
  const Bar = _styledComponents.default.span.withConfig({
23
21
  displayName: "ProgressBar__Bar",
24
22
  componentId: "sc-1tiva13-0"
25
- })(["width:", ";", ""], props => props.progress ? `${props.progress}%` : 0, _constants.COMMON);
23
+ })(["width:", ";", ";"], props => props.progress ? `${props.progress}%` : 0, _sx.default);
26
24
 
27
25
  const sizeMap = {
28
26
  small: '5px',
@@ -33,20 +31,18 @@ const sizeMap = {
33
31
  const ProgressContainer = _styledComponents.default.span.withConfig({
34
32
  displayName: "ProgressBar__ProgressContainer",
35
33
  componentId: "sc-1tiva13-1"
36
- })(["display:", ";overflow:hidden;background-color:", ";border-radius:", ";height:", ";", " ", " ", ";"], props => props.inline ? 'inline-flex' : 'flex', (0, _constants.get)('colors.border.default'), (0, _constants.get)('radii.1'), props => sizeMap[props.barSize || 'default'], _constants.COMMON, _styledSystem.width, _sx.default);
34
+ })(["display:", ";overflow:hidden;background-color:", ";border-radius:", ";height:", ";", " ", ";"], props => props.inline ? 'inline-flex' : 'flex', (0, _constants.get)('colors.border.default'), (0, _constants.get)('radii.1'), props => sizeMap[props.barSize || 'default'], _styledSystem.width, _sx.default);
37
35
 
38
36
  function ProgressBar({
39
37
  progress,
40
38
  bg,
41
- theme,
42
39
  ...rest
43
40
  }) {
44
- return /*#__PURE__*/_react.default.createElement(ProgressContainer, _extends({
45
- theme: theme
46
- }, rest), /*#__PURE__*/_react.default.createElement(Bar, {
41
+ return /*#__PURE__*/_react.default.createElement(ProgressContainer, rest, /*#__PURE__*/_react.default.createElement(Bar, {
47
42
  progress: progress,
48
- bg: bg,
49
- theme: theme
43
+ sx: {
44
+ bg
45
+ }
50
46
  }));
51
47
  }
52
48
 
package/lib/Spinner.d.ts CHANGED
@@ -1,5 +1,4 @@
1
1
  /// <reference types="react" />
2
- import { SystemCommonProps } from './constants';
3
2
  import { SxProp } from './sx';
4
3
  import { ComponentProps } from './utils/types';
5
4
  declare const sizeMap: {
@@ -12,6 +11,6 @@ export interface SpinnerInternalProps {
12
11
  size?: keyof typeof sizeMap;
13
12
  }
14
13
  declare function Spinner({ size: sizeKey, ...props }: SpinnerInternalProps): JSX.Element;
15
- declare const StyledSpinner: import("styled-components").StyledComponent<typeof Spinner, any, SystemCommonProps & SxProp, never>;
14
+ declare const StyledSpinner: import("styled-components").StyledComponent<typeof Spinner, any, SxProp, never>;
16
15
  export declare type SpinnerProps = ComponentProps<typeof StyledSpinner>;
17
16
  export default StyledSpinner;
package/lib/Spinner.js CHANGED
@@ -9,8 +9,6 @@ var _react = _interopRequireDefault(require("react"));
9
9
 
10
10
  var _styledComponents = _interopRequireDefault(require("styled-components"));
11
11
 
12
- var _constants = require("./constants");
13
-
14
12
  var _sx = _interopRequireDefault(require("./sx"));
15
13
 
16
14
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -54,7 +52,7 @@ Spinner.displayName = "Spinner";
54
52
  const StyledSpinner = (0, _styledComponents.default)(Spinner).withConfig({
55
53
  displayName: "Spinner__StyledSpinner",
56
54
  componentId: "sc-14tspit-0"
57
- })(["@keyframes rotate-keyframes{100%{transform:rotate(360deg);}}animation:rotate-keyframes 1s linear infinite;", " ", ""], _constants.COMMON, _sx.default);
55
+ })(["@keyframes rotate-keyframes{100%{transform:rotate(360deg);}}animation:rotate-keyframes 1s linear infinite;", ""], _sx.default);
58
56
  StyledSpinner.displayName = 'Spinner';
59
57
  var _default = StyledSpinner;
60
58
  exports.default = _default;
@@ -59,9 +59,11 @@ describe('Avatar', () => {
59
59
  });
60
60
  it('respects margin props', () => {
61
61
  expect((0, _testing.render)( /*#__PURE__*/_react.default.createElement(_.Avatar, {
62
- m: 2,
63
62
  src: "primer.png",
64
- alt: ""
63
+ alt: "",
64
+ sx: {
65
+ m: 2
66
+ }
65
67
  }))).toHaveStyleRule('margin', (0, _testing.px)(_theme.default.space[2]));
66
68
  });
67
69
  });
@@ -0,0 +1,3 @@
1
+ /// <reference types="react" />
2
+ export declare function shouldAcceptCallWithNoProps(): JSX.Element;
3
+ export declare function shouldNotAcceptSystemProps(): JSX.Element;
@@ -0,0 +1,31 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.shouldAcceptCallWithNoProps = shouldAcceptCallWithNoProps;
7
+ exports.shouldNotAcceptSystemProps = shouldNotAcceptSystemProps;
8
+
9
+ var _react = _interopRequireDefault(require("react"));
10
+
11
+ var _Avatar = _interopRequireDefault(require("../Avatar"));
12
+
13
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
+
15
+ function shouldAcceptCallWithNoProps() {
16
+ return /*#__PURE__*/_react.default.createElement(_Avatar.default, {
17
+ src: "https://avatars.githubusercontent.com/primer"
18
+ });
19
+ }
20
+
21
+ shouldAcceptCallWithNoProps.displayName = "shouldAcceptCallWithNoProps";
22
+
23
+ function shouldNotAcceptSystemProps() {
24
+ // @ts-expect-error system props should not be accepted
25
+ return /*#__PURE__*/_react.default.createElement(_Avatar.default, {
26
+ src: "https://avatars.githubusercontent.com/primer",
27
+ backgroundColor: "thistle"
28
+ });
29
+ }
30
+
31
+ shouldNotAcceptSystemProps.displayName = "shouldNotAcceptSystemProps";
@@ -0,0 +1,3 @@
1
+ /// <reference types="react" />
2
+ export declare function shouldAcceptCallWithNoProps(): JSX.Element;
3
+ export declare function shouldNotAcceptSystemProps(): JSX.Element;
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.shouldAcceptCallWithNoProps = shouldAcceptCallWithNoProps;
7
+ exports.shouldNotAcceptSystemProps = shouldNotAcceptSystemProps;
8
+
9
+ var _react = _interopRequireDefault(require("react"));
10
+
11
+ var _BranchName = _interopRequireDefault(require("../BranchName"));
12
+
13
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
+
15
+ function shouldAcceptCallWithNoProps() {
16
+ return /*#__PURE__*/_react.default.createElement(_BranchName.default, null);
17
+ }
18
+
19
+ shouldAcceptCallWithNoProps.displayName = "shouldAcceptCallWithNoProps";
20
+
21
+ function shouldNotAcceptSystemProps() {
22
+ // @ts-expect-error system props should not be accepted
23
+ return /*#__PURE__*/_react.default.createElement(_BranchName.default, {
24
+ backgroundColor: "thistle"
25
+ });
26
+ }
27
+
28
+ shouldNotAcceptSystemProps.displayName = "shouldNotAcceptSystemProps";
@@ -0,0 +1,3 @@
1
+ /// <reference types="react" />
2
+ export declare function shouldAcceptCallWithNoProps(): JSX.Element;
3
+ export declare function shouldNotAcceptSystemProps(): JSX.Element;
@@ -0,0 +1,28 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.shouldAcceptCallWithNoProps = shouldAcceptCallWithNoProps;
7
+ exports.shouldNotAcceptSystemProps = shouldNotAcceptSystemProps;
8
+
9
+ var _react = _interopRequireDefault(require("react"));
10
+
11
+ var _Details = _interopRequireDefault(require("../Details"));
12
+
13
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
+
15
+ function shouldAcceptCallWithNoProps() {
16
+ return /*#__PURE__*/_react.default.createElement(_Details.default, null);
17
+ }
18
+
19
+ shouldAcceptCallWithNoProps.displayName = "shouldAcceptCallWithNoProps";
20
+
21
+ function shouldNotAcceptSystemProps() {
22
+ // @ts-expect-error system props should not be accepted
23
+ return /*#__PURE__*/_react.default.createElement(_Details.default, {
24
+ backgroundColor: "thistle"
25
+ });
26
+ }
27
+
28
+ shouldNotAcceptSystemProps.displayName = "shouldNotAcceptSystemProps";