@atlaskit/primitives 0.8.2 → 0.8.4

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.
Files changed (31) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/constellation/inline/code.mdx +11 -0
  3. package/constellation/inline/examples.mdx +6 -6
  4. package/constellation/overview/examples.mdx +2 -4
  5. package/constellation/stack/code.mdx +5 -3
  6. package/constellation/stack/examples.mdx +57 -2
  7. package/dist/cjs/components/internal/extract-react-types/inline-props.js +7 -0
  8. package/dist/cjs/components/internal/extract-react-types/stack-props.js +7 -0
  9. package/dist/cjs/internal/style-maps.partial.js +1 -1
  10. package/dist/cjs/version.json +1 -1
  11. package/dist/es2019/components/internal/extract-react-types/inline-props.js +1 -0
  12. package/dist/es2019/components/internal/extract-react-types/stack-props.js +1 -0
  13. package/dist/es2019/internal/style-maps.partial.js +1 -1
  14. package/dist/es2019/version.json +1 -1
  15. package/dist/esm/components/internal/extract-react-types/inline-props.js +1 -0
  16. package/dist/esm/components/internal/extract-react-types/stack-props.js +1 -0
  17. package/dist/esm/internal/style-maps.partial.js +1 -1
  18. package/dist/esm/version.json +1 -1
  19. package/dist/types/components/inline.d.ts +2 -2
  20. package/dist/types/components/internal/extract-react-types/inline-props.d.ts +2 -0
  21. package/dist/types/components/internal/extract-react-types/stack-props.d.ts +2 -0
  22. package/dist/types/components/stack.d.ts +2 -2
  23. package/dist/types/internal/style-maps.partial.d.ts +17 -17
  24. package/extract-react-types/stack-props.tsx +3 -0
  25. package/package.json +2 -10
  26. package/report.api.md +156 -66
  27. package/scripts/spacing-codegen-template.tsx +19 -20
  28. package/tmp/api-report-tmp.d.ts +18 -54
  29. package/constellation/inline/props.mdx +0 -3
  30. package/constellation/inline/usage.mdx +0 -7
  31. /package/extract-react-types/{inline.tsx → inline-props.tsx} +0 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/primitives
2
2
 
3
+ ## 0.8.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`7127e85932a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7127e85932a) - Update codegen to explicitly list spacing prop values as string unions for compatibility with extract-react-types.
8
+
9
+ ## 0.8.3
10
+
11
+ ### Patch Changes
12
+
13
+ - [`64e7c72773e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/64e7c72773e) - Update type to allow typehints for CSS color property.
14
+
3
15
  ## 0.8.2
4
16
 
5
17
  ### Patch Changes
@@ -0,0 +1,11 @@
1
+ ---
2
+ title: Inline
3
+ description: Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
4
+ order: 1
5
+ ---
6
+
7
+ import InlineProps from '!!extract-react-types-loader!../../src/components/internal/extract-react-types/inline-props'
8
+
9
+ ## Props
10
+
11
+ <PropsTable heading="" props={InlineProps} />
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  title: Inline
3
- description: Inline is an abstraction to lay-out a group of elements horizontally.
3
+ description: Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
4
4
  order: 0
5
5
  ---
6
6
 
@@ -18,7 +18,7 @@ import InlineAs from '../../examples/constellation/inline/as';
18
18
  ## Basic
19
19
 
20
20
  Inline is an abstraction to efficiently lay-out a group of elements horizontally.
21
- Use the given props to configure display behaviour using scalable recommendations of the Atlassian Design System.
21
+ Use the given props to configure display behaviour using scalable recommendations from the Atlassian Design System.
22
22
 
23
23
  <Example Component={InlineBasic} packageName="@atlaskit/primitives/inline" />
24
24
 
@@ -36,8 +36,8 @@ For a different space value between rows use the `rowSpace` prop, as shown in th
36
36
 
37
37
  ## Alignment
38
38
 
39
- To control the alignment of items you can use the `alignBlock` and `alignInline` props which, respectively, control
40
- aligment in the block and inline directions.
39
+ To control the alignment of items you can use the `alignBlock` and `alignInline` props which control
40
+ alignment in the block and inline directions respectively.
41
41
 
42
42
  ### Block alignment
43
43
 
@@ -61,13 +61,13 @@ When the number of items goes beyond the available space `shouldWrap` can be use
61
61
 
62
62
  ## Separator
63
63
 
64
- For logically related elements it's possible to specify an arbitrary `separator` value.
64
+ For logically related elements it's possible to specify a `separator` value.
65
65
 
66
66
  <Example Component={InlineSeparator} packageName="@atlaskit/primitives/inline" />
67
67
 
68
68
  ## Width control
69
69
 
70
- By default an `Inline` will have its width influenced by the context where it appears.
70
+ By default an `Inline` will have its width influenced by the context where it appears.
71
71
 
72
72
  To control that the `grow` prop can be used with the values:
73
73
 
@@ -1,9 +1,7 @@
1
1
  ---
2
2
  title: Overview
3
- description: Overview of primitives..
3
+ description: Coming soon.
4
4
  order: 0
5
5
  ---
6
6
 
7
- ## Default
8
-
9
- This is placeholder text.
7
+ *Coming soon.*
@@ -1,9 +1,11 @@
1
1
  ---
2
- title: Box
3
- description: A stack is...
2
+ title: Stack
3
+ description: Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
4
4
  order: 1
5
5
  ---
6
6
 
7
+ import StackProps from '!!extract-react-types-loader!../../src/components/internal/extract-react-types/stack-props'
8
+
7
9
  ## Props
8
10
 
9
- *Coming soon*
11
+ <PropsTable heading="" props={StackProps} />
@@ -1,7 +1,62 @@
1
1
  ---
2
2
  title: Stack
3
- description: Stack primitive...
3
+ description: Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
4
4
  order: 0
5
5
  ---
6
6
 
7
- *Coming soon*
7
+ import StackBasic from '../../examples/constellation/stack/basic';
8
+ import StackSpaceBasic from '../../examples/constellation/stack/space-basic';
9
+ import StackAlignBlock from '../../examples/constellation/stack/align-block';
10
+ import StackAlignInline from '../../examples/constellation/stack/align-inline';
11
+ import StackSpread from '../../examples/constellation/stack/spread';
12
+ import StackGrow from '../../examples/constellation/stack/grow';
13
+ import StackAs from '../../examples/constellation/stack/as';
14
+
15
+ ## Basic
16
+
17
+ Stack is an abstraction to lay-out a group of elements vertically.
18
+ Use the given props to configure display behaviour using scalable recommendations from the Atlassian Design System.
19
+
20
+ <Example Component={StackBasic} packageName="@atlaskit/primitives/stack" />
21
+
22
+ ## Space
23
+
24
+ Spacing between items can be controlled with the `space` prop:
25
+
26
+ <Example Component={StackSpaceBasic} packageName="@atlaskit/primitives/stack" />
27
+
28
+ ## Alignment
29
+
30
+ To control the alignment of items you can use the `alignBlock` and `alignInline` props which control
31
+ alignment in the block and inline directions respectively.
32
+
33
+ ### Block alignment
34
+
35
+ <Example Component={StackAlignBlock} packageName="@atlaskit/primitives/stack" />
36
+
37
+ ### Inline alignment
38
+
39
+ <Example Component={StackAlignInline} packageName="@atlaskit/primitives/stack" />
40
+
41
+ ## Spread
42
+
43
+ Elements can be set to stay together next to each other (default behaviour) or spread equally in the space available.
44
+
45
+ <Example Component={StackSpread} packageName="@atlaskit/primitives/stack" />
46
+
47
+ ## Width control
48
+
49
+ By default a `Stack` will have its width influenced by the context where it appears.
50
+
51
+ To control that the `grow` prop can be used with the values:
52
+
53
+ * `hug` (default) to use space only as required by its children, or
54
+ * `fill` to take all space provided by the parent element.
55
+
56
+ <Example Component={StackGrow} packageName="@atlaskit/primitives/stack" />
57
+
58
+ ## Output element
59
+
60
+ It's possible to control the rendered HTML element with the `as` prop.
61
+
62
+ <Example Component={StackAs} packageName="@atlaskit/primitives/stack" />
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = Inline;
7
+ function Inline(_) {}
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = Inline;
7
+ function Inline(_) {}
@@ -32,7 +32,7 @@ exports.dimensionMap = dimensionMap;
32
32
 
33
33
  /**
34
34
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
35
- * @codegen <<SignedSource::b8ac4fd29ba83e2ab1c2713c35915067>>
35
+ * @codegen <<SignedSource::06b49ea9175072486628ad5a39dd0c4b>>
36
36
  * @codegenId spacing
37
37
  * @codegenCommand yarn codegen-styles
38
38
  * @codegenParams ["padding", "space"]
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1 @@
1
+ export default function Inline(_) {}
@@ -0,0 +1 @@
1
+ export default function Inline(_) {}
@@ -22,7 +22,7 @@ export const dimensionMap = {
22
22
  */
23
23
  /**
24
24
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
25
- * @codegen <<SignedSource::b8ac4fd29ba83e2ab1c2713c35915067>>
25
+ * @codegen <<SignedSource::06b49ea9175072486628ad5a39dd0c4b>>
26
26
  * @codegenId spacing
27
27
  * @codegenCommand yarn codegen-styles
28
28
  * @codegenParams ["padding", "space"]
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -0,0 +1 @@
1
+ export default function Inline(_) {}
@@ -0,0 +1 @@
1
+ export default function Inline(_) {}
@@ -23,7 +23,7 @@ export var dimensionMap = {
23
23
  */
24
24
  /**
25
25
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
26
- * @codegen <<SignedSource::b8ac4fd29ba83e2ab1c2713c35915067>>
26
+ * @codegen <<SignedSource::06b49ea9175072486628ad5a39dd0c4b>>
27
27
  * @codegenId spacing
28
28
  * @codegenCommand yarn codegen-styles
29
29
  * @codegenParams ["padding", "space"]
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { ComponentPropsWithRef, ElementType, ReactNode } from 'react';
2
+ import { ElementType, ReactNode } from 'react';
3
3
  import { type Gap, type RowGap } from '../internal/style-maps.partial';
4
4
  export interface InlineProps<T extends ElementType = 'div'> {
5
5
  /**
@@ -50,7 +50,7 @@ export interface InlineProps<T extends ElementType = 'div'> {
50
50
  /**
51
51
  * Forwarded ref element
52
52
  */
53
- ref?: ComponentPropsWithRef<T>['ref'];
53
+ ref?: React.ComponentPropsWithRef<T>['ref'];
54
54
  }
55
55
  export declare type AlignInline = 'start' | 'center' | 'end';
56
56
  export declare type AlignBlock = 'start' | 'center' | 'end' | 'baseline';
@@ -0,0 +1,2 @@
1
+ import type { InlineProps } from '../../inline';
2
+ export default function Inline(_: InlineProps): void;
@@ -0,0 +1,2 @@
1
+ import type { StackProps } from '../../stack';
2
+ export default function Inline(_: StackProps): void;
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { ComponentPropsWithRef, ElementType, ReactNode } from 'react';
2
+ import { ElementType, ReactNode } from 'react';
3
3
  import { type Gap } from '../internal/style-maps.partial';
4
4
  export interface StackProps<T extends ElementType = 'div'> {
5
5
  /**
@@ -37,7 +37,7 @@ export interface StackProps<T extends ElementType = 'div'> {
37
37
  /**
38
38
  * Forwarded ref element
39
39
  */
40
- ref?: ComponentPropsWithRef<T>['ref'];
40
+ ref?: React.ComponentPropsWithRef<T>['ref'];
41
41
  }
42
42
  export declare type AlignInline = 'start' | 'center' | 'end';
43
43
  export declare type AlignBlock = 'start' | 'center' | 'end';
@@ -28,7 +28,7 @@ export declare type MaxHeight = keyof typeof dimensionMap;
28
28
  */
29
29
  /**
30
30
  * THIS SECTION WAS CREATED VIA CODEGEN DO NOT MODIFY {@see http://go/af-codegen}
31
- * @codegen <<SignedSource::b8ac4fd29ba83e2ab1c2713c35915067>>
31
+ * @codegen <<SignedSource::06b49ea9175072486628ad5a39dd0c4b>>
32
32
  * @codegenId spacing
33
33
  * @codegenCommand yarn codegen-styles
34
34
  * @codegenParams ["padding", "space"]
@@ -50,13 +50,13 @@ export declare const paddingMap: {
50
50
  readonly 'space.800': "var(--ds-space-800)";
51
51
  readonly 'space.1000': "var(--ds-space-1000)";
52
52
  };
53
- export declare type Padding = keyof typeof paddingMap;
54
- export declare type PaddingBlock = keyof typeof paddingMap;
55
- export declare type PaddingBlockStart = keyof typeof paddingMap;
56
- export declare type PaddingBlockEnd = keyof typeof paddingMap;
57
- export declare type PaddingInline = keyof typeof paddingMap;
58
- export declare type PaddingInlineStart = keyof typeof paddingMap;
59
- export declare type PaddingInlineEnd = keyof typeof paddingMap;
53
+ export declare type Padding = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
54
+ export declare type PaddingBlock = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
55
+ export declare type PaddingBlockStart = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
56
+ export declare type PaddingBlockEnd = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
57
+ export declare type PaddingInline = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
58
+ export declare type PaddingInlineStart = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
59
+ export declare type PaddingInlineEnd = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
60
60
  export declare const spaceMap: {
61
61
  readonly 'space.0': "var(--ds-space-0)";
62
62
  readonly 'space.025': "var(--ds-space-025)";
@@ -73,8 +73,8 @@ export declare const spaceMap: {
73
73
  readonly 'space.800': "var(--ds-space-800)";
74
74
  readonly 'space.1000': "var(--ds-space-1000)";
75
75
  };
76
- export declare type Gap = keyof typeof spaceMap;
77
- export declare type RowGap = keyof typeof spaceMap;
76
+ export declare type Gap = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
77
+ export declare type RowGap = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800' | 'space.1000';
78
78
  /**
79
79
  * @codegenEnd
80
80
  */
@@ -381,9 +381,10 @@ export declare type TokenisedProps = {
381
381
  alignSelf?: AlignSelf;
382
382
  backgroundColor?: BackgroundColor;
383
383
  borderColor?: BorderColor;
384
- borderStyle?: BorderStyle;
385
384
  borderRadius?: BorderRadius;
385
+ borderStyle?: BorderStyle;
386
386
  borderWidth?: BorderWidth;
387
+ color?: TextColor;
387
388
  display?: Display;
388
389
  flex?: Flex;
389
390
  flexDirection?: FlexDirection;
@@ -391,23 +392,22 @@ export declare type TokenisedProps = {
391
392
  flexShrink?: FlexShrink;
392
393
  height?: Height;
393
394
  layer?: Layer;
394
- maxWidth?: MaxWidth;
395
395
  maxHeight?: MaxHeight;
396
- minWidth?: MinWidth;
396
+ maxWidth?: MaxWidth;
397
397
  minHeight?: MinHeight;
398
+ minWidth?: MinWidth;
398
399
  overflow?: Overflow;
399
- overflowInline?: OverflowInline;
400
400
  overflowBlock?: OverflowBlock;
401
+ overflowInline?: OverflowInline;
401
402
  padding?: Padding;
402
403
  paddingBlock?: PaddingBlock;
403
- paddingBlockStart?: PaddingBlockStart;
404
404
  paddingBlockEnd?: PaddingBlockEnd;
405
+ paddingBlockStart?: PaddingBlockStart;
405
406
  paddingInline?: PaddingInline;
406
- paddingInlineStart?: PaddingInlineStart;
407
407
  paddingInlineEnd?: PaddingInlineEnd;
408
+ paddingInlineStart?: PaddingInlineStart;
408
409
  position?: Position;
409
410
  shadow?: Shadow;
410
- textColor?: TextColor;
411
411
  width?: Width;
412
412
  };
413
413
  declare const spacingProperties: readonly ["padding", "paddingBlock", "paddingBlockStart", "paddingBlockEnd", "paddingInline", "paddingInlineStart", "paddingInlineEnd", "gap", "rowGap"];
@@ -0,0 +1,3 @@
1
+ import type { StackProps } from '../src/components/stack';
2
+
3
+ export default function Stack(_: StackProps) {}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.2",
3
+ "version": "0.8.4",
4
4
  "description": "Primitives are token-backed low-level building blocks.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -29,15 +29,6 @@
29
29
  "type": "alpha"
30
30
  }
31
31
  },
32
- {
33
- "title": "Box",
34
- "folder": "box",
35
- "slug": "primitives/box",
36
- "id": "@atlaskit/primitives/box",
37
- "status": {
38
- "type": "alpha"
39
- }
40
- },
41
32
  {
42
33
  "title": "Inline",
43
34
  "folder": "inline",
@@ -97,6 +88,7 @@
97
88
  "@atlaskit/icon": "*",
98
89
  "@atlaskit/icon-object": "*",
99
90
  "@atlaskit/lozenge": "*",
91
+ "@atlaskit/radio": "^5.4.9",
100
92
  "@atlaskit/ssr": "*",
101
93
  "@atlaskit/tag": "*",
102
94
  "@atlaskit/theme": "*",
package/report.api.md CHANGED
@@ -347,7 +347,21 @@ const flexShrinkMap: {
347
347
  };
348
348
 
349
349
  // @public (undocumented)
350
- type Gap = keyof typeof spaceMap;
350
+ type Gap =
351
+ | 'space.0'
352
+ | 'space.025'
353
+ | 'space.050'
354
+ | 'space.075'
355
+ | 'space.100'
356
+ | 'space.1000'
357
+ | 'space.150'
358
+ | 'space.200'
359
+ | 'space.250'
360
+ | 'space.300'
361
+ | 'space.400'
362
+ | 'space.500'
363
+ | 'space.600'
364
+ | 'space.800';
351
365
 
352
366
  // @public (undocumented)
353
367
  type Grow = 'fill' | 'hug';
@@ -386,7 +400,7 @@ export interface InlineProps<T extends ElementType = 'div'> {
386
400
  as?: 'div' | 'ol' | 'span' | 'ul';
387
401
  children: ReactNode;
388
402
  grow?: Grow;
389
- ref?: ComponentPropsWithRef<T>['ref'];
403
+ ref?: React.ComponentPropsWithRef<T>['ref'];
390
404
  rowSpace?: RowGap;
391
405
  separator?: string;
392
406
  shouldWrap?: boolean;
@@ -459,43 +473,123 @@ const overflowMap: {
459
473
  };
460
474
 
461
475
  // @public (undocumented)
462
- type Padding = keyof typeof paddingMap;
463
-
464
- // @public (undocumented)
465
- type PaddingBlock = keyof typeof paddingMap;
466
-
467
- // @public (undocumented)
468
- type PaddingBlockEnd = keyof typeof paddingMap;
469
-
470
- // @public (undocumented)
471
- type PaddingBlockStart = keyof typeof paddingMap;
472
-
473
- // @public (undocumented)
474
- type PaddingInline = keyof typeof paddingMap;
475
-
476
- // @public (undocumented)
477
- type PaddingInlineEnd = keyof typeof paddingMap;
478
-
479
- // @public (undocumented)
480
- type PaddingInlineStart = keyof typeof paddingMap;
481
-
482
- // @public
483
- const paddingMap: {
484
- readonly 'space.0': 'var(--ds-space-0)';
485
- readonly 'space.025': 'var(--ds-space-025)';
486
- readonly 'space.050': 'var(--ds-space-050)';
487
- readonly 'space.075': 'var(--ds-space-075)';
488
- readonly 'space.100': 'var(--ds-space-100)';
489
- readonly 'space.150': 'var(--ds-space-150)';
490
- readonly 'space.200': 'var(--ds-space-200)';
491
- readonly 'space.250': 'var(--ds-space-250)';
492
- readonly 'space.300': 'var(--ds-space-300)';
493
- readonly 'space.400': 'var(--ds-space-400)';
494
- readonly 'space.500': 'var(--ds-space-500)';
495
- readonly 'space.600': 'var(--ds-space-600)';
496
- readonly 'space.800': 'var(--ds-space-800)';
497
- readonly 'space.1000': 'var(--ds-space-1000)';
498
- };
476
+ type Padding =
477
+ | 'space.0'
478
+ | 'space.025'
479
+ | 'space.050'
480
+ | 'space.075'
481
+ | 'space.100'
482
+ | 'space.1000'
483
+ | 'space.150'
484
+ | 'space.200'
485
+ | 'space.250'
486
+ | 'space.300'
487
+ | 'space.400'
488
+ | 'space.500'
489
+ | 'space.600'
490
+ | 'space.800';
491
+
492
+ // @public (undocumented)
493
+ type PaddingBlock =
494
+ | 'space.0'
495
+ | 'space.025'
496
+ | 'space.050'
497
+ | 'space.075'
498
+ | 'space.100'
499
+ | 'space.1000'
500
+ | 'space.150'
501
+ | 'space.200'
502
+ | 'space.250'
503
+ | 'space.300'
504
+ | 'space.400'
505
+ | 'space.500'
506
+ | 'space.600'
507
+ | 'space.800';
508
+
509
+ // @public (undocumented)
510
+ type PaddingBlockEnd =
511
+ | 'space.0'
512
+ | 'space.025'
513
+ | 'space.050'
514
+ | 'space.075'
515
+ | 'space.100'
516
+ | 'space.1000'
517
+ | 'space.150'
518
+ | 'space.200'
519
+ | 'space.250'
520
+ | 'space.300'
521
+ | 'space.400'
522
+ | 'space.500'
523
+ | 'space.600'
524
+ | 'space.800';
525
+
526
+ // @public (undocumented)
527
+ type PaddingBlockStart =
528
+ | 'space.0'
529
+ | 'space.025'
530
+ | 'space.050'
531
+ | 'space.075'
532
+ | 'space.100'
533
+ | 'space.1000'
534
+ | 'space.150'
535
+ | 'space.200'
536
+ | 'space.250'
537
+ | 'space.300'
538
+ | 'space.400'
539
+ | 'space.500'
540
+ | 'space.600'
541
+ | 'space.800';
542
+
543
+ // @public (undocumented)
544
+ type PaddingInline =
545
+ | 'space.0'
546
+ | 'space.025'
547
+ | 'space.050'
548
+ | 'space.075'
549
+ | 'space.100'
550
+ | 'space.1000'
551
+ | 'space.150'
552
+ | 'space.200'
553
+ | 'space.250'
554
+ | 'space.300'
555
+ | 'space.400'
556
+ | 'space.500'
557
+ | 'space.600'
558
+ | 'space.800';
559
+
560
+ // @public (undocumented)
561
+ type PaddingInlineEnd =
562
+ | 'space.0'
563
+ | 'space.025'
564
+ | 'space.050'
565
+ | 'space.075'
566
+ | 'space.100'
567
+ | 'space.1000'
568
+ | 'space.150'
569
+ | 'space.200'
570
+ | 'space.250'
571
+ | 'space.300'
572
+ | 'space.400'
573
+ | 'space.500'
574
+ | 'space.600'
575
+ | 'space.800';
576
+
577
+ // @public (undocumented)
578
+ type PaddingInlineStart =
579
+ | 'space.0'
580
+ | 'space.025'
581
+ | 'space.050'
582
+ | 'space.075'
583
+ | 'space.100'
584
+ | 'space.1000'
585
+ | 'space.150'
586
+ | 'space.200'
587
+ | 'space.250'
588
+ | 'space.300'
589
+ | 'space.400'
590
+ | 'space.500'
591
+ | 'space.600'
592
+ | 'space.800';
499
593
 
500
594
  // @public (undocumented)
501
595
  type Position = keyof typeof positionMap;
@@ -514,7 +608,21 @@ type PublicBoxPropsBase = {
514
608
  };
515
609
 
516
610
  // @public (undocumented)
517
- type RowGap = keyof typeof spaceMap;
611
+ type RowGap =
612
+ | 'space.0'
613
+ | 'space.025'
614
+ | 'space.050'
615
+ | 'space.075'
616
+ | 'space.100'
617
+ | 'space.1000'
618
+ | 'space.150'
619
+ | 'space.200'
620
+ | 'space.250'
621
+ | 'space.300'
622
+ | 'space.400'
623
+ | 'space.500'
624
+ | 'space.600'
625
+ | 'space.800';
518
626
 
519
627
  // @public (undocumented)
520
628
  type SafeCSSObject = CSSPseudos &
@@ -539,24 +647,6 @@ const shadowMap: {
539
647
  readonly raised: 'var(--ds-shadow-raised)';
540
648
  };
541
649
 
542
- // @public (undocumented)
543
- const spaceMap: {
544
- readonly 'space.0': 'var(--ds-space-0)';
545
- readonly 'space.025': 'var(--ds-space-025)';
546
- readonly 'space.050': 'var(--ds-space-050)';
547
- readonly 'space.075': 'var(--ds-space-075)';
548
- readonly 'space.100': 'var(--ds-space-100)';
549
- readonly 'space.150': 'var(--ds-space-150)';
550
- readonly 'space.200': 'var(--ds-space-200)';
551
- readonly 'space.250': 'var(--ds-space-250)';
552
- readonly 'space.300': 'var(--ds-space-300)';
553
- readonly 'space.400': 'var(--ds-space-400)';
554
- readonly 'space.500': 'var(--ds-space-500)';
555
- readonly 'space.600': 'var(--ds-space-600)';
556
- readonly 'space.800': 'var(--ds-space-800)';
557
- readonly 'space.1000': 'var(--ds-space-1000)';
558
- };
559
-
560
650
  // @public (undocumented)
561
651
  type Spread = 'space-between';
562
652
 
@@ -588,7 +678,7 @@ export interface StackProps<T extends ElementType = 'div'> {
588
678
  as?: 'div' | 'ol' | 'span' | 'ul';
589
679
  children: ReactNode;
590
680
  grow?: Grow_2;
591
- ref?: ComponentPropsWithRef<T>['ref'];
681
+ ref?: React.ComponentPropsWithRef<T>['ref'];
592
682
  space?: Gap;
593
683
  spread?: Spread_2;
594
684
  testId?: string;
@@ -637,9 +727,10 @@ type TokenisedProps = {
637
727
  alignSelf?: AlignSelf;
638
728
  backgroundColor?: BackgroundColor;
639
729
  borderColor?: BorderColor;
640
- borderStyle?: BorderStyle;
641
730
  borderRadius?: BorderRadius;
731
+ borderStyle?: BorderStyle;
642
732
  borderWidth?: BorderWidth;
733
+ color?: TextColor;
643
734
  display?: Display;
644
735
  flex?: Flex;
645
736
  flexDirection?: FlexDirection;
@@ -647,23 +738,22 @@ type TokenisedProps = {
647
738
  flexShrink?: FlexShrink;
648
739
  height?: Height;
649
740
  layer?: Layer;
650
- maxWidth?: MaxWidth;
651
741
  maxHeight?: MaxHeight;
652
- minWidth?: MinWidth;
742
+ maxWidth?: MaxWidth;
653
743
  minHeight?: MinHeight;
744
+ minWidth?: MinWidth;
654
745
  overflow?: Overflow;
655
- overflowInline?: OverflowInline;
656
746
  overflowBlock?: OverflowBlock;
747
+ overflowInline?: OverflowInline;
657
748
  padding?: Padding;
658
749
  paddingBlock?: PaddingBlock;
659
- paddingBlockStart?: PaddingBlockStart;
660
750
  paddingBlockEnd?: PaddingBlockEnd;
751
+ paddingBlockStart?: PaddingBlockStart;
661
752
  paddingInline?: PaddingInline;
662
- paddingInlineStart?: PaddingInlineStart;
663
753
  paddingInlineEnd?: PaddingInlineEnd;
754
+ paddingInlineStart?: PaddingInlineStart;
664
755
  position?: Position;
665
756
  shadow?: Shadow;
666
- textColor?: TextColor;
667
757
  width?: Width;
668
758
  };
669
759
 
@@ -48,9 +48,8 @@ export const createSpacingStylesFromTemplate = (
48
48
  const { cssProperties, propNameFormatter } =
49
49
  spacingProperties[spacingProperty]!;
50
50
 
51
- return (
52
- prettier.format(
53
- `
51
+ return prettier.format(
52
+ `
54
53
  export const ${spacingProperty}Map = {
55
54
  ${activeTokens
56
55
  .sort((a, b) =>
@@ -65,22 +64,22 @@ export const createSpacingStylesFromTemplate = (
65
64
  token.fallback,
66
65
  )}`;
67
66
  })}
68
- } as const;`,
69
- {
70
- singleQuote: true,
71
- trailingComma: 'all',
72
- parser: 'typescript',
73
- plugins: [parserTypeScript],
74
- },
75
- ) +
76
- (cssProperties
77
- .map(
78
- cssProperty =>
79
- `\nexport type ${capitalize(
80
- cssProperty,
81
- )} = keyof typeof ${spacingProperty}Map;`,
82
- )
83
- .join('') +
84
- '\n')
67
+ } as const;` +
68
+ (cssProperties
69
+ .map(
70
+ cssProperty =>
71
+ // TODO: Update to use `keyof` when ERT supports it: https://github.com/atlassian/extract-react-types/issues/149
72
+ `\nexport type ${capitalize(cssProperty)} = ${activeTokens
73
+ .map(token => `'${token.name}'`)
74
+ .join(' | ')}`,
75
+ )
76
+ .join('') +
77
+ '\n'),
78
+ {
79
+ singleQuote: true,
80
+ trailingComma: 'all',
81
+ parser: 'typescript',
82
+ plugins: [parserTypeScript],
83
+ },
85
84
  );
86
85
  };
@@ -322,7 +322,7 @@ const flexShrinkMap: {
322
322
  };
323
323
 
324
324
  // @public (undocumented)
325
- type Gap = keyof typeof spaceMap;
325
+ type Gap = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
326
326
 
327
327
  // @public (undocumented)
328
328
  type Grow = 'fill' | 'hug';
@@ -343,7 +343,7 @@ export interface InlineProps<T extends ElementType = 'div'> {
343
343
  as?: 'div' | 'ol' | 'span' | 'ul';
344
344
  children: ReactNode;
345
345
  grow?: Grow;
346
- ref?: ComponentPropsWithRef<T>['ref'];
346
+ ref?: React.ComponentPropsWithRef<T>['ref'];
347
347
  rowSpace?: RowGap;
348
348
  separator?: string;
349
349
  shouldWrap?: boolean;
@@ -416,43 +416,25 @@ const overflowMap: {
416
416
  };
417
417
 
418
418
  // @public (undocumented)
419
- type Padding = keyof typeof paddingMap;
419
+ type Padding = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
420
420
 
421
421
  // @public (undocumented)
422
- type PaddingBlock = keyof typeof paddingMap;
422
+ type PaddingBlock = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
423
423
 
424
424
  // @public (undocumented)
425
- type PaddingBlockEnd = keyof typeof paddingMap;
425
+ type PaddingBlockEnd = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
426
426
 
427
427
  // @public (undocumented)
428
- type PaddingBlockStart = keyof typeof paddingMap;
428
+ type PaddingBlockStart = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
429
429
 
430
430
  // @public (undocumented)
431
- type PaddingInline = keyof typeof paddingMap;
431
+ type PaddingInline = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
432
432
 
433
433
  // @public (undocumented)
434
- type PaddingInlineEnd = keyof typeof paddingMap;
434
+ type PaddingInlineEnd = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
435
435
 
436
436
  // @public (undocumented)
437
- type PaddingInlineStart = keyof typeof paddingMap;
438
-
439
- // @public
440
- const paddingMap: {
441
- readonly 'space.0': "var(--ds-space-0)";
442
- readonly 'space.025': "var(--ds-space-025)";
443
- readonly 'space.050': "var(--ds-space-050)";
444
- readonly 'space.075': "var(--ds-space-075)";
445
- readonly 'space.100': "var(--ds-space-100)";
446
- readonly 'space.150': "var(--ds-space-150)";
447
- readonly 'space.200': "var(--ds-space-200)";
448
- readonly 'space.250': "var(--ds-space-250)";
449
- readonly 'space.300': "var(--ds-space-300)";
450
- readonly 'space.400': "var(--ds-space-400)";
451
- readonly 'space.500': "var(--ds-space-500)";
452
- readonly 'space.600': "var(--ds-space-600)";
453
- readonly 'space.800': "var(--ds-space-800)";
454
- readonly 'space.1000': "var(--ds-space-1000)";
455
- };
437
+ type PaddingInlineStart = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
456
438
 
457
439
  // @public (undocumented)
458
440
  type Position = keyof typeof positionMap;
@@ -471,7 +453,7 @@ type PublicBoxPropsBase = {
471
453
  };
472
454
 
473
455
  // @public (undocumented)
474
- type RowGap = keyof typeof spaceMap;
456
+ type RowGap = 'space.0' | 'space.025' | 'space.050' | 'space.075' | 'space.100' | 'space.1000' | 'space.150' | 'space.200' | 'space.250' | 'space.300' | 'space.400' | 'space.500' | 'space.600' | 'space.800';
475
457
 
476
458
  // @public (undocumented)
477
459
  type SafeCSSObject = CSSPseudos & TokenisedProps & Omit<CSSPropertiesWithMultiValues, keyof TokenisedProps>;
@@ -491,24 +473,6 @@ const shadowMap: {
491
473
  readonly raised: "var(--ds-shadow-raised)";
492
474
  };
493
475
 
494
- // @public (undocumented)
495
- const spaceMap: {
496
- readonly 'space.0': "var(--ds-space-0)";
497
- readonly 'space.025': "var(--ds-space-025)";
498
- readonly 'space.050': "var(--ds-space-050)";
499
- readonly 'space.075': "var(--ds-space-075)";
500
- readonly 'space.100': "var(--ds-space-100)";
501
- readonly 'space.150': "var(--ds-space-150)";
502
- readonly 'space.200': "var(--ds-space-200)";
503
- readonly 'space.250': "var(--ds-space-250)";
504
- readonly 'space.300': "var(--ds-space-300)";
505
- readonly 'space.400': "var(--ds-space-400)";
506
- readonly 'space.500': "var(--ds-space-500)";
507
- readonly 'space.600': "var(--ds-space-600)";
508
- readonly 'space.800': "var(--ds-space-800)";
509
- readonly 'space.1000': "var(--ds-space-1000)";
510
- };
511
-
512
476
  // @public (undocumented)
513
477
  type Spread = 'space-between';
514
478
 
@@ -525,7 +489,7 @@ export interface StackProps<T extends ElementType = 'div'> {
525
489
  as?: 'div' | 'ol' | 'span' | 'ul';
526
490
  children: ReactNode;
527
491
  grow?: Grow_2;
528
- ref?: ComponentPropsWithRef<T>['ref'];
492
+ ref?: React.ComponentPropsWithRef<T>['ref'];
529
493
  space?: Gap;
530
494
  spread?: Spread_2;
531
495
  testId?: string;
@@ -574,9 +538,10 @@ type TokenisedProps = {
574
538
  alignSelf?: AlignSelf;
575
539
  backgroundColor?: BackgroundColor;
576
540
  borderColor?: BorderColor;
577
- borderStyle?: BorderStyle;
578
541
  borderRadius?: BorderRadius;
542
+ borderStyle?: BorderStyle;
579
543
  borderWidth?: BorderWidth;
544
+ color?: TextColor;
580
545
  display?: Display;
581
546
  flex?: Flex;
582
547
  flexDirection?: FlexDirection;
@@ -584,23 +549,22 @@ type TokenisedProps = {
584
549
  flexShrink?: FlexShrink;
585
550
  height?: Height;
586
551
  layer?: Layer;
587
- maxWidth?: MaxWidth;
588
552
  maxHeight?: MaxHeight;
589
- minWidth?: MinWidth;
553
+ maxWidth?: MaxWidth;
590
554
  minHeight?: MinHeight;
555
+ minWidth?: MinWidth;
591
556
  overflow?: Overflow;
592
- overflowInline?: OverflowInline;
593
557
  overflowBlock?: OverflowBlock;
558
+ overflowInline?: OverflowInline;
594
559
  padding?: Padding;
595
560
  paddingBlock?: PaddingBlock;
596
- paddingBlockStart?: PaddingBlockStart;
597
561
  paddingBlockEnd?: PaddingBlockEnd;
562
+ paddingBlockStart?: PaddingBlockStart;
598
563
  paddingInline?: PaddingInline;
599
- paddingInlineStart?: PaddingInlineStart;
600
564
  paddingInlineEnd?: PaddingInlineEnd;
565
+ paddingInlineStart?: PaddingInlineStart;
601
566
  position?: Position;
602
567
  shadow?: Shadow;
603
- textColor?: TextColor;
604
568
  width?: Width;
605
569
  };
606
570
 
@@ -1,3 +0,0 @@
1
- ## Props
2
-
3
- *Coming soon*
@@ -1,7 +0,0 @@
1
- ---
2
- order: 2
3
- ---
4
-
5
- ## Usage
6
-
7
- *Coming soon*