@atlaskit/primitives 0.8.1 → 0.8.3

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.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/primitives
2
2
 
3
+ ## 0.8.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [`64e7c72773e`](https://bitbucket.org/atlassian/atlassian-frontend/commits/64e7c72773e) - Update type to allow typehints for CSS color property.
8
+
9
+ ## 0.8.2
10
+
11
+ ### Patch Changes
12
+
13
+ - [`983b1e61003`](https://bitbucket.org/atlassian/atlassian-frontend/commits/983b1e61003) - Fix Primitives pages being shown in prod despite being marked as alpha.
14
+
3
15
  ## 0.8.1
4
16
 
5
17
  ### Patch Changes
@@ -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,7 +61,7 @@ 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
 
@@ -1,5 +1,5 @@
1
1
  ---
2
- title: Box
2
+ title: Stack
3
3
  description: A stack is...
4
4
  order: 1
5
5
  ---
@@ -1,7 +1,62 @@
1
1
  ---
2
2
  title: Stack
3
- description: Stack primitive...
3
+ description: Stack is an abstraction to lay-out a group of elements vertically.
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
+ ---
2
+ order: 2
3
+ ---
4
+
5
+ ## Usage
6
+
7
+ *Coming soon*
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.1",
3
+ "version": "0.8.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.1",
3
+ "version": "0.8.3",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.1",
3
+ "version": "0.8.3",
4
4
  "sideEffects": false
5
5
  }
@@ -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"];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/primitives",
3
- "version": "0.8.1",
3
+ "version": "0.8.3",
4
4
  "description": "Primitives are token-backed low-level building blocks.",
5
5
  "author": "Atlassian Pty Ltd",
6
6
  "license": "Apache-2.0",
@@ -16,6 +16,9 @@
16
16
  "website": {
17
17
  "category": "Primitives",
18
18
  "name": "Primitives",
19
+ "status": {
20
+ "type": "alpha"
21
+ },
19
22
  "pages": [
20
23
  {
21
24
  "title": "Overview",
@@ -94,6 +97,7 @@
94
97
  "@atlaskit/icon": "*",
95
98
  "@atlaskit/icon-object": "*",
96
99
  "@atlaskit/lozenge": "*",
100
+ "@atlaskit/radio": "^5.4.9",
97
101
  "@atlaskit/ssr": "*",
98
102
  "@atlaskit/tag": "*",
99
103
  "@atlaskit/theme": "*",
package/report.api.md CHANGED
@@ -637,9 +637,10 @@ type TokenisedProps = {
637
637
  alignSelf?: AlignSelf;
638
638
  backgroundColor?: BackgroundColor;
639
639
  borderColor?: BorderColor;
640
- borderStyle?: BorderStyle;
641
640
  borderRadius?: BorderRadius;
641
+ borderStyle?: BorderStyle;
642
642
  borderWidth?: BorderWidth;
643
+ color?: TextColor;
643
644
  display?: Display;
644
645
  flex?: Flex;
645
646
  flexDirection?: FlexDirection;
@@ -647,23 +648,22 @@ type TokenisedProps = {
647
648
  flexShrink?: FlexShrink;
648
649
  height?: Height;
649
650
  layer?: Layer;
650
- maxWidth?: MaxWidth;
651
651
  maxHeight?: MaxHeight;
652
- minWidth?: MinWidth;
652
+ maxWidth?: MaxWidth;
653
653
  minHeight?: MinHeight;
654
+ minWidth?: MinWidth;
654
655
  overflow?: Overflow;
655
- overflowInline?: OverflowInline;
656
656
  overflowBlock?: OverflowBlock;
657
+ overflowInline?: OverflowInline;
657
658
  padding?: Padding;
658
659
  paddingBlock?: PaddingBlock;
659
- paddingBlockStart?: PaddingBlockStart;
660
660
  paddingBlockEnd?: PaddingBlockEnd;
661
+ paddingBlockStart?: PaddingBlockStart;
661
662
  paddingInline?: PaddingInline;
662
- paddingInlineStart?: PaddingInlineStart;
663
663
  paddingInlineEnd?: PaddingInlineEnd;
664
+ paddingInlineStart?: PaddingInlineStart;
664
665
  position?: Position;
665
666
  shadow?: Shadow;
666
- textColor?: TextColor;
667
667
  width?: Width;
668
668
  };
669
669
 
@@ -574,9 +574,10 @@ type TokenisedProps = {
574
574
  alignSelf?: AlignSelf;
575
575
  backgroundColor?: BackgroundColor;
576
576
  borderColor?: BorderColor;
577
- borderStyle?: BorderStyle;
578
577
  borderRadius?: BorderRadius;
578
+ borderStyle?: BorderStyle;
579
579
  borderWidth?: BorderWidth;
580
+ color?: TextColor;
580
581
  display?: Display;
581
582
  flex?: Flex;
582
583
  flexDirection?: FlexDirection;
@@ -584,23 +585,22 @@ type TokenisedProps = {
584
585
  flexShrink?: FlexShrink;
585
586
  height?: Height;
586
587
  layer?: Layer;
587
- maxWidth?: MaxWidth;
588
588
  maxHeight?: MaxHeight;
589
- minWidth?: MinWidth;
589
+ maxWidth?: MaxWidth;
590
590
  minHeight?: MinHeight;
591
+ minWidth?: MinWidth;
591
592
  overflow?: Overflow;
592
- overflowInline?: OverflowInline;
593
593
  overflowBlock?: OverflowBlock;
594
+ overflowInline?: OverflowInline;
594
595
  padding?: Padding;
595
596
  paddingBlock?: PaddingBlock;
596
- paddingBlockStart?: PaddingBlockStart;
597
597
  paddingBlockEnd?: PaddingBlockEnd;
598
+ paddingBlockStart?: PaddingBlockStart;
598
599
  paddingInline?: PaddingInline;
599
- paddingInlineStart?: PaddingInlineStart;
600
600
  paddingInlineEnd?: PaddingInlineEnd;
601
+ paddingInlineStart?: PaddingInlineStart;
601
602
  position?: Position;
602
603
  shadow?: Shadow;
603
- textColor?: TextColor;
604
604
  width?: Width;
605
605
  };
606
606
 
File without changes