@atlaskit/onboarding 14.4.8 → 14.4.9

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 (60) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/cjs/components/index.js +7 -0
  3. package/dist/cjs/components/modal-transition.js +24 -0
  4. package/dist/cjs/components/modal.js +2 -0
  5. package/dist/cjs/components/spotlight-card.js +2 -0
  6. package/dist/cjs/components/spotlight-manager.js +2 -0
  7. package/dist/cjs/components/spotlight-target.js +2 -0
  8. package/dist/cjs/components/spotlight-transition.js +2 -0
  9. package/dist/cjs/components/spotlight.js +2 -0
  10. package/dist/cjs/components/use-spotlight.js +2 -0
  11. package/dist/cjs/index.js +1 -3
  12. package/dist/cjs/styled/target.js +2 -0
  13. package/dist/cjs/utils/use-element-box.js +1 -0
  14. package/dist/es2019/components/index.js +2 -1
  15. package/dist/es2019/components/modal-transition.js +18 -0
  16. package/dist/es2019/components/modal.js +2 -0
  17. package/dist/es2019/components/spotlight-card.js +2 -0
  18. package/dist/es2019/components/spotlight-manager.js +2 -0
  19. package/dist/es2019/components/spotlight-target.js +2 -0
  20. package/dist/es2019/components/spotlight-transition.js +2 -0
  21. package/dist/es2019/components/spotlight.js +2 -0
  22. package/dist/es2019/components/use-spotlight.js +2 -0
  23. package/dist/es2019/index.js +1 -13
  24. package/dist/es2019/styled/target.js +2 -0
  25. package/dist/es2019/utils/use-element-box.js +1 -0
  26. package/dist/esm/components/index.js +2 -1
  27. package/dist/esm/components/modal-transition.js +18 -0
  28. package/dist/esm/components/modal.js +2 -0
  29. package/dist/esm/components/spotlight-card.js +2 -0
  30. package/dist/esm/components/spotlight-manager.js +2 -0
  31. package/dist/esm/components/spotlight-target.js +2 -0
  32. package/dist/esm/components/spotlight-transition.js +2 -0
  33. package/dist/esm/components/spotlight.js +2 -0
  34. package/dist/esm/components/use-spotlight.js +2 -0
  35. package/dist/esm/index.js +1 -13
  36. package/dist/esm/styled/target.js +2 -0
  37. package/dist/esm/utils/use-element-box.js +1 -0
  38. package/dist/types/components/index.d.ts +2 -1
  39. package/dist/types/components/modal-transition.d.ts +17 -0
  40. package/dist/types/components/modal.d.ts +2 -0
  41. package/dist/types/components/spotlight-card.d.ts +2 -0
  42. package/dist/types/components/spotlight-manager.d.ts +2 -0
  43. package/dist/types/components/spotlight-target.d.ts +2 -0
  44. package/dist/types/components/spotlight-transition.d.ts +2 -0
  45. package/dist/types/components/spotlight.d.ts +2 -0
  46. package/dist/types/components/use-spotlight.d.ts +2 -0
  47. package/dist/types/index.d.ts +1 -13
  48. package/dist/types/styled/target.d.ts +2 -0
  49. package/dist/types-ts4.5/components/index.d.ts +2 -1
  50. package/dist/types-ts4.5/components/modal-transition.d.ts +17 -0
  51. package/dist/types-ts4.5/components/modal.d.ts +2 -0
  52. package/dist/types-ts4.5/components/spotlight-card.d.ts +2 -0
  53. package/dist/types-ts4.5/components/spotlight-manager.d.ts +2 -0
  54. package/dist/types-ts4.5/components/spotlight-target.d.ts +2 -0
  55. package/dist/types-ts4.5/components/spotlight-transition.d.ts +2 -0
  56. package/dist/types-ts4.5/components/spotlight.d.ts +2 -0
  57. package/dist/types-ts4.5/components/use-spotlight.d.ts +2 -0
  58. package/dist/types-ts4.5/index.d.ts +1 -13
  59. package/dist/types-ts4.5/styled/target.d.ts +2 -0
  60. package/package.json +5 -5
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @atlaskit/onboarding
2
2
 
3
+ ## 14.4.9
4
+
5
+ ### Patch Changes
6
+
7
+ - [`6616518b12a0b`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/6616518b12a0b) -
8
+ Mark all @atlaskit/onboarding exports as deprecated. Please use @atlaskit/spotlight instead.
9
+ - Updated dependencies
10
+
3
11
  ## 14.4.8
4
12
 
5
13
  ### Patch Changes
@@ -10,6 +10,12 @@ Object.defineProperty(exports, "Modal", {
10
10
  return _modal.default;
11
11
  }
12
12
  });
13
+ Object.defineProperty(exports, "ModalTransition", {
14
+ enumerable: true,
15
+ get: function get() {
16
+ return _modalTransition.default;
17
+ }
18
+ });
13
19
  Object.defineProperty(exports, "Spotlight", {
14
20
  enumerable: true,
15
21
  get: function get() {
@@ -59,6 +65,7 @@ Object.defineProperty(exports, "useSpotlight", {
59
65
  }
60
66
  });
61
67
  var _modal = _interopRequireDefault(require("./modal"));
68
+ var _modalTransition = _interopRequireDefault(require("./modal-transition"));
62
69
  var _spotlight = _interopRequireDefault(require("./spotlight"));
63
70
  var _spotlightCard = _interopRequireDefault(require("./spotlight-card"));
64
71
  var _spotlightManager = _interopRequireDefault(require("./spotlight-manager"));
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+
3
+ var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
+ Object.defineProperty(exports, "__esModule", {
5
+ value: true
6
+ });
7
+ exports.default = void 0;
8
+ var _modalTransition = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-transition"));
9
+ /**
10
+ * We re-export this because products may have multiple versions of
11
+ * `@atlaskit/modal-dialog`.
12
+ *
13
+ * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
14
+ * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
15
+ * stuck in an open state.
16
+ *
17
+ * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
18
+ * and a reproduction.
19
+ *
20
+ */
21
+ /**
22
+ * @deprecated Use `@atlaskit/spotlight` instead.
23
+ */
24
+ var _default = exports.default = _modalTransition.default;
@@ -33,6 +33,8 @@ function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.
33
33
  * - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
34
34
  * - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
35
35
  * - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
36
+ *
37
+ * @deprecated Use `@atlaskit/modal-dialog` instead.
36
38
  */
37
39
  // eslint-disable-next-line @repo/internal/react/no-class-components
38
40
  var BenefitsModal = exports.default = /*#__PURE__*/function (_Component) {
@@ -53,6 +53,8 @@ var containerShadowStyles = {
53
53
  * - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
54
54
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
55
55
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
56
+ *
57
+ * @deprecated Use `@atlaskit/spotlight` instead.
56
58
  */
57
59
  var SpotlightCard = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
58
60
  var _props$actions = props.actions,
@@ -48,6 +48,8 @@ var Container = function Container(_ref) {
48
48
  * - [Examples](https://atlassian.design/components/onboarding/examples)
49
49
  * - [Code](https://atlassian.design/components/onboarding/code)
50
50
  * - [Usage](https://atlassian.design/components/onboarding/usage)
51
+ *
52
+ * @deprecated Use `@atlaskit/spotlight` instead.
51
53
  */
52
54
  // eslint-disable-next-line @repo/internal/react/no-class-components
53
55
  var SpotlightManager = exports.default = /*#__PURE__*/function (_PureComponent) {
@@ -17,6 +17,8 @@ var _spotlightManager = require("./spotlight-manager");
17
17
  * - [Examples](https://atlassian.design/components/onboarding/examples)
18
18
  * - [Code](https://atlassian.design/components/onboarding/code)
19
19
  * - [Usage](https://atlassian.design/components/onboarding/usage)
20
+ *
21
+ * @deprecated Use `@atlaskit/spotlight` instead.
20
22
  */
21
23
  var SpotlightTarget = function SpotlightTarget(_ref) {
22
24
  var children = _ref.children,
@@ -38,6 +38,8 @@ var hasChildren = function hasChildren(children) {
38
38
  * - [Examples](https://atlassian.design/components/onboarding/examples)
39
39
  * - [Code](https://atlassian.design/components/onboarding/code)
40
40
  * - [Usage](https://atlassian.design/components/onboarding/usage)
41
+ *
42
+ * @deprecated Use `@atlaskit/spotlight` instead.
41
43
  */
42
44
  var SpotlightTransition = /*#__PURE__*/function (_React$Component) {
43
45
  function SpotlightTransition() {
@@ -19,6 +19,8 @@ var _excluded = ["actions", "actionsBeforeElement", "children", "dialogPlacement
19
19
  * - [Examples](https://atlassian.design/components/onboarding/examples)
20
20
  * - [Code](https://atlassian.design/components/onboarding/code)
21
21
  * - [Usage](https://atlassian.design/components/onboarding/usage)
22
+ *
23
+ * @deprecated Use `@atlaskit/spotlight` instead.
22
24
  */
23
25
  var Spotlight = function Spotlight(_ref) {
24
26
  var actions = _ref.actions,
@@ -8,6 +8,8 @@ var _react = require("react");
8
8
  var _spotlightManager = require("./spotlight-manager");
9
9
  /**
10
10
  * Use spotlight hook returns information about available spotlight targets.
11
+ *
12
+ * @deprecated Use `@atlaskit/spotlight` instead.
11
13
  */
12
14
  function useSpotlight() {
13
15
  var _useContext = (0, _react.useContext)(_spotlightManager.SpotlightContext),
package/dist/cjs/index.js CHANGED
@@ -1,6 +1,5 @@
1
1
  "use strict";
2
2
 
3
- var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
4
3
  Object.defineProperty(exports, "__esModule", {
5
4
  value: true
6
5
  });
@@ -13,7 +12,7 @@ Object.defineProperty(exports, "Modal", {
13
12
  Object.defineProperty(exports, "ModalTransition", {
14
13
  enumerable: true,
15
14
  get: function get() {
16
- return _modalTransition.default;
15
+ return _components.ModalTransition;
17
16
  }
18
17
  });
19
18
  Object.defineProperty(exports, "Spotlight", {
@@ -70,6 +69,5 @@ Object.defineProperty(exports, "useSpotlight", {
70
69
  return _components.useSpotlight;
71
70
  }
72
71
  });
73
- var _modalTransition = _interopRequireDefault(require("@atlaskit/modal-dialog/modal-transition"));
74
72
  var _components = require("./components");
75
73
  var _target = require("./styled/target");
@@ -109,6 +109,8 @@ var TargetOverlay = exports.TargetOverlay = function TargetOverlay(_ref3) {
109
109
  * - [Examples](https://atlassian.design/components/onboarding/examples)
110
110
  * - [Code](https://atlassian.design/components/onboarding/code)
111
111
  * - [Usage](https://atlassian.design/components/onboarding/usage)
112
+ *
113
+ * @deprecated Use `@atlaskit/spotlight` instead.
112
114
  */
113
115
  var Pulse = exports.Pulse = function Pulse(_ref4) {
114
116
  var bgColor = _ref4.bgColor,
@@ -59,6 +59,7 @@ var useResizeAwareElementBox = function useResizeAwareElementBox(element, update
59
59
  listener: onResize
60
60
  });
61
61
  }
62
+ return function () {};
62
63
  }, [element, updateMethod]);
63
64
  return box;
64
65
  };
@@ -1,4 +1,5 @@
1
1
  import Modal from './modal';
2
+ import ModalTransition from './modal-transition';
2
3
  import Spotlight from './spotlight';
3
4
  import SpotlightCard from './spotlight-card';
4
5
  import SpotlightManager from './spotlight-manager';
@@ -6,4 +7,4 @@ import SpotlightTarget from './spotlight-target';
6
7
  import SpotlightTransition from './spotlight-transition';
7
8
  import useSpotlight from './use-spotlight';
8
9
  export { spotlightButtonTheme, modalButtonTheme } from './theme';
9
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight };
10
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, ModalTransition };
@@ -0,0 +1,18 @@
1
+ /**
2
+ * We re-export this because products may have multiple versions of
3
+ * `@atlaskit/modal-dialog`.
4
+ *
5
+ * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
+ * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
+ * stuck in an open state.
8
+ *
9
+ * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
+ * and a reproduction.
11
+ *
12
+ */
13
+ import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
14
+
15
+ /**
16
+ * @deprecated Use `@atlaskit/spotlight` instead.
17
+ */
18
+ export default ModalTransition;
@@ -16,6 +16,8 @@ import { modalButtonTheme } from './theme';
16
16
  * - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
17
17
  * - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
18
18
  * - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
19
+ *
20
+ * @deprecated Use `@atlaskit/modal-dialog` instead.
19
21
  */
20
22
  // eslint-disable-next-line @repo/internal/react/no-class-components
21
23
  export default class BenefitsModal extends Component {
@@ -40,6 +40,8 @@ const containerShadowStyles = {
40
40
  * - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
41
41
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
42
42
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
43
+ *
44
+ * @deprecated Use `@atlaskit/spotlight` instead.
43
45
  */
44
46
  const SpotlightCard = /*#__PURE__*/forwardRef((props, ref) => {
45
47
  const {
@@ -34,6 +34,8 @@ const Container = ({
34
34
  * - [Examples](https://atlassian.design/components/onboarding/examples)
35
35
  * - [Code](https://atlassian.design/components/onboarding/code)
36
36
  * - [Usage](https://atlassian.design/components/onboarding/usage)
37
+ *
38
+ * @deprecated Use `@atlaskit/spotlight` instead.
37
39
  */
38
40
  // eslint-disable-next-line @repo/internal/react/no-class-components
39
41
  export default class SpotlightManager extends PureComponent {
@@ -10,6 +10,8 @@ import { TargetConsumer } from './spotlight-manager';
10
10
  * - [Examples](https://atlassian.design/components/onboarding/examples)
11
11
  * - [Code](https://atlassian.design/components/onboarding/code)
12
12
  * - [Usage](https://atlassian.design/components/onboarding/usage)
13
+ *
14
+ * @deprecated Use `@atlaskit/spotlight` instead.
13
15
  */
14
16
  const SpotlightTarget = ({
15
17
  children,
@@ -20,6 +20,8 @@ const hasChildren = children => {
20
20
  * - [Examples](https://atlassian.design/components/onboarding/examples)
21
21
  * - [Code](https://atlassian.design/components/onboarding/code)
22
22
  * - [Usage](https://atlassian.design/components/onboarding/usage)
23
+ *
24
+ * @deprecated Use `@atlaskit/spotlight` instead.
23
25
  */
24
26
  class SpotlightTransition extends React.Component {
25
27
  constructor(...args) {
@@ -11,6 +11,8 @@ import { SpotlightConsumer } from './spotlight-manager';
11
11
  * - [Examples](https://atlassian.design/components/onboarding/examples)
12
12
  * - [Code](https://atlassian.design/components/onboarding/code)
13
13
  * - [Usage](https://atlassian.design/components/onboarding/usage)
14
+ *
15
+ * @deprecated Use `@atlaskit/spotlight` instead.
14
16
  */
15
17
  const Spotlight = ({
16
18
  actions,
@@ -3,6 +3,8 @@ import { SpotlightContext } from './spotlight-manager';
3
3
 
4
4
  /**
5
5
  * Use spotlight hook returns information about available spotlight targets.
6
+ *
7
+ * @deprecated Use `@atlaskit/spotlight` instead.
6
8
  */
7
9
  export default function useSpotlight() {
8
10
  const {
@@ -1,14 +1,2 @@
1
- /**
2
- * We re-export this because products may have multiple versions of
3
- * `@atlaskit/modal-dialog`.
4
- *
5
- * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
- * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
- * stuck in an open state.
8
- *
9
- * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
- * and a reproduction.
11
- */
12
- export { default as ModalTransition } from '@atlaskit/modal-dialog/modal-transition';
13
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight } from './components';
1
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, ModalTransition } from './components';
14
2
  export { Pulse as SpotlightPulse } from './styled/target';
@@ -91,6 +91,8 @@ export const TargetOverlay = ({
91
91
  * - [Examples](https://atlassian.design/components/onboarding/examples)
92
92
  * - [Code](https://atlassian.design/components/onboarding/code)
93
93
  * - [Usage](https://atlassian.design/components/onboarding/usage)
94
+ *
95
+ * @deprecated Use `@atlaskit/spotlight` instead.
94
96
  */
95
97
  export const Pulse = ({
96
98
  bgColor,
@@ -49,6 +49,7 @@ const useResizeAwareElementBox = (element, updateMethod) => {
49
49
  listener: onResize
50
50
  });
51
51
  }
52
+ return () => {};
52
53
  }, [element, updateMethod]);
53
54
  return box;
54
55
  };
@@ -1,4 +1,5 @@
1
1
  import Modal from './modal';
2
+ import ModalTransition from './modal-transition';
2
3
  import Spotlight from './spotlight';
3
4
  import SpotlightCard from './spotlight-card';
4
5
  import SpotlightManager from './spotlight-manager';
@@ -6,4 +7,4 @@ import SpotlightTarget from './spotlight-target';
6
7
  import SpotlightTransition from './spotlight-transition';
7
8
  import useSpotlight from './use-spotlight';
8
9
  export { spotlightButtonTheme, modalButtonTheme } from './theme';
9
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight };
10
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, ModalTransition };
@@ -0,0 +1,18 @@
1
+ /**
2
+ * We re-export this because products may have multiple versions of
3
+ * `@atlaskit/modal-dialog`.
4
+ *
5
+ * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
+ * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
+ * stuck in an open state.
8
+ *
9
+ * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
+ * and a reproduction.
11
+ *
12
+ */
13
+ import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
14
+
15
+ /**
16
+ * @deprecated Use `@atlaskit/spotlight` instead.
17
+ */
18
+ export default ModalTransition;
@@ -25,6 +25,8 @@ import { modalButtonTheme } from './theme';
25
25
  * - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
26
26
  * - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
27
27
  * - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
28
+ *
29
+ * @deprecated Use `@atlaskit/modal-dialog` instead.
28
30
  */
29
31
  // eslint-disable-next-line @repo/internal/react/no-class-components
30
32
  var BenefitsModal = /*#__PURE__*/function (_Component) {
@@ -44,6 +44,8 @@ var containerShadowStyles = {
44
44
  * - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
45
45
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
46
46
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
47
+ *
48
+ * @deprecated Use `@atlaskit/spotlight` instead.
47
49
  */
48
50
  var SpotlightCard = /*#__PURE__*/forwardRef(function (props, ref) {
49
51
  var _props$actions = props.actions,
@@ -41,6 +41,8 @@ var Container = function Container(_ref) {
41
41
  * - [Examples](https://atlassian.design/components/onboarding/examples)
42
42
  * - [Code](https://atlassian.design/components/onboarding/code)
43
43
  * - [Usage](https://atlassian.design/components/onboarding/usage)
44
+ *
45
+ * @deprecated Use `@atlaskit/spotlight` instead.
44
46
  */
45
47
  // eslint-disable-next-line @repo/internal/react/no-class-components
46
48
  var SpotlightManager = /*#__PURE__*/function (_PureComponent) {
@@ -10,6 +10,8 @@ import { TargetConsumer } from './spotlight-manager';
10
10
  * - [Examples](https://atlassian.design/components/onboarding/examples)
11
11
  * - [Code](https://atlassian.design/components/onboarding/code)
12
12
  * - [Usage](https://atlassian.design/components/onboarding/usage)
13
+ *
14
+ * @deprecated Use `@atlaskit/spotlight` instead.
13
15
  */
14
16
  var SpotlightTarget = function SpotlightTarget(_ref) {
15
17
  var children = _ref.children,
@@ -29,6 +29,8 @@ var hasChildren = function hasChildren(children) {
29
29
  * - [Examples](https://atlassian.design/components/onboarding/examples)
30
30
  * - [Code](https://atlassian.design/components/onboarding/code)
31
31
  * - [Usage](https://atlassian.design/components/onboarding/usage)
32
+ *
33
+ * @deprecated Use `@atlaskit/spotlight` instead.
32
34
  */
33
35
  var SpotlightTransition = /*#__PURE__*/function (_React$Component) {
34
36
  function SpotlightTransition() {
@@ -13,6 +13,8 @@ import { SpotlightConsumer } from './spotlight-manager';
13
13
  * - [Examples](https://atlassian.design/components/onboarding/examples)
14
14
  * - [Code](https://atlassian.design/components/onboarding/code)
15
15
  * - [Usage](https://atlassian.design/components/onboarding/usage)
16
+ *
17
+ * @deprecated Use `@atlaskit/spotlight` instead.
16
18
  */
17
19
  var Spotlight = function Spotlight(_ref) {
18
20
  var actions = _ref.actions,
@@ -3,6 +3,8 @@ import { SpotlightContext } from './spotlight-manager';
3
3
 
4
4
  /**
5
5
  * Use spotlight hook returns information about available spotlight targets.
6
+ *
7
+ * @deprecated Use `@atlaskit/spotlight` instead.
6
8
  */
7
9
  export default function useSpotlight() {
8
10
  var _useContext = useContext(SpotlightContext),
package/dist/esm/index.js CHANGED
@@ -1,14 +1,2 @@
1
- /**
2
- * We re-export this because products may have multiple versions of
3
- * `@atlaskit/modal-dialog`.
4
- *
5
- * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
- * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
- * stuck in an open state.
8
- *
9
- * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
- * and a reproduction.
11
- */
12
- export { default as ModalTransition } from '@atlaskit/modal-dialog/modal-transition';
13
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight } from './components';
1
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, ModalTransition } from './components';
14
2
  export { Pulse as SpotlightPulse } from './styled/target';
@@ -100,6 +100,8 @@ export var TargetOverlay = function TargetOverlay(_ref3) {
100
100
  * - [Examples](https://atlassian.design/components/onboarding/examples)
101
101
  * - [Code](https://atlassian.design/components/onboarding/code)
102
102
  * - [Usage](https://atlassian.design/components/onboarding/usage)
103
+ *
104
+ * @deprecated Use `@atlaskit/spotlight` instead.
103
105
  */
104
106
  export var Pulse = function Pulse(_ref4) {
105
107
  var bgColor = _ref4.bgColor,
@@ -52,6 +52,7 @@ var useResizeAwareElementBox = function useResizeAwareElementBox(element, update
52
52
  listener: onResize
53
53
  });
54
54
  }
55
+ return function () {};
55
56
  }, [element, updateMethod]);
56
57
  return box;
57
58
  };
@@ -1,4 +1,5 @@
1
1
  import Modal from './modal';
2
+ import ModalTransition from './modal-transition';
2
3
  import Spotlight from './spotlight';
3
4
  import SpotlightCard from './spotlight-card';
4
5
  import SpotlightManager from './spotlight-manager';
@@ -6,4 +7,4 @@ import SpotlightTarget from './spotlight-target';
6
7
  import SpotlightTransition from './spotlight-transition';
7
8
  import useSpotlight from './use-spotlight';
8
9
  export { spotlightButtonTheme, modalButtonTheme } from './theme';
9
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, };
10
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, ModalTransition, };
@@ -0,0 +1,17 @@
1
+ /**
2
+ * We re-export this because products may have multiple versions of
3
+ * `@atlaskit/modal-dialog`.
4
+ *
5
+ * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
+ * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
+ * stuck in an open state.
8
+ *
9
+ * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
+ * and a reproduction.
11
+ *
12
+ */
13
+ import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
14
+ /**
15
+ * @deprecated Use `@atlaskit/spotlight` instead.
16
+ */
17
+ export default ModalTransition;
@@ -43,6 +43,8 @@ type ModalProps = {
43
43
  * - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
44
44
  * - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
45
45
  * - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
46
+ *
47
+ * @deprecated Use `@atlaskit/modal-dialog` instead.
46
48
  */
47
49
  export default class BenefitsModal extends Component<ModalProps> {
48
50
  headerComponent: (props: ModalProps) => React.ElementType<HeaderComponentProps> | (() => React.JSX.Element);
@@ -7,6 +7,8 @@ import { type SpotlightCardProps } from '../types';
7
7
  * - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
8
8
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
9
9
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
10
+ *
11
+ * @deprecated Use `@atlaskit/spotlight` instead.
10
12
  */
11
13
  declare const SpotlightCard: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightCardProps> & React.RefAttributes<HTMLDivElement>>;
12
14
  export default SpotlightCard;
@@ -53,6 +53,8 @@ interface SpotlightManagerProps {
53
53
  * - [Examples](https://atlassian.design/components/onboarding/examples)
54
54
  * - [Code](https://atlassian.design/components/onboarding/code)
55
55
  * - [Usage](https://atlassian.design/components/onboarding/usage)
56
+ *
57
+ * @deprecated Use `@atlaskit/spotlight` instead.
56
58
  */
57
59
  export default class SpotlightManager extends PureComponent<SpotlightManagerProps, {
58
60
  spotlightCount: number;
@@ -40,6 +40,8 @@ interface SpotlightTargetProps {
40
40
  * - [Examples](https://atlassian.design/components/onboarding/examples)
41
41
  * - [Code](https://atlassian.design/components/onboarding/code)
42
42
  * - [Usage](https://atlassian.design/components/onboarding/usage)
43
+ *
44
+ * @deprecated Use `@atlaskit/spotlight` instead.
43
45
  */
44
46
  declare const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => React.JSX.Element;
45
47
  export default SpotlightTarget;
@@ -21,6 +21,8 @@ interface SpotlightTransitionContextModel {
21
21
  * - [Examples](https://atlassian.design/components/onboarding/examples)
22
22
  * - [Code](https://atlassian.design/components/onboarding/code)
23
23
  * - [Usage](https://atlassian.design/components/onboarding/usage)
24
+ *
25
+ * @deprecated Use `@atlaskit/spotlight` instead.
24
26
  */
25
27
  declare class SpotlightTransition extends React.Component<SpotlightTransitionProps, State> {
26
28
  static getDerivedStateFromProps(props: SpotlightTransitionProps, state: State): {
@@ -8,6 +8,8 @@ import { type SpotlightProps } from '../types';
8
8
  * - [Examples](https://atlassian.design/components/onboarding/examples)
9
9
  * - [Code](https://atlassian.design/components/onboarding/code)
10
10
  * - [Usage](https://atlassian.design/components/onboarding/usage)
11
+ *
12
+ * @deprecated Use `@atlaskit/spotlight` instead.
11
13
  */
12
14
  declare const Spotlight: ({ actions, actionsBeforeElement, children, dialogPlacement, dialogWidth, footer, header, heading, headingAfterElement, image, label, pulse, scrollPositionBlock, shouldWatchTarget, target, targetBgColor, targetNode, targetOnClick, targetRadius, targetReplacement, testId, titleId, ...rest }: SpotlightProps) => React.JSX.Element;
13
15
  export default Spotlight;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Use spotlight hook returns information about available spotlight targets.
3
+ *
4
+ * @deprecated Use `@atlaskit/spotlight` instead.
3
5
  */
4
6
  export default function useSpotlight(): {
5
7
  isTargetRendered: (target: string) => boolean;
@@ -1,14 +1,2 @@
1
- /**
2
- * We re-export this because products may have multiple versions of
3
- * `@atlaskit/modal-dialog`.
4
- *
5
- * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
- * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
- * stuck in an open state.
8
- *
9
- * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
- * and a reproduction.
11
- */
12
- export { default as ModalTransition } from '@atlaskit/modal-dialog/modal-transition';
13
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, } from './components';
1
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, ModalTransition, } from './components';
14
2
  export { Pulse as SpotlightPulse } from './styled/target';
@@ -38,6 +38,8 @@ export declare const TargetOverlay: ({ onClick, ...props }: HTMLAttributes<HTMLD
38
38
  * - [Examples](https://atlassian.design/components/onboarding/examples)
39
39
  * - [Code](https://atlassian.design/components/onboarding/code)
40
40
  * - [Usage](https://atlassian.design/components/onboarding/usage)
41
+ *
42
+ * @deprecated Use `@atlaskit/spotlight` instead.
41
43
  */
42
44
  export declare const Pulse: ({ bgColor, children, className, radius, pulse, testId, ...props }: TargetProps) => JSX.Element;
43
45
  export {};
@@ -1,4 +1,5 @@
1
1
  import Modal from './modal';
2
+ import ModalTransition from './modal-transition';
2
3
  import Spotlight from './spotlight';
3
4
  import SpotlightCard from './spotlight-card';
4
5
  import SpotlightManager from './spotlight-manager';
@@ -6,4 +7,4 @@ import SpotlightTarget from './spotlight-target';
6
7
  import SpotlightTransition from './spotlight-transition';
7
8
  import useSpotlight from './use-spotlight';
8
9
  export { spotlightButtonTheme, modalButtonTheme } from './theme';
9
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, };
10
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, useSpotlight, ModalTransition, };
@@ -0,0 +1,17 @@
1
+ /**
2
+ * We re-export this because products may have multiple versions of
3
+ * `@atlaskit/modal-dialog`.
4
+ *
5
+ * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
+ * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
+ * stuck in an open state.
8
+ *
9
+ * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
+ * and a reproduction.
11
+ *
12
+ */
13
+ import ModalTransition from '@atlaskit/modal-dialog/modal-transition';
14
+ /**
15
+ * @deprecated Use `@atlaskit/spotlight` instead.
16
+ */
17
+ export default ModalTransition;
@@ -43,6 +43,8 @@ type ModalProps = {
43
43
  * - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
44
44
  * - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
45
45
  * - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
46
+ *
47
+ * @deprecated Use `@atlaskit/modal-dialog` instead.
46
48
  */
47
49
  export default class BenefitsModal extends Component<ModalProps> {
48
50
  headerComponent: (props: ModalProps) => React.ElementType<HeaderComponentProps> | (() => React.JSX.Element);
@@ -7,6 +7,8 @@ import { type SpotlightCardProps } from '../types';
7
7
  * - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
8
8
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
9
9
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
10
+ *
11
+ * @deprecated Use `@atlaskit/spotlight` instead.
10
12
  */
11
13
  declare const SpotlightCard: React.ForwardRefExoticComponent<React.PropsWithoutRef<SpotlightCardProps> & React.RefAttributes<HTMLDivElement>>;
12
14
  export default SpotlightCard;
@@ -53,6 +53,8 @@ interface SpotlightManagerProps {
53
53
  * - [Examples](https://atlassian.design/components/onboarding/examples)
54
54
  * - [Code](https://atlassian.design/components/onboarding/code)
55
55
  * - [Usage](https://atlassian.design/components/onboarding/usage)
56
+ *
57
+ * @deprecated Use `@atlaskit/spotlight` instead.
56
58
  */
57
59
  export default class SpotlightManager extends PureComponent<SpotlightManagerProps, {
58
60
  spotlightCount: number;
@@ -40,6 +40,8 @@ interface SpotlightTargetProps {
40
40
  * - [Examples](https://atlassian.design/components/onboarding/examples)
41
41
  * - [Code](https://atlassian.design/components/onboarding/code)
42
42
  * - [Usage](https://atlassian.design/components/onboarding/usage)
43
+ *
44
+ * @deprecated Use `@atlaskit/spotlight` instead.
43
45
  */
44
46
  declare const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => React.JSX.Element;
45
47
  export default SpotlightTarget;
@@ -21,6 +21,8 @@ interface SpotlightTransitionContextModel {
21
21
  * - [Examples](https://atlassian.design/components/onboarding/examples)
22
22
  * - [Code](https://atlassian.design/components/onboarding/code)
23
23
  * - [Usage](https://atlassian.design/components/onboarding/usage)
24
+ *
25
+ * @deprecated Use `@atlaskit/spotlight` instead.
24
26
  */
25
27
  declare class SpotlightTransition extends React.Component<SpotlightTransitionProps, State> {
26
28
  static getDerivedStateFromProps(props: SpotlightTransitionProps, state: State): {
@@ -8,6 +8,8 @@ import { type SpotlightProps } from '../types';
8
8
  * - [Examples](https://atlassian.design/components/onboarding/examples)
9
9
  * - [Code](https://atlassian.design/components/onboarding/code)
10
10
  * - [Usage](https://atlassian.design/components/onboarding/usage)
11
+ *
12
+ * @deprecated Use `@atlaskit/spotlight` instead.
11
13
  */
12
14
  declare const Spotlight: ({ actions, actionsBeforeElement, children, dialogPlacement, dialogWidth, footer, header, heading, headingAfterElement, image, label, pulse, scrollPositionBlock, shouldWatchTarget, target, targetBgColor, targetNode, targetOnClick, targetRadius, targetReplacement, testId, titleId, ...rest }: SpotlightProps) => React.JSX.Element;
13
15
  export default Spotlight;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Use spotlight hook returns information about available spotlight targets.
3
+ *
4
+ * @deprecated Use `@atlaskit/spotlight` instead.
3
5
  */
4
6
  export default function useSpotlight(): {
5
7
  isTargetRendered: (target: string) => boolean;
@@ -1,14 +1,2 @@
1
- /**
2
- * We re-export this because products may have multiple versions of
3
- * `@atlaskit/modal-dialog`.
4
- *
5
- * If a consumer uses the onboarding `Modal` with the `ModalTransition` from an
6
- * incompatible version of `@atlaskit/modal-dialog`, then the modal can get
7
- * stuck in an open state.
8
- *
9
- * See https://product-fabric.atlassian.net/browse/DSP-796 for more details
10
- * and a reproduction.
11
- */
12
- export { default as ModalTransition } from '@atlaskit/modal-dialog/modal-transition';
13
- export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, } from './components';
1
+ export { Modal, Spotlight, SpotlightCard, SpotlightManager, SpotlightTarget, SpotlightTransition, modalButtonTheme, spotlightButtonTheme, useSpotlight, ModalTransition, } from './components';
14
2
  export { Pulse as SpotlightPulse } from './styled/target';
@@ -38,6 +38,8 @@ export declare const TargetOverlay: ({ onClick, ...props }: HTMLAttributes<HTMLD
38
38
  * - [Examples](https://atlassian.design/components/onboarding/examples)
39
39
  * - [Code](https://atlassian.design/components/onboarding/code)
40
40
  * - [Usage](https://atlassian.design/components/onboarding/usage)
41
+ *
42
+ * @deprecated Use `@atlaskit/spotlight` instead.
41
43
  */
42
44
  export declare const Pulse: ({ bgColor, children, className, radius, pulse, testId, ...props }: TargetProps) => JSX.Element;
43
45
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "14.4.8",
3
+ "version": "14.4.9",
4
4
  "description": "An onboarding spotlight introduces new features to users through focused messages or multi-step tours.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -56,14 +56,14 @@
56
56
  "@atlaskit/css": "^0.15.0",
57
57
  "@atlaskit/ds-lib": "^5.1.0",
58
58
  "@atlaskit/heading": "^5.2.0",
59
- "@atlaskit/layering": "^3.1.0",
60
- "@atlaskit/modal-dialog": "^14.5.0",
59
+ "@atlaskit/layering": "^3.2.0",
60
+ "@atlaskit/modal-dialog": "^14.6.0",
61
61
  "@atlaskit/motion": "^5.3.0",
62
62
  "@atlaskit/platform-feature-flags": "^1.1.0",
63
63
  "@atlaskit/popper": "^7.1.0",
64
64
  "@atlaskit/portal": "^5.1.0",
65
- "@atlaskit/primitives": "^16.0.0",
66
- "@atlaskit/tokens": "^7.0.0",
65
+ "@atlaskit/primitives": "^16.1.0",
66
+ "@atlaskit/tokens": "^7.1.0",
67
67
  "@babel/runtime": "^7.0.0",
68
68
  "@compiled/react": "^0.18.6",
69
69
  "bind-event-listener": "^3.0.0",