@atlaskit/ds-explorations 2.0.4 → 2.0.6
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 +12 -0
- package/dist/cjs/components/box.partial.js +3 -1
- package/dist/cjs/components/inline.partial.js +4 -0
- package/dist/cjs/components/stack.partial.js +4 -0
- package/dist/cjs/constants.js +37 -2
- package/dist/cjs/index.js +14 -1
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/components/box.partial.js +3 -1
- package/dist/es2019/components/inline.partial.js +4 -0
- package/dist/es2019/components/stack.partial.js +4 -0
- package/dist/es2019/constants.js +33 -0
- package/dist/es2019/index.js +2 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/components/box.partial.js +3 -1
- package/dist/esm/components/inline.partial.js +4 -0
- package/dist/esm/components/stack.partial.js +4 -0
- package/dist/esm/constants.js +33 -0
- package/dist/esm/index.js +2 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/components/box.partial.d.ts +8 -1
- package/dist/types/components/inline.partial.d.ts +9 -0
- package/dist/types/components/stack.partial.d.ts +9 -0
- package/dist/types/constants.d.ts +7 -0
- package/dist/types/index.d.ts +2 -0
- package/package.json +1 -2
- package/report.api.md +31 -6
- package/src/components/box.partial.tsx +8 -1
- package/src/components/inline.partial.tsx +9 -0
- package/src/components/stack.partial.tsx +9 -0
- package/src/constants.tsx +41 -0
- package/src/index.tsx +8 -0
- package/tmp/api-report-tmp.d.ts +21 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/ds-explorations
|
|
2
2
|
|
|
3
|
+
## 2.0.6
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`4b219ed17bf`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4b219ed17bf) - Breakpoint constants added to be used in responsive spikes initially
|
|
8
|
+
|
|
9
|
+
## 2.0.5
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`a70970a5aab`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a70970a5aab) - Mark Box, Inline, and Stack as deprecated, planned for future removal.
|
|
14
|
+
|
|
3
15
|
## 2.0.4
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
|
@@ -18,7 +18,9 @@ var _excluded = ["children", "as", "className", "display", "flexDirection", "ali
|
|
|
18
18
|
* Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
|
|
19
19
|
* Renders a `div` by default.
|
|
20
20
|
*
|
|
21
|
-
* @
|
|
21
|
+
* @private
|
|
22
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
23
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
22
24
|
*/
|
|
23
25
|
var Box = /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
|
|
24
26
|
var children = _ref.children,
|
|
@@ -80,6 +80,10 @@ var Divider = function Divider(_ref) {
|
|
|
80
80
|
* Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
|
|
81
81
|
* Renders a `div` by default.
|
|
82
82
|
*
|
|
83
|
+
* @private
|
|
84
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
85
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
86
|
+
*
|
|
83
87
|
* @example
|
|
84
88
|
* ```tsx
|
|
85
89
|
* const App = () => (
|
|
@@ -62,6 +62,10 @@ var baseStyles = (0, _react2.css)({
|
|
|
62
62
|
* Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
|
|
63
63
|
* Renders a `div` by default.
|
|
64
64
|
*
|
|
65
|
+
* @private
|
|
66
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
67
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
68
|
+
*
|
|
65
69
|
*/
|
|
66
70
|
var Stack = /*#__PURE__*/(0, _react.memo)( /*#__PURE__*/(0, _react.forwardRef)(function (_ref, ref) {
|
|
67
71
|
var gap = _ref.gap,
|
package/dist/cjs/constants.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.LAYERS = void 0;
|
|
6
|
+
exports.LAYERS = exports.BREAKPOINTS_LIST = exports.BREAKPOINTS_CONFIG = void 0;
|
|
7
7
|
var LAYERS = {
|
|
8
8
|
card: 100,
|
|
9
9
|
navigation: 200,
|
|
@@ -15,4 +15,39 @@ var LAYERS = {
|
|
|
15
15
|
spotlight: 700,
|
|
16
16
|
tooltip: 800
|
|
17
17
|
};
|
|
18
|
-
exports.LAYERS = LAYERS;
|
|
18
|
+
exports.LAYERS = LAYERS;
|
|
19
|
+
var BREAKPOINTS_LIST = ['xs', 'sm', 'md', 'lg', 'xl', 'xxl'];
|
|
20
|
+
exports.BREAKPOINTS_LIST = BREAKPOINTS_LIST;
|
|
21
|
+
var BREAKPOINTS_CONFIG = {
|
|
22
|
+
// mobile
|
|
23
|
+
xs: {
|
|
24
|
+
min: 0,
|
|
25
|
+
max: 591
|
|
26
|
+
},
|
|
27
|
+
// tablet
|
|
28
|
+
sm: {
|
|
29
|
+
min: 592,
|
|
30
|
+
max: 1023
|
|
31
|
+
},
|
|
32
|
+
// laptop desktop
|
|
33
|
+
md: {
|
|
34
|
+
min: 1024,
|
|
35
|
+
max: 1439
|
|
36
|
+
},
|
|
37
|
+
// monitor
|
|
38
|
+
lg: {
|
|
39
|
+
min: 1440,
|
|
40
|
+
max: 1767
|
|
41
|
+
},
|
|
42
|
+
// large high res
|
|
43
|
+
xl: {
|
|
44
|
+
min: 1768,
|
|
45
|
+
max: 2159
|
|
46
|
+
},
|
|
47
|
+
// extra large high res
|
|
48
|
+
xxl: {
|
|
49
|
+
min: 2160,
|
|
50
|
+
max: Number.MAX_SAFE_INTEGER
|
|
51
|
+
}
|
|
52
|
+
};
|
|
53
|
+
exports.BREAKPOINTS_CONFIG = BREAKPOINTS_CONFIG;
|
package/dist/cjs/index.js
CHANGED
|
@@ -4,6 +4,18 @@ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefau
|
|
|
4
4
|
Object.defineProperty(exports, "__esModule", {
|
|
5
5
|
value: true
|
|
6
6
|
});
|
|
7
|
+
Object.defineProperty(exports, "UNSAFE_BREAKPOINTS_CONFIG", {
|
|
8
|
+
enumerable: true,
|
|
9
|
+
get: function get() {
|
|
10
|
+
return _constants.BREAKPOINTS_CONFIG;
|
|
11
|
+
}
|
|
12
|
+
});
|
|
13
|
+
Object.defineProperty(exports, "UNSAFE_BREAKPOINTS_LIST", {
|
|
14
|
+
enumerable: true,
|
|
15
|
+
get: function get() {
|
|
16
|
+
return _constants.BREAKPOINTS_LIST;
|
|
17
|
+
}
|
|
18
|
+
});
|
|
7
19
|
Object.defineProperty(exports, "UNSAFE_Box", {
|
|
8
20
|
enumerable: true,
|
|
9
21
|
get: function get() {
|
|
@@ -38,4 +50,5 @@ var _box = _interopRequireDefault(require("./components/box.partial"));
|
|
|
38
50
|
var _text = _interopRequireDefault(require("./components/text.partial"));
|
|
39
51
|
var _inline = _interopRequireDefault(require("./components/inline.partial"));
|
|
40
52
|
var _stack = _interopRequireDefault(require("./components/stack.partial"));
|
|
41
|
-
var _interactionSurface = _interopRequireDefault(require("./components/interaction-surface.partial"));
|
|
53
|
+
var _interactionSurface = _interopRequireDefault(require("./components/interaction-surface.partial"));
|
|
54
|
+
var _constants = require("./constants");
|
package/dist/cjs/version.json
CHANGED
|
@@ -10,7 +10,9 @@ import { SurfaceContext } from './surface-provider';
|
|
|
10
10
|
* Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
|
|
11
11
|
* Renders a `div` by default.
|
|
12
12
|
*
|
|
13
|
-
* @
|
|
13
|
+
* @private
|
|
14
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
15
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
14
16
|
*/
|
|
15
17
|
export const Box = /*#__PURE__*/forwardRef(({
|
|
16
18
|
children,
|
|
@@ -72,6 +72,10 @@ const Divider = ({
|
|
|
72
72
|
* Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
|
|
73
73
|
* Renders a `div` by default.
|
|
74
74
|
*
|
|
75
|
+
* @private
|
|
76
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
77
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
78
|
+
*
|
|
75
79
|
* @example
|
|
76
80
|
* ```tsx
|
|
77
81
|
* const App = () => (
|
|
@@ -55,6 +55,10 @@ const baseStyles = css({
|
|
|
55
55
|
* Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
|
|
56
56
|
* Renders a `div` by default.
|
|
57
57
|
*
|
|
58
|
+
* @private
|
|
59
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
60
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
61
|
+
*
|
|
58
62
|
*/
|
|
59
63
|
const Stack = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(({
|
|
60
64
|
gap,
|
package/dist/es2019/constants.js
CHANGED
|
@@ -8,4 +8,37 @@ export const LAYERS = {
|
|
|
8
8
|
flag: 600,
|
|
9
9
|
spotlight: 700,
|
|
10
10
|
tooltip: 800
|
|
11
|
+
};
|
|
12
|
+
export const BREAKPOINTS_LIST = ['xs', 'sm', 'md', 'lg', 'xl', 'xxl'];
|
|
13
|
+
export const BREAKPOINTS_CONFIG = {
|
|
14
|
+
// mobile
|
|
15
|
+
xs: {
|
|
16
|
+
min: 0,
|
|
17
|
+
max: 591
|
|
18
|
+
},
|
|
19
|
+
// tablet
|
|
20
|
+
sm: {
|
|
21
|
+
min: 592,
|
|
22
|
+
max: 1023
|
|
23
|
+
},
|
|
24
|
+
// laptop desktop
|
|
25
|
+
md: {
|
|
26
|
+
min: 1024,
|
|
27
|
+
max: 1439
|
|
28
|
+
},
|
|
29
|
+
// monitor
|
|
30
|
+
lg: {
|
|
31
|
+
min: 1440,
|
|
32
|
+
max: 1767
|
|
33
|
+
},
|
|
34
|
+
// large high res
|
|
35
|
+
xl: {
|
|
36
|
+
min: 1768,
|
|
37
|
+
max: 2159
|
|
38
|
+
},
|
|
39
|
+
// extra large high res
|
|
40
|
+
xxl: {
|
|
41
|
+
min: 2160,
|
|
42
|
+
max: Number.MAX_SAFE_INTEGER
|
|
43
|
+
}
|
|
11
44
|
};
|
package/dist/es2019/index.js
CHANGED
|
@@ -2,4 +2,5 @@ export { default as UNSAFE_Box } from './components/box.partial';
|
|
|
2
2
|
export { default as UNSAFE_Text } from './components/text.partial';
|
|
3
3
|
export { default as UNSAFE_Inline } from './components/inline.partial';
|
|
4
4
|
export { default as UNSAFE_Stack } from './components/stack.partial';
|
|
5
|
-
export { default as UNSAFE_InteractionSurface } from './components/interaction-surface.partial';
|
|
5
|
+
export { default as UNSAFE_InteractionSurface } from './components/interaction-surface.partial';
|
|
6
|
+
export { BREAKPOINTS_LIST as UNSAFE_BREAKPOINTS_LIST, BREAKPOINTS_CONFIG as UNSAFE_BREAKPOINTS_CONFIG } from './constants';
|
package/dist/es2019/version.json
CHANGED
|
@@ -12,7 +12,9 @@ import { SurfaceContext } from './surface-provider';
|
|
|
12
12
|
* Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
|
|
13
13
|
* Renders a `div` by default.
|
|
14
14
|
*
|
|
15
|
-
* @
|
|
15
|
+
* @private
|
|
16
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
17
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
16
18
|
*/
|
|
17
19
|
export var Box = /*#__PURE__*/forwardRef(function (_ref, ref) {
|
|
18
20
|
var children = _ref.children,
|
|
@@ -73,6 +73,10 @@ var Divider = function Divider(_ref) {
|
|
|
73
73
|
* Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
|
|
74
74
|
* Renders a `div` by default.
|
|
75
75
|
*
|
|
76
|
+
* @private
|
|
77
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
78
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
79
|
+
*
|
|
76
80
|
* @example
|
|
77
81
|
* ```tsx
|
|
78
82
|
* const App = () => (
|
|
@@ -55,6 +55,10 @@ var baseStyles = css({
|
|
|
55
55
|
* Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
|
|
56
56
|
* Renders a `div` by default.
|
|
57
57
|
*
|
|
58
|
+
* @private
|
|
59
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
60
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
61
|
+
*
|
|
58
62
|
*/
|
|
59
63
|
var Stack = /*#__PURE__*/memo( /*#__PURE__*/forwardRef(function (_ref, ref) {
|
|
60
64
|
var gap = _ref.gap,
|
package/dist/esm/constants.js
CHANGED
|
@@ -8,4 +8,37 @@ export var LAYERS = {
|
|
|
8
8
|
flag: 600,
|
|
9
9
|
spotlight: 700,
|
|
10
10
|
tooltip: 800
|
|
11
|
+
};
|
|
12
|
+
export var BREAKPOINTS_LIST = ['xs', 'sm', 'md', 'lg', 'xl', 'xxl'];
|
|
13
|
+
export var BREAKPOINTS_CONFIG = {
|
|
14
|
+
// mobile
|
|
15
|
+
xs: {
|
|
16
|
+
min: 0,
|
|
17
|
+
max: 591
|
|
18
|
+
},
|
|
19
|
+
// tablet
|
|
20
|
+
sm: {
|
|
21
|
+
min: 592,
|
|
22
|
+
max: 1023
|
|
23
|
+
},
|
|
24
|
+
// laptop desktop
|
|
25
|
+
md: {
|
|
26
|
+
min: 1024,
|
|
27
|
+
max: 1439
|
|
28
|
+
},
|
|
29
|
+
// monitor
|
|
30
|
+
lg: {
|
|
31
|
+
min: 1440,
|
|
32
|
+
max: 1767
|
|
33
|
+
},
|
|
34
|
+
// large high res
|
|
35
|
+
xl: {
|
|
36
|
+
min: 1768,
|
|
37
|
+
max: 2159
|
|
38
|
+
},
|
|
39
|
+
// extra large high res
|
|
40
|
+
xxl: {
|
|
41
|
+
min: 2160,
|
|
42
|
+
max: Number.MAX_SAFE_INTEGER
|
|
43
|
+
}
|
|
11
44
|
};
|
package/dist/esm/index.js
CHANGED
|
@@ -2,4 +2,5 @@ export { default as UNSAFE_Box } from './components/box.partial';
|
|
|
2
2
|
export { default as UNSAFE_Text } from './components/text.partial';
|
|
3
3
|
export { default as UNSAFE_Inline } from './components/inline.partial';
|
|
4
4
|
export { default as UNSAFE_Stack } from './components/stack.partial';
|
|
5
|
-
export { default as UNSAFE_InteractionSurface } from './components/interaction-surface.partial';
|
|
5
|
+
export { default as UNSAFE_InteractionSurface } from './components/interaction-surface.partial';
|
|
6
|
+
export { BREAKPOINTS_LIST as UNSAFE_BREAKPOINTS_LIST, BREAKPOINTS_CONFIG as UNSAFE_BREAKPOINTS_CONFIG } from './constants';
|
package/dist/esm/version.json
CHANGED
|
@@ -2,6 +2,11 @@
|
|
|
2
2
|
import { ComponentPropsWithoutRef, ComponentPropsWithRef, ElementType, FC, ReactElement, ReactNode } from 'react';
|
|
3
3
|
import { Layer } from '../constants';
|
|
4
4
|
import type { BasePrimitiveProps } from './types';
|
|
5
|
+
/**
|
|
6
|
+
* @private
|
|
7
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
8
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
9
|
+
*/
|
|
5
10
|
export declare type BoxProps<T extends ElementType = 'div'> = Omit<ComponentPropsWithoutRef<T>, 'as' | 'className' | 'style'> & BasePrimitiveProps & BoxPropsBase<T>;
|
|
6
11
|
declare type BoxPropsBase<T extends ElementType> = {
|
|
7
12
|
/**
|
|
@@ -113,7 +118,9 @@ declare type BoxComponent<T extends ElementType = 'div'> = (<T extends ElementTy
|
|
|
113
118
|
* Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
|
|
114
119
|
* Renders a `div` by default.
|
|
115
120
|
*
|
|
116
|
-
* @
|
|
121
|
+
* @private
|
|
122
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
123
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
117
124
|
*/
|
|
118
125
|
export declare const Box: BoxComponent;
|
|
119
126
|
export default Box;
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import { ReactNode } from 'react';
|
|
3
3
|
import type { BasePrimitiveProps } from './types';
|
|
4
|
+
/**
|
|
5
|
+
* @private
|
|
6
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
7
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
8
|
+
*/
|
|
4
9
|
export interface InlineProps extends BasePrimitiveProps {
|
|
5
10
|
/**
|
|
6
11
|
* Used to align children along the cross axis.
|
|
@@ -57,6 +62,10 @@ declare const flexWrapMap: {
|
|
|
57
62
|
* Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
|
|
58
63
|
* Renders a `div` by default.
|
|
59
64
|
*
|
|
65
|
+
* @private
|
|
66
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
67
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
68
|
+
*
|
|
60
69
|
* @example
|
|
61
70
|
* ```tsx
|
|
62
71
|
* const App = () => (
|
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import { ReactNode } from 'react';
|
|
3
3
|
import { BasePrimitiveProps } from './types';
|
|
4
|
+
/**
|
|
5
|
+
* @private
|
|
6
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
7
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
8
|
+
*/
|
|
4
9
|
export interface StackProps extends BasePrimitiveProps {
|
|
5
10
|
/**
|
|
6
11
|
* Used to align children along the cross axis.
|
|
@@ -50,6 +55,10 @@ declare const flexWrapMap: {
|
|
|
50
55
|
* Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
|
|
51
56
|
* Renders a `div` by default.
|
|
52
57
|
*
|
|
58
|
+
* @private
|
|
59
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
60
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
61
|
+
*
|
|
53
62
|
*/
|
|
54
63
|
declare const Stack: import("react").MemoExoticComponent<import("react").ForwardRefExoticComponent<StackProps & import("react").RefAttributes<HTMLDivElement>>>;
|
|
55
64
|
export default Stack;
|
|
@@ -10,3 +10,10 @@ export declare const LAYERS: {
|
|
|
10
10
|
readonly tooltip: 800;
|
|
11
11
|
};
|
|
12
12
|
export declare type Layer = keyof typeof LAYERS;
|
|
13
|
+
export declare const BREAKPOINTS_LIST: readonly ["xs", "sm", "md", "lg", "xl", "xxl"];
|
|
14
|
+
export declare type Breakpoint = typeof BREAKPOINTS_LIST[number];
|
|
15
|
+
export declare type BreakpointConfig = {
|
|
16
|
+
min: number;
|
|
17
|
+
max: number;
|
|
18
|
+
};
|
|
19
|
+
export declare const BREAKPOINTS_CONFIG: Record<Breakpoint, BreakpointConfig>;
|
package/dist/types/index.d.ts
CHANGED
|
@@ -7,3 +7,5 @@ export type { BoxProps as UNSAFE_BoxProps } from './components/box.partial';
|
|
|
7
7
|
export type { TextProps as UNSAFE_TextProps } from './components/text.partial';
|
|
8
8
|
export type { InlineProps as UNSAFE_InlineProps } from './components/inline.partial';
|
|
9
9
|
export type { StackProps as UNSAFE_StackProps } from './components/stack.partial';
|
|
10
|
+
export { BREAKPOINTS_LIST as UNSAFE_BREAKPOINTS_LIST, BREAKPOINTS_CONFIG as UNSAFE_BREAKPOINTS_CONFIG, } from './constants';
|
|
11
|
+
export type { Breakpoint as UNSAFE_Breakpoint, BreakpointConfig as UNSAFE_BreakpointConfig, } from './constants';
|
package/package.json
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/ds-explorations",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.6",
|
|
4
4
|
"description": "An experimental package for exploration and validation of spacing / typography foundations.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"atlassian": {
|
|
7
|
-
"disableProductCI": true,
|
|
8
7
|
"team": "Design System Team",
|
|
9
8
|
"inPublicMirror": false,
|
|
10
9
|
"releaseModel": "continuous"
|
package/report.api.md
CHANGED
|
@@ -556,10 +556,10 @@ const textTransformMap: {
|
|
|
556
556
|
uppercase: SerializedStyles;
|
|
557
557
|
};
|
|
558
558
|
|
|
559
|
-
// @
|
|
559
|
+
// @public @deprecated
|
|
560
560
|
export const UNSAFE_Box: BoxComponent;
|
|
561
561
|
|
|
562
|
-
// @public (undocumented)
|
|
562
|
+
// @public @deprecated (undocumented)
|
|
563
563
|
export type UNSAFE_BoxProps<T extends ElementType = 'div'> = Omit<
|
|
564
564
|
ComponentPropsWithoutRef<T>,
|
|
565
565
|
'as' | 'className' | 'style'
|
|
@@ -567,12 +567,37 @@ export type UNSAFE_BoxProps<T extends ElementType = 'div'> = Omit<
|
|
|
567
567
|
BasePrimitiveProps &
|
|
568
568
|
BoxPropsBase<T>;
|
|
569
569
|
|
|
570
|
-
// @public
|
|
570
|
+
// @public (undocumented)
|
|
571
|
+
export type UNSAFE_Breakpoint = typeof UNSAFE_BREAKPOINTS_LIST[number];
|
|
572
|
+
|
|
573
|
+
// @public (undocumented)
|
|
574
|
+
export type UNSAFE_BreakpointConfig = {
|
|
575
|
+
min: number;
|
|
576
|
+
max: number;
|
|
577
|
+
};
|
|
578
|
+
|
|
579
|
+
// @public (undocumented)
|
|
580
|
+
export const UNSAFE_BREAKPOINTS_CONFIG: Record<
|
|
581
|
+
UNSAFE_Breakpoint,
|
|
582
|
+
UNSAFE_BreakpointConfig
|
|
583
|
+
>;
|
|
584
|
+
|
|
585
|
+
// @public (undocumented)
|
|
586
|
+
export const UNSAFE_BREAKPOINTS_LIST: readonly [
|
|
587
|
+
'xs',
|
|
588
|
+
'sm',
|
|
589
|
+
'md',
|
|
590
|
+
'lg',
|
|
591
|
+
'xl',
|
|
592
|
+
'xxl',
|
|
593
|
+
];
|
|
594
|
+
|
|
595
|
+
// @public @deprecated
|
|
571
596
|
export const UNSAFE_Inline: MemoExoticComponent<
|
|
572
597
|
ForwardRefExoticComponent<UNSAFE_InlineProps & RefAttributes<HTMLDivElement>>
|
|
573
598
|
>;
|
|
574
599
|
|
|
575
|
-
// @public (undocumented)
|
|
600
|
+
// @public @deprecated (undocumented)
|
|
576
601
|
export interface UNSAFE_InlineProps extends BasePrimitiveProps {
|
|
577
602
|
alignItems?: FlexAlignItems_2;
|
|
578
603
|
children: ReactNode;
|
|
@@ -589,12 +614,12 @@ export const UNSAFE_InteractionSurface: ({
|
|
|
589
614
|
testId,
|
|
590
615
|
}: InteractionSurfaceProps) => jsx.JSX.Element;
|
|
591
616
|
|
|
592
|
-
// @public
|
|
617
|
+
// @public @deprecated
|
|
593
618
|
export const UNSAFE_Stack: MemoExoticComponent<
|
|
594
619
|
ForwardRefExoticComponent<UNSAFE_StackProps & RefAttributes<HTMLDivElement>>
|
|
595
620
|
>;
|
|
596
621
|
|
|
597
|
-
// @public (undocumented)
|
|
622
|
+
// @public @deprecated (undocumented)
|
|
598
623
|
export interface UNSAFE_StackProps extends BasePrimitiveProps {
|
|
599
624
|
alignItems?: FlexAlignItems_3;
|
|
600
625
|
children: ReactNode;
|
|
@@ -18,6 +18,11 @@ import { Layer, LAYERS } from '../constants';
|
|
|
18
18
|
import { SurfaceContext } from './surface-provider';
|
|
19
19
|
import type { BasePrimitiveProps } from './types';
|
|
20
20
|
|
|
21
|
+
/**
|
|
22
|
+
* @private
|
|
23
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
24
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
25
|
+
*/
|
|
21
26
|
export type BoxProps<T extends ElementType = 'div'> = Omit<
|
|
22
27
|
ComponentPropsWithoutRef<T>,
|
|
23
28
|
'as' | 'className' | 'style'
|
|
@@ -143,7 +148,9 @@ type BoxComponent<T extends ElementType = 'div'> = (<
|
|
|
143
148
|
* Box is a primitive component that has the design decisions of the Atlassian Design System baked in.
|
|
144
149
|
* Renders a `div` by default.
|
|
145
150
|
*
|
|
146
|
-
* @
|
|
151
|
+
* @private
|
|
152
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
153
|
+
* Please use `Box` from `@atlaskit/primitives` instead.
|
|
147
154
|
*/
|
|
148
155
|
export const Box: BoxComponent = forwardRef(
|
|
149
156
|
<T extends ElementType = 'div'>(
|
|
@@ -7,6 +7,11 @@ import { token } from '@atlaskit/tokens';
|
|
|
7
7
|
|
|
8
8
|
import type { BasePrimitiveProps } from './types';
|
|
9
9
|
|
|
10
|
+
/**
|
|
11
|
+
* @private
|
|
12
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
13
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
14
|
+
*/
|
|
10
15
|
export interface InlineProps extends BasePrimitiveProps {
|
|
11
16
|
/**
|
|
12
17
|
* Used to align children along the cross axis.
|
|
@@ -84,6 +89,10 @@ const Divider: FC = ({ children }) => (
|
|
|
84
89
|
* Inline is a primitive component based on flexbox that manages the horizontal layout of direct children.
|
|
85
90
|
* Renders a `div` by default.
|
|
86
91
|
*
|
|
92
|
+
* @private
|
|
93
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
94
|
+
* Please use `Inline` from `@atlaskit/primitives` instead.
|
|
95
|
+
*
|
|
87
96
|
* @example
|
|
88
97
|
* ```tsx
|
|
89
98
|
* const App = () => (
|
|
@@ -7,6 +7,11 @@ import { token } from '@atlaskit/tokens';
|
|
|
7
7
|
|
|
8
8
|
import { BasePrimitiveProps } from './types';
|
|
9
9
|
|
|
10
|
+
/**
|
|
11
|
+
* @private
|
|
12
|
+
* @deprecated DSP-8009: This type is scheduled for deletion.
|
|
13
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
14
|
+
*/
|
|
10
15
|
export interface StackProps extends BasePrimitiveProps {
|
|
11
16
|
/**
|
|
12
17
|
* Used to align children along the cross axis.
|
|
@@ -66,6 +71,10 @@ const baseStyles = css({
|
|
|
66
71
|
* Stack is a primitive component based on flexbox that manages the vertical layout of direct children.
|
|
67
72
|
* Renders a `div` by default.
|
|
68
73
|
*
|
|
74
|
+
* @private
|
|
75
|
+
* @deprecated DSP-8009: This primitive is scheduled for deletion.
|
|
76
|
+
* Please use `Stack` from `@atlaskit/primitives` instead.
|
|
77
|
+
*
|
|
69
78
|
*/
|
|
70
79
|
const Stack = memo(
|
|
71
80
|
forwardRef<HTMLDivElement, StackProps>(
|
package/src/constants.tsx
CHANGED
|
@@ -11,3 +11,44 @@ export const LAYERS = {
|
|
|
11
11
|
} as const;
|
|
12
12
|
|
|
13
13
|
export type Layer = keyof typeof LAYERS;
|
|
14
|
+
|
|
15
|
+
export const BREAKPOINTS_LIST = ['xs', 'sm', 'md', 'lg', 'xl', 'xxl'] as const;
|
|
16
|
+
export type Breakpoint = typeof BREAKPOINTS_LIST[number];
|
|
17
|
+
|
|
18
|
+
export type BreakpointConfig = {
|
|
19
|
+
min: number;
|
|
20
|
+
max: number;
|
|
21
|
+
};
|
|
22
|
+
|
|
23
|
+
export const BREAKPOINTS_CONFIG: Record<Breakpoint, BreakpointConfig> = {
|
|
24
|
+
// mobile
|
|
25
|
+
xs: {
|
|
26
|
+
min: 0,
|
|
27
|
+
max: 591,
|
|
28
|
+
},
|
|
29
|
+
// tablet
|
|
30
|
+
sm: {
|
|
31
|
+
min: 592,
|
|
32
|
+
max: 1023,
|
|
33
|
+
},
|
|
34
|
+
// laptop desktop
|
|
35
|
+
md: {
|
|
36
|
+
min: 1024,
|
|
37
|
+
max: 1439,
|
|
38
|
+
},
|
|
39
|
+
// monitor
|
|
40
|
+
lg: {
|
|
41
|
+
min: 1440,
|
|
42
|
+
max: 1767,
|
|
43
|
+
},
|
|
44
|
+
// large high res
|
|
45
|
+
xl: {
|
|
46
|
+
min: 1768,
|
|
47
|
+
max: 2159,
|
|
48
|
+
},
|
|
49
|
+
// extra large high res
|
|
50
|
+
xxl: {
|
|
51
|
+
min: 2160,
|
|
52
|
+
max: Number.MAX_SAFE_INTEGER,
|
|
53
|
+
},
|
|
54
|
+
} as const;
|
package/src/index.tsx
CHANGED
|
@@ -7,3 +7,11 @@ export type { BoxProps as UNSAFE_BoxProps } from './components/box.partial';
|
|
|
7
7
|
export type { TextProps as UNSAFE_TextProps } from './components/text.partial';
|
|
8
8
|
export type { InlineProps as UNSAFE_InlineProps } from './components/inline.partial';
|
|
9
9
|
export type { StackProps as UNSAFE_StackProps } from './components/stack.partial';
|
|
10
|
+
export {
|
|
11
|
+
BREAKPOINTS_LIST as UNSAFE_BREAKPOINTS_LIST,
|
|
12
|
+
BREAKPOINTS_CONFIG as UNSAFE_BREAKPOINTS_CONFIG,
|
|
13
|
+
} from './constants';
|
|
14
|
+
export type {
|
|
15
|
+
Breakpoint as UNSAFE_Breakpoint,
|
|
16
|
+
BreakpointConfig as UNSAFE_BreakpointConfig,
|
|
17
|
+
} from './constants';
|
package/tmp/api-report-tmp.d.ts
CHANGED
|
@@ -540,16 +540,31 @@ const textTransformMap: {
|
|
|
540
540
|
uppercase: SerializedStyles;
|
|
541
541
|
};
|
|
542
542
|
|
|
543
|
-
// @
|
|
543
|
+
// @public @deprecated
|
|
544
544
|
export const UNSAFE_Box: BoxComponent;
|
|
545
545
|
|
|
546
|
-
// @public (undocumented)
|
|
546
|
+
// @public @deprecated (undocumented)
|
|
547
547
|
export type UNSAFE_BoxProps<T extends ElementType = 'div'> = Omit<ComponentPropsWithoutRef<T>, 'as' | 'className' | 'style'> & BasePrimitiveProps & BoxPropsBase<T>;
|
|
548
548
|
|
|
549
|
-
// @public
|
|
550
|
-
export
|
|
549
|
+
// @public (undocumented)
|
|
550
|
+
export type UNSAFE_Breakpoint = typeof UNSAFE_BREAKPOINTS_LIST[number];
|
|
551
|
+
|
|
552
|
+
// @public (undocumented)
|
|
553
|
+
export type UNSAFE_BreakpointConfig = {
|
|
554
|
+
min: number;
|
|
555
|
+
max: number;
|
|
556
|
+
};
|
|
551
557
|
|
|
552
558
|
// @public (undocumented)
|
|
559
|
+
export const UNSAFE_BREAKPOINTS_CONFIG: Record<UNSAFE_Breakpoint, UNSAFE_BreakpointConfig>;
|
|
560
|
+
|
|
561
|
+
// @public (undocumented)
|
|
562
|
+
export const UNSAFE_BREAKPOINTS_LIST: readonly ["xs", "sm", "md", "lg", "xl", "xxl"];
|
|
563
|
+
|
|
564
|
+
// @public @deprecated
|
|
565
|
+
export const UNSAFE_Inline: MemoExoticComponent<ForwardRefExoticComponent<UNSAFE_InlineProps & RefAttributes<HTMLDivElement>>>;
|
|
566
|
+
|
|
567
|
+
// @public @deprecated (undocumented)
|
|
553
568
|
export interface UNSAFE_InlineProps extends BasePrimitiveProps {
|
|
554
569
|
alignItems?: FlexAlignItems_2;
|
|
555
570
|
children: ReactNode;
|
|
@@ -562,10 +577,10 @@ export interface UNSAFE_InlineProps extends BasePrimitiveProps {
|
|
|
562
577
|
// @public (undocumented)
|
|
563
578
|
export const UNSAFE_InteractionSurface: ({ appearance, children, testId, }: InteractionSurfaceProps) => jsx.JSX.Element;
|
|
564
579
|
|
|
565
|
-
// @public
|
|
580
|
+
// @public @deprecated
|
|
566
581
|
export const UNSAFE_Stack: MemoExoticComponent<ForwardRefExoticComponent<UNSAFE_StackProps & RefAttributes<HTMLDivElement>>>;
|
|
567
582
|
|
|
568
|
-
// @public (undocumented)
|
|
583
|
+
// @public @deprecated (undocumented)
|
|
569
584
|
export interface UNSAFE_StackProps extends BasePrimitiveProps {
|
|
570
585
|
alignItems?: FlexAlignItems_3;
|
|
571
586
|
children: ReactNode;
|