@atlaskit/ds-explorations 2.0.4 → 2.0.5

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,11 @@
1
1
  # @atlaskit/ds-explorations
2
2
 
3
+ ## 2.0.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [`a70970a5aab`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a70970a5aab) - Mark Box, Inline, and Stack as deprecated, planned for future removal.
8
+
3
9
  ## 2.0.4
4
10
 
5
11
  ### 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
- * @internal
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,
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/ds-explorations",
3
- "version": "2.0.4",
3
+ "version": "2.0.5",
4
4
  "sideEffects": false
5
5
  }
@@ -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
- * @internal
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,
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/ds-explorations",
3
- "version": "2.0.4",
3
+ "version": "2.0.5",
4
4
  "sideEffects": false
5
5
  }
@@ -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
- * @internal
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,
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/ds-explorations",
3
- "version": "2.0.4",
3
+ "version": "2.0.5",
4
4
  "sideEffects": false
5
5
  }
@@ -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
- * @internal
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;
package/package.json CHANGED
@@ -1,10 +1,9 @@
1
1
  {
2
2
  "name": "@atlaskit/ds-explorations",
3
- "version": "2.0.4",
3
+ "version": "2.0.5",
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
- // @internal
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,12 @@ export type UNSAFE_BoxProps<T extends ElementType = 'div'> = Omit<
567
567
  BasePrimitiveProps &
568
568
  BoxPropsBase<T>;
569
569
 
570
- // @public
570
+ // @public @deprecated
571
571
  export const UNSAFE_Inline: MemoExoticComponent<
572
572
  ForwardRefExoticComponent<UNSAFE_InlineProps & RefAttributes<HTMLDivElement>>
573
573
  >;
574
574
 
575
- // @public (undocumented)
575
+ // @public @deprecated (undocumented)
576
576
  export interface UNSAFE_InlineProps extends BasePrimitiveProps {
577
577
  alignItems?: FlexAlignItems_2;
578
578
  children: ReactNode;
@@ -589,12 +589,12 @@ export const UNSAFE_InteractionSurface: ({
589
589
  testId,
590
590
  }: InteractionSurfaceProps) => jsx.JSX.Element;
591
591
 
592
- // @public
592
+ // @public @deprecated
593
593
  export const UNSAFE_Stack: MemoExoticComponent<
594
594
  ForwardRefExoticComponent<UNSAFE_StackProps & RefAttributes<HTMLDivElement>>
595
595
  >;
596
596
 
597
- // @public (undocumented)
597
+ // @public @deprecated (undocumented)
598
598
  export interface UNSAFE_StackProps extends BasePrimitiveProps {
599
599
  alignItems?: FlexAlignItems_3;
600
600
  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
- * @internal
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>(
@@ -540,16 +540,16 @@ const textTransformMap: {
540
540
  uppercase: SerializedStyles;
541
541
  };
542
542
 
543
- // @internal
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
549
+ // @public @deprecated
550
550
  export const UNSAFE_Inline: MemoExoticComponent<ForwardRefExoticComponent<UNSAFE_InlineProps & RefAttributes<HTMLDivElement>>>;
551
551
 
552
- // @public (undocumented)
552
+ // @public @deprecated (undocumented)
553
553
  export interface UNSAFE_InlineProps extends BasePrimitiveProps {
554
554
  alignItems?: FlexAlignItems_2;
555
555
  children: ReactNode;
@@ -562,10 +562,10 @@ export interface UNSAFE_InlineProps extends BasePrimitiveProps {
562
562
  // @public (undocumented)
563
563
  export const UNSAFE_InteractionSurface: ({ appearance, children, testId, }: InteractionSurfaceProps) => jsx.JSX.Element;
564
564
 
565
- // @public
565
+ // @public @deprecated
566
566
  export const UNSAFE_Stack: MemoExoticComponent<ForwardRefExoticComponent<UNSAFE_StackProps & RefAttributes<HTMLDivElement>>>;
567
567
 
568
- // @public (undocumented)
568
+ // @public @deprecated (undocumented)
569
569
  export interface UNSAFE_StackProps extends BasePrimitiveProps {
570
570
  alignItems?: FlexAlignItems_3;
571
571
  children: ReactNode;