@atlaskit/primitives 0.8.0 → 0.8.1
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 +6 -0
- package/constellation/box/code.mdx +1 -3
- package/constellation/box/examples.mdx +2 -4
- package/constellation/inline/examples.mdx +83 -0
- package/constellation/inline/props.mdx +3 -0
- package/constellation/inline/usage.mdx +7 -0
- package/constellation/stack/code.mdx +9 -0
- package/constellation/stack/examples.mdx +7 -0
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/components/inline.d.ts +1 -1
- package/dist/types/components/stack.d.ts +1 -1
- package/extract-react-types/inline.tsx +3 -0
- package/package.json +28 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,11 @@
|
|
|
1
1
|
# @atlaskit/primitives
|
|
2
2
|
|
|
3
|
+
## 0.8.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`2e01c9c74b5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/2e01c9c74b5) - DUMMY remove before merging to master; dupe adf-schema via adf-utils
|
|
8
|
+
|
|
3
9
|
## 0.8.0
|
|
4
10
|
|
|
5
11
|
### Minor Changes
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Inline
|
|
3
|
+
description: Inline is an abstraction to lay-out a group of elements horizontally.
|
|
4
|
+
order: 0
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
import InlineBasic from '../../examples/constellation/inline/basic';
|
|
8
|
+
import InlineSpaceBasic from '../../examples/constellation/inline/space-basic';
|
|
9
|
+
import InlineSpaceWrap from '../../examples/constellation/inline/space-wrap';
|
|
10
|
+
import InlineAlignBlock from '../../examples/constellation/inline/align-block';
|
|
11
|
+
import InlineAlignInline from '../../examples/constellation/inline/align-inline';
|
|
12
|
+
import InlineSpread from '../../examples/constellation/inline/spread';
|
|
13
|
+
import InlineWrap from '../../examples/constellation/inline/wrap';
|
|
14
|
+
import InlineSeparator from '../../examples/constellation/inline/separator';
|
|
15
|
+
import InlineGrow from '../../examples/constellation/inline/grow';
|
|
16
|
+
import InlineAs from '../../examples/constellation/inline/as';
|
|
17
|
+
|
|
18
|
+
## Basic
|
|
19
|
+
|
|
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.
|
|
22
|
+
|
|
23
|
+
<Example Component={InlineBasic} packageName="@atlaskit/primitives/inline" />
|
|
24
|
+
|
|
25
|
+
## Space
|
|
26
|
+
|
|
27
|
+
Spacing between items can be controlled with the `space` prop:
|
|
28
|
+
|
|
29
|
+
<Example Component={InlineSpaceBasic} packageName="@atlaskit/primitives/inline" />
|
|
30
|
+
|
|
31
|
+
When content is set to wrap the `space` prop applies equal spacing between rows as well:
|
|
32
|
+
|
|
33
|
+
<Example Component={InlineSpaceWrap} packageName="@atlaskit/primitives/inline" />
|
|
34
|
+
|
|
35
|
+
For a different space value between rows use the `rowSpace` prop, as shown in the dynamic example above.
|
|
36
|
+
|
|
37
|
+
## Alignment
|
|
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.
|
|
41
|
+
|
|
42
|
+
### Block alignment
|
|
43
|
+
|
|
44
|
+
<Example Component={InlineAlignBlock} packageName="@atlaskit/primitives/inline" />
|
|
45
|
+
|
|
46
|
+
### Inline alignment
|
|
47
|
+
|
|
48
|
+
<Example Component={InlineAlignInline} packageName="@atlaskit/primitives/inline" />
|
|
49
|
+
|
|
50
|
+
## Spread
|
|
51
|
+
|
|
52
|
+
Elements can be set to stay together next to each other (default behaviour) or spread equally in the space available.
|
|
53
|
+
|
|
54
|
+
<Example Component={InlineSpread} packageName="@atlaskit/primitives/inline" />
|
|
55
|
+
|
|
56
|
+
## Wrap
|
|
57
|
+
|
|
58
|
+
When the number of items goes beyond the available space `shouldWrap` can be used to create new rows of content.
|
|
59
|
+
|
|
60
|
+
<Example Component={InlineWrap} packageName="@atlaskit/primitives/inline" />
|
|
61
|
+
|
|
62
|
+
## Separator
|
|
63
|
+
|
|
64
|
+
For logically related elements it's possible to specify an arbitrary `separator` value.
|
|
65
|
+
|
|
66
|
+
<Example Component={InlineSeparator} packageName="@atlaskit/primitives/inline" />
|
|
67
|
+
|
|
68
|
+
## Width control
|
|
69
|
+
|
|
70
|
+
By default an `Inline` will have its width influenced by the context where it appears.
|
|
71
|
+
|
|
72
|
+
To control that the `grow` prop can be used with the values:
|
|
73
|
+
|
|
74
|
+
* `hug` (default) to use space only as required by its children, or
|
|
75
|
+
* `fill` to take all space provided by the parent element.
|
|
76
|
+
|
|
77
|
+
<Example Component={InlineGrow} packageName="@atlaskit/primitives/inline" />
|
|
78
|
+
|
|
79
|
+
## Output element
|
|
80
|
+
|
|
81
|
+
It's possible to control the rendered HTML element with the `as` prop.
|
|
82
|
+
|
|
83
|
+
<Example Component={InlineAs} packageName="@atlaskit/primitives/inline" />
|
package/dist/cjs/version.json
CHANGED
package/dist/es2019/version.json
CHANGED
package/dist/esm/version.json
CHANGED
|
@@ -23,7 +23,7 @@ export interface InlineProps<T extends ElementType = 'div'> {
|
|
|
23
23
|
*/
|
|
24
24
|
spread?: Spread;
|
|
25
25
|
/**
|
|
26
|
-
* Used to set whether the
|
|
26
|
+
* Used to set whether the container should grow to fill the available space.
|
|
27
27
|
*/
|
|
28
28
|
grow?: Grow;
|
|
29
29
|
/**
|
|
@@ -19,7 +19,7 @@ export interface StackProps<T extends ElementType = 'div'> {
|
|
|
19
19
|
*/
|
|
20
20
|
spread?: Spread;
|
|
21
21
|
/**
|
|
22
|
-
* Used to set whether the
|
|
22
|
+
* Used to set whether the container should grow to fill the available space.
|
|
23
23
|
*/
|
|
24
24
|
grow?: Grow;
|
|
25
25
|
/**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/primitives",
|
|
3
|
-
"version": "0.8.
|
|
3
|
+
"version": "0.8.1",
|
|
4
4
|
"description": "Primitives are token-backed low-level building blocks.",
|
|
5
5
|
"author": "Atlassian Pty Ltd",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -27,19 +27,28 @@
|
|
|
27
27
|
}
|
|
28
28
|
},
|
|
29
29
|
{
|
|
30
|
-
"title": "
|
|
31
|
-
"
|
|
32
|
-
"
|
|
33
|
-
"
|
|
30
|
+
"title": "Box",
|
|
31
|
+
"folder": "box",
|
|
32
|
+
"slug": "primitives/box",
|
|
33
|
+
"id": "@atlaskit/primitives/box",
|
|
34
34
|
"status": {
|
|
35
35
|
"type": "alpha"
|
|
36
36
|
}
|
|
37
37
|
},
|
|
38
38
|
{
|
|
39
|
-
"title": "
|
|
40
|
-
"folder": "
|
|
41
|
-
"slug": "primitives/
|
|
42
|
-
"id": "@atlaskit/primitives/
|
|
39
|
+
"title": "Inline",
|
|
40
|
+
"folder": "inline",
|
|
41
|
+
"slug": "primitives/inline",
|
|
42
|
+
"id": "@atlaskit/primitives/inline",
|
|
43
|
+
"status": {
|
|
44
|
+
"type": "alpha"
|
|
45
|
+
}
|
|
46
|
+
},
|
|
47
|
+
{
|
|
48
|
+
"title": "Stack",
|
|
49
|
+
"folder": "stack",
|
|
50
|
+
"slug": "primitives/stack",
|
|
51
|
+
"id": "@atlaskit/primitives/stack",
|
|
43
52
|
"status": {
|
|
44
53
|
"type": "alpha"
|
|
45
54
|
}
|
|
@@ -74,10 +83,20 @@
|
|
|
74
83
|
"react": "^16.8.0 || ^17.0.0 || ^18.0.0"
|
|
75
84
|
},
|
|
76
85
|
"devDependencies": {
|
|
86
|
+
"@atlaskit/avatar": "*",
|
|
87
|
+
"@atlaskit/badge": "*",
|
|
88
|
+
"@atlaskit/button": "*",
|
|
89
|
+
"@atlaskit/code": "*",
|
|
77
90
|
"@atlaskit/docs": "*",
|
|
91
|
+
"@atlaskit/dropdown-menu": "*",
|
|
78
92
|
"@atlaskit/ds-lib": "*",
|
|
79
93
|
"@atlaskit/heading": "*",
|
|
94
|
+
"@atlaskit/icon": "*",
|
|
95
|
+
"@atlaskit/icon-object": "*",
|
|
96
|
+
"@atlaskit/lozenge": "*",
|
|
80
97
|
"@atlaskit/ssr": "*",
|
|
98
|
+
"@atlaskit/tag": "*",
|
|
99
|
+
"@atlaskit/theme": "*",
|
|
81
100
|
"@atlaskit/visual-regression": "*",
|
|
82
101
|
"@atlaskit/webdriver-runner": "*",
|
|
83
102
|
"@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
|