@atlaskit/onboarding 10.8.2 → 10.8.4

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 (33) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/cjs/components/spotlight-card.js +6 -2
  3. package/dist/cjs/components/spotlight-dialog.js +1 -1
  4. package/dist/cjs/styled/dialog.js +7 -5
  5. package/dist/cjs/styled/modal.js +2 -4
  6. package/dist/cjs/version.json +1 -1
  7. package/dist/es2019/components/spotlight-card.js +6 -2
  8. package/dist/es2019/components/spotlight-dialog.js +1 -1
  9. package/dist/es2019/styled/dialog.js +3 -2
  10. package/dist/es2019/styled/modal.js +2 -4
  11. package/dist/es2019/version.json +1 -1
  12. package/dist/esm/components/spotlight-card.js +6 -2
  13. package/dist/esm/components/spotlight-dialog.js +1 -1
  14. package/dist/esm/styled/dialog.js +7 -5
  15. package/dist/esm/styled/modal.js +2 -4
  16. package/dist/esm/version.json +1 -1
  17. package/dist/types/components/spotlight-card.d.ts +2 -2
  18. package/dist/types/components/spotlight-target.d.ts +2 -2
  19. package/dist/types/components/spotlight.d.ts +2 -2
  20. package/dist/types/styled/blanket.d.ts +3 -1
  21. package/dist/types/styled/dialog.d.ts +9 -6
  22. package/dist/types/styled/modal.d.ts +19 -15
  23. package/dist/types/styled/target.d.ts +5 -4
  24. package/dist/types-ts4.5/components/spotlight-card.d.ts +2 -2
  25. package/dist/types-ts4.5/components/spotlight-target.d.ts +2 -2
  26. package/dist/types-ts4.5/components/spotlight.d.ts +2 -2
  27. package/dist/types-ts4.5/styled/blanket.d.ts +3 -1
  28. package/dist/types-ts4.5/styled/dialog.d.ts +9 -6
  29. package/dist/types-ts4.5/styled/modal.d.ts +19 -15
  30. package/dist/types-ts4.5/styled/target.d.ts +5 -4
  31. package/package.json +5 -6
  32. package/report.api.md +22 -5
  33. package/tmp/api-report-tmp.d.ts +226 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  # @atlaskit/onboarding
2
2
 
3
+ ## 10.8.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [`df6aac8c5a6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/df6aac8c5a6) - When providing an image path to `SpotlightCard`, there is no longer an additional space that appears between the image and content padding.
8
+ - Updated dependencies
9
+
10
+ ## 10.8.3
11
+
12
+ ### Patch Changes
13
+
14
+ - [`e7ea6832ad2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e7ea6832ad2) - Bans the use of React.FC/React.FunctionComponent type in ADS components as part of the React 18 migration work. The change is internal only and should not introduce any changes for the component consumers.
15
+
3
16
  ## 10.8.2
4
17
 
5
18
  ### Patch Changes
@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", {
7
7
  });
8
8
  exports.default = void 0;
9
9
  var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
10
- var _react = _interopRequireWildcard(require("react"));
10
+ var _react = require("react");
11
11
  var _react2 = require("@emotion/react");
12
12
  var _customThemeButton = _interopRequireWildcard(require("@atlaskit/button/custom-theme-button"));
13
13
  var _heading = _interopRequireDefault(require("@atlaskit/heading"));
@@ -25,6 +25,9 @@ var bodyStyles = (0, _react2.css)({
25
25
  padding: "var(--ds-space-200, 16px)".concat(" ", "var(--ds-space-250, 20px)"),
26
26
  flexDirection: 'column'
27
27
  });
28
+ var imageStyles = (0, _react2.css)({
29
+ display: 'block'
30
+ });
28
31
  var defaultHeaderStyles = (0, _react2.css)({
29
32
  display: 'flex',
30
33
  paddingBottom: "var(--ds-space-100, 8px)",
@@ -111,7 +114,7 @@ var SpotlightCard = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
111
114
  var container = _ref3.container;
112
115
  return (0, _react2.jsx)("div", {
113
116
  css: [containerStyles, !isFlat && containerShadowStyles,
114
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
117
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
115
118
  container],
116
119
  style: {
117
120
  width: "".concat(Math.min(Math.max(width, 160), 600), "px")
@@ -119,6 +122,7 @@ var SpotlightCard = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
119
122
  ref: ref || innerRef,
120
123
  "data-testid": testId
121
124
  }, typeof image === 'string' ? (0, _react2.jsx)("img", {
125
+ css: imageStyles,
122
126
  src: image,
123
127
  alt: ""
124
128
  }) : image, (0, _react2.jsx)("div", {
@@ -27,7 +27,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
27
27
  function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = (0, _getPrototypeOf2.default)(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = (0, _getPrototypeOf2.default)(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return (0, _possibleConstructorReturn2.default)(this, result); }; }
28
28
  function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === "function") return true; try { Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); return true; } catch (e) { return false; } }
29
29
  var packageName = "@atlaskit/onboarding";
30
- var packageVersion = "10.8.2";
30
+ var packageVersion = "10.8.4";
31
31
  var SpotlightDialog = /*#__PURE__*/function (_Component) {
32
32
  (0, _inherits2.default)(SpotlightDialog, _Component);
33
33
  var _super = _createSuper(SpotlightDialog);
@@ -24,7 +24,6 @@ var actionItemContainerStyles = (0, _react.css)({
24
24
  var actionItemStyles = (0, _react.css)({
25
25
  margin: "var(--ds-space-0, 0px)".concat(" ", "var(--ds-space-050, 4px)")
26
26
  });
27
-
28
27
  /**
29
28
  * __Dialog image__
30
29
  *
@@ -35,10 +34,13 @@ var actionItemStyles = (0, _react.css)({
35
34
  var DialogImage = function DialogImage(_ref) {
36
35
  var alt = _ref.alt,
37
36
  props = (0, _objectWithoutProperties2.default)(_ref, _excluded);
38
- return (0, _react.jsx)("img", (0, _extends2.default)({
39
- css: imageStyles,
40
- alt: alt
41
- }, props));
37
+ return (
38
+ // eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
39
+ (0, _react.jsx)("img", (0, _extends2.default)({
40
+ css: imageStyles,
41
+ alt: alt
42
+ }, props))
43
+ );
42
44
  };
43
45
 
44
46
  /**
@@ -12,13 +12,13 @@ var _typography = require("@atlaskit/theme/typography");
12
12
 
13
13
  var borderRadius = (0, _constants.borderRadius)();
14
14
 
15
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
15
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
16
16
  var lightH600Styles = (0, _react.css)((0, _typography.h600)({
17
17
  theme: {
18
18
  mode: 'light'
19
19
  }
20
20
  }));
21
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
21
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
22
22
  var darkH600Styles = (0, _react.css)((0, _typography.h600)({
23
23
  theme: {
24
24
  mode: 'dark'
@@ -28,8 +28,6 @@ var modalBodyStyles = (0, _react.css)({
28
28
  padding: "var(--ds-space-500, 40px)".concat(" ", "var(--ds-space-250, 20px)"),
29
29
  textAlign: 'center'
30
30
  });
31
-
32
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
33
31
  var modalHeadingStyles = (0, _react.css)({
34
32
  marginBottom: "var(--ds-space-100, 8px)",
35
33
  color: 'inherit'
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "10.8.2",
3
+ "version": "10.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import React, { forwardRef } from 'react';
2
+ import { forwardRef } from 'react';
3
3
  import { css, jsx } from '@emotion/react';
4
4
  import Button, { Theme as ButtonTheme } from '@atlaskit/button/custom-theme-button';
5
5
  import Heading from '@atlaskit/heading';
@@ -13,6 +13,9 @@ const bodyStyles = css({
13
13
  padding: `${"var(--ds-space-200, 16px)"} ${"var(--ds-space-250, 20px)"}`,
14
14
  flexDirection: 'column'
15
15
  });
16
+ const imageStyles = css({
17
+ display: 'block'
18
+ });
16
19
  const defaultHeaderStyles = css({
17
20
  display: 'flex',
18
21
  paddingBottom: "var(--ds-space-100, 8px)",
@@ -95,7 +98,7 @@ const SpotlightCard = /*#__PURE__*/forwardRef((props, ref) => {
95
98
  }) => {
96
99
  return jsx("div", {
97
100
  css: [containerStyles, !isFlat && containerShadowStyles,
98
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
101
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
99
102
  container],
100
103
  style: {
101
104
  width: `${Math.min(Math.max(width, 160), 600)}px`
@@ -103,6 +106,7 @@ const SpotlightCard = /*#__PURE__*/forwardRef((props, ref) => {
103
106
  ref: ref || innerRef,
104
107
  "data-testid": testId
105
108
  }, typeof image === 'string' ? jsx("img", {
109
+ css: imageStyles,
106
110
  src: image,
107
111
  alt: ""
108
112
  }) : image, jsx("div", {
@@ -7,7 +7,7 @@ import { DialogImage } from '../styled/dialog';
7
7
  import SpotlightCard from './spotlight-card';
8
8
  import ValueChanged from './value-changed';
9
9
  const packageName = "@atlaskit/onboarding";
10
- const packageVersion = "10.8.2";
10
+ const packageVersion = "10.8.4";
11
11
  class SpotlightDialog extends Component {
12
12
  constructor(...args) {
13
13
  super(...args);
@@ -16,7 +16,6 @@ const actionItemContainerStyles = css({
16
16
  const actionItemStyles = css({
17
17
  margin: `${"var(--ds-space-0, 0px)"} ${"var(--ds-space-050, 4px)"}`
18
18
  });
19
-
20
19
  /**
21
20
  * __Dialog image__
22
21
  *
@@ -27,7 +26,9 @@ const actionItemStyles = css({
27
26
  export const DialogImage = ({
28
27
  alt,
29
28
  ...props
30
- }) => jsx("img", _extends({
29
+ }) =>
30
+ // eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
31
+ jsx("img", _extends({
31
32
  css: imageStyles,
32
33
  alt: alt
33
34
  }, props));
@@ -6,13 +6,13 @@ import { borderRadius as getBorderRadius } from '@atlaskit/theme/constants';
6
6
  import { h600 } from '@atlaskit/theme/typography';
7
7
  const borderRadius = getBorderRadius();
8
8
 
9
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
9
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
10
10
  const lightH600Styles = css(h600({
11
11
  theme: {
12
12
  mode: 'light'
13
13
  }
14
14
  }));
15
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
15
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
16
16
  const darkH600Styles = css(h600({
17
17
  theme: {
18
18
  mode: 'dark'
@@ -22,8 +22,6 @@ const modalBodyStyles = css({
22
22
  padding: `${"var(--ds-space-500, 40px)"} ${"var(--ds-space-250, 20px)"}`,
23
23
  textAlign: 'center'
24
24
  });
25
-
26
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
27
25
  const modalHeadingStyles = css({
28
26
  marginBottom: "var(--ds-space-100, 8px)",
29
27
  color: 'inherit'
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "10.8.2",
3
+ "version": "10.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,7 +1,7 @@
1
1
  import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
2
2
  var _excluded = ["text", "key"];
3
3
  /** @jsx jsx */
4
- import React, { forwardRef } from 'react';
4
+ import { forwardRef } from 'react';
5
5
  import { css, jsx } from '@emotion/react';
6
6
  import Button, { Theme as ButtonTheme } from '@atlaskit/button/custom-theme-button';
7
7
  import Heading from '@atlaskit/heading';
@@ -15,6 +15,9 @@ var bodyStyles = css({
15
15
  padding: "var(--ds-space-200, 16px)".concat(" ", "var(--ds-space-250, 20px)"),
16
16
  flexDirection: 'column'
17
17
  });
18
+ var imageStyles = css({
19
+ display: 'block'
20
+ });
18
21
  var defaultHeaderStyles = css({
19
22
  display: 'flex',
20
23
  paddingBottom: "var(--ds-space-100, 8px)",
@@ -101,7 +104,7 @@ var SpotlightCard = /*#__PURE__*/forwardRef(function (props, ref) {
101
104
  var container = _ref3.container;
102
105
  return jsx("div", {
103
106
  css: [containerStyles, !isFlat && containerShadowStyles,
104
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
107
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
105
108
  container],
106
109
  style: {
107
110
  width: "".concat(Math.min(Math.max(width, 160), 600), "px")
@@ -109,6 +112,7 @@ var SpotlightCard = /*#__PURE__*/forwardRef(function (props, ref) {
109
112
  ref: ref || innerRef,
110
113
  "data-testid": testId
111
114
  }, typeof image === 'string' ? jsx("img", {
115
+ css: imageStyles,
112
116
  src: image,
113
117
  alt: ""
114
118
  }) : image, jsx("div", {
@@ -17,7 +17,7 @@ import { DialogImage } from '../styled/dialog';
17
17
  import SpotlightCard from './spotlight-card';
18
18
  import ValueChanged from './value-changed';
19
19
  var packageName = "@atlaskit/onboarding";
20
- var packageVersion = "10.8.2";
20
+ var packageVersion = "10.8.4";
21
21
  var SpotlightDialog = /*#__PURE__*/function (_Component) {
22
22
  _inherits(SpotlightDialog, _Component);
23
23
  var _super = _createSuper(SpotlightDialog);
@@ -18,7 +18,6 @@ var actionItemContainerStyles = css({
18
18
  var actionItemStyles = css({
19
19
  margin: "var(--ds-space-0, 0px)".concat(" ", "var(--ds-space-050, 4px)")
20
20
  });
21
-
22
21
  /**
23
22
  * __Dialog image__
24
23
  *
@@ -29,10 +28,13 @@ var actionItemStyles = css({
29
28
  export var DialogImage = function DialogImage(_ref) {
30
29
  var alt = _ref.alt,
31
30
  props = _objectWithoutProperties(_ref, _excluded);
32
- return jsx("img", _extends({
33
- css: imageStyles,
34
- alt: alt
35
- }, props));
31
+ return (
32
+ // eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
33
+ jsx("img", _extends({
34
+ css: imageStyles,
35
+ alt: alt
36
+ }, props))
37
+ );
36
38
  };
37
39
 
38
40
  /**
@@ -6,13 +6,13 @@ import { borderRadius as getBorderRadius } from '@atlaskit/theme/constants';
6
6
  import { h600 } from '@atlaskit/theme/typography';
7
7
  var borderRadius = getBorderRadius();
8
8
 
9
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
9
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
10
10
  var lightH600Styles = css(h600({
11
11
  theme: {
12
12
  mode: 'light'
13
13
  }
14
14
  }));
15
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
15
+ // eslint-disable-next-line @atlaskit/design-system/consistent-css-prop-usage
16
16
  var darkH600Styles = css(h600({
17
17
  theme: {
18
18
  mode: 'dark'
@@ -22,8 +22,6 @@ var modalBodyStyles = css({
22
22
  padding: "var(--ds-space-500, 40px)".concat(" ", "var(--ds-space-250, 20px)"),
23
23
  textAlign: 'center'
24
24
  });
25
-
26
- // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
27
25
  var modalHeadingStyles = css({
28
26
  marginBottom: "var(--ds-space-100, 8px)",
29
27
  color: 'inherit'
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "10.8.2",
3
+ "version": "10.8.4",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import React, { ComponentType, ReactNode, Ref } from 'react';
2
+ import { ComponentType, ReactNode, Ref } from 'react';
3
3
  import { ThemeProp } from '@atlaskit/theme/components';
4
4
  import { Actions } from '../types';
5
5
  /**
@@ -77,5 +77,5 @@ interface SpotlightCardProps {
77
77
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
78
78
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
79
79
  */
80
- declare const SpotlightCard: React.ForwardRefExoticComponent<SpotlightCardProps & React.RefAttributes<HTMLDivElement>>;
80
+ declare const SpotlightCard: import("react").ForwardRefExoticComponent<SpotlightCardProps & import("react").RefAttributes<HTMLDivElement>>;
81
81
  export default SpotlightCard;
@@ -1,4 +1,4 @@
1
- import React, { ReactNode } from 'react';
1
+ import { ReactNode } from 'react';
2
2
  interface SpotlightTargetProps {
3
3
  /**
4
4
  * A single child
@@ -18,5 +18,5 @@ interface SpotlightTargetProps {
18
18
  * - [Code](https://atlassian.design/components/onboarding/code)
19
19
  * - [Usage](https://atlassian.design/components/onboarding/usage)
20
20
  */
21
- declare const SpotlightTarget: React.FC<SpotlightTargetProps>;
21
+ declare const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => JSX.Element;
22
22
  export default SpotlightTarget;
@@ -1,4 +1,4 @@
1
- import React, { ComponentType, MouseEvent, ReactNode } from 'react';
1
+ import { ComponentType, MouseEvent, ReactNode } from 'react';
2
2
  import { Actions } from '../types';
3
3
  export interface SpotlightProps {
4
4
  /**
@@ -92,5 +92,5 @@ export interface SpotlightProps {
92
92
  * - [Code](https://atlassian.design/components/onboarding/code)
93
93
  * - [Usage](https://atlassian.design/components/onboarding/usage)
94
94
  */
95
- declare const Spotlight: React.FC<SpotlightProps>;
95
+ declare const Spotlight: ({ dialogWidth, pulse, testId, targetNode, target, ...rest }: SpotlightProps) => JSX.Element;
96
96
  export default Spotlight;
@@ -1,4 +1,6 @@
1
1
  /// <reference types="react" />
2
+ /** @jsx jsx */
3
+ import { jsx } from '@emotion/react';
2
4
  type BlanketProps = {
3
5
  isTinted?: boolean;
4
6
  style?: React.CSSProperties;
@@ -14,5 +16,5 @@ type BlanketProps = {
14
16
  *
15
17
  * @internal
16
18
  */
17
- declare const Blanket: React.FC<BlanketProps>;
19
+ declare const Blanket: (props: BlanketProps) => jsx.JSX.Element;
18
20
  export default Blanket;
@@ -1,5 +1,7 @@
1
1
  /** @jsx jsx */
2
- import { ReactNode } from 'react';
2
+ import { ImgHTMLAttributes, ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
4
+ type DialogImageProps = ImgHTMLAttributes<HTMLImageElement>;
3
5
  /**
4
6
  * __Dialog image__
5
7
  *
@@ -7,7 +9,7 @@ import { ReactNode } from 'react';
7
9
  *
8
10
  * @internal
9
11
  */
10
- export declare const DialogImage: React.FC<React.ImgHTMLAttributes<HTMLImageElement>>;
12
+ export declare const DialogImage: ({ alt, ...props }: DialogImageProps) => jsx.JSX.Element;
11
13
  /**
12
14
  * __Dialog action item container__
13
15
  *
@@ -15,9 +17,9 @@ export declare const DialogImage: React.FC<React.ImgHTMLAttributes<HTMLImageElem
15
17
  *
16
18
  * @internal
17
19
  */
18
- export declare const DialogActionItemContainer: React.FC<{
20
+ export declare const DialogActionItemContainer: ({ children, }: {
19
21
  children: ReactNode;
20
- }>;
22
+ }) => jsx.JSX.Element;
21
23
  /**
22
24
  * __Dialog action item__
23
25
  *
@@ -25,6 +27,7 @@ export declare const DialogActionItemContainer: React.FC<{
25
27
  *
26
28
  * @internal
27
29
  */
28
- export declare const DialogActionItem: React.FC<{
30
+ export declare const DialogActionItem: ({ children }: {
29
31
  children: ReactNode;
30
- }>;
32
+ }) => jsx.JSX.Element;
33
+ export {};
@@ -1,44 +1,48 @@
1
1
  /** @jsx jsx */
2
2
  import { ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
4
+ type ModalImageProps = {
5
+ alt: string;
6
+ src?: string;
7
+ };
8
+ type ModalActionContainerProps = {
9
+ shouldReverseButtonOrder: boolean;
10
+ children: ReactNode;
11
+ };
3
12
  /**
4
13
  * __Modal body__
5
14
  *
6
15
  * @internal
7
16
  */
8
- export declare const ModalBody: React.FC<{
17
+ export declare const ModalBody: ({ children }: {
9
18
  children: ReactNode;
10
- }>;
19
+ }) => jsx.JSX.Element;
11
20
  /**
12
21
  * __Modal heading__
13
22
  *
14
23
  * @internal
15
24
  */
16
- export declare const ModalHeading: React.FC<{
17
- children: string;
18
- }>;
25
+ export declare const ModalHeading: ({ children }: {
26
+ children: ReactNode;
27
+ }) => jsx.JSX.Element;
19
28
  /**
20
29
  * __Modal image__
21
30
  *
22
31
  * @internal
23
32
  */
24
- export declare const ModalImage: React.FC<{
25
- alt: string;
26
- src?: string;
27
- }>;
33
+ export declare const ModalImage: ({ alt, src }: ModalImageProps) => jsx.JSX.Element;
28
34
  /**
29
35
  * __Modal action container__
30
36
  *
31
37
  * @internal
32
38
  */
33
- export declare const ModalActionContainer: React.FC<{
34
- shouldReverseButtonOrder: boolean;
35
- children: ReactNode;
36
- }>;
39
+ export declare const ModalActionContainer: ({ children, shouldReverseButtonOrder, }: ModalActionContainerProps) => jsx.JSX.Element;
37
40
  /**
38
41
  * __Modal action item__
39
42
  *
40
43
  * @internal
41
44
  */
42
- export declare const ModalActionItem: React.FC<{
45
+ export declare const ModalActionItem: ({ children }: {
43
46
  children: ReactNode;
44
- }>;
47
+ }) => jsx.JSX.Element;
48
+ export {};
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
- import { ReactNode } from 'react';
2
+ import { HTMLAttributes, ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
4
5
  bgColor?: string;
5
6
  radius?: number;
@@ -19,7 +20,7 @@ export declare const pulseKeyframesName: string;
19
20
  *
20
21
  * @internal
21
22
  */
22
- export declare const TargetInner: React.FC<TargetProps>;
23
+ export declare const TargetInner: ({ children, pulse, ...props }: TargetProps) => jsx.JSX.Element;
23
24
  /**
24
25
  * __Target overlay__
25
26
  *
@@ -28,7 +29,7 @@ export declare const TargetInner: React.FC<TargetProps>;
28
29
  *
29
30
  * @internal
30
31
  */
31
- export declare const TargetOverlay: React.FC<React.HTMLAttributes<HTMLDivElement>>;
32
+ export declare const TargetOverlay: (props: HTMLAttributes<HTMLDivElement>) => jsx.JSX.Element;
32
33
  /**
33
34
  * __Spotlight pulse__
34
35
  *
@@ -38,5 +39,5 @@ export declare const TargetOverlay: React.FC<React.HTMLAttributes<HTMLDivElement
38
39
  * - [Code](https://atlassian.design/components/onboarding/code)
39
40
  * - [Usage](https://atlassian.design/components/onboarding/usage)
40
41
  */
41
- export declare const Pulse: React.FC<TargetProps>;
42
+ export declare const Pulse: ({ children, pulse, testId, ...props }: TargetProps) => jsx.JSX.Element;
42
43
  export {};
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import React, { ComponentType, ReactNode, Ref } from 'react';
2
+ import { ComponentType, ReactNode, Ref } from 'react';
3
3
  import { ThemeProp } from '@atlaskit/theme/components';
4
4
  import { Actions } from '../types';
5
5
  /**
@@ -77,5 +77,5 @@ interface SpotlightCardProps {
77
77
  * - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
78
78
  * - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
79
79
  */
80
- declare const SpotlightCard: React.ForwardRefExoticComponent<SpotlightCardProps & React.RefAttributes<HTMLDivElement>>;
80
+ declare const SpotlightCard: import("react").ForwardRefExoticComponent<SpotlightCardProps & import("react").RefAttributes<HTMLDivElement>>;
81
81
  export default SpotlightCard;
@@ -1,4 +1,4 @@
1
- import React, { ReactNode } from 'react';
1
+ import { ReactNode } from 'react';
2
2
  interface SpotlightTargetProps {
3
3
  /**
4
4
  * A single child
@@ -18,5 +18,5 @@ interface SpotlightTargetProps {
18
18
  * - [Code](https://atlassian.design/components/onboarding/code)
19
19
  * - [Usage](https://atlassian.design/components/onboarding/usage)
20
20
  */
21
- declare const SpotlightTarget: React.FC<SpotlightTargetProps>;
21
+ declare const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => JSX.Element;
22
22
  export default SpotlightTarget;
@@ -1,4 +1,4 @@
1
- import React, { ComponentType, MouseEvent, ReactNode } from 'react';
1
+ import { ComponentType, MouseEvent, ReactNode } from 'react';
2
2
  import { Actions } from '../types';
3
3
  export interface SpotlightProps {
4
4
  /**
@@ -92,5 +92,5 @@ export interface SpotlightProps {
92
92
  * - [Code](https://atlassian.design/components/onboarding/code)
93
93
  * - [Usage](https://atlassian.design/components/onboarding/usage)
94
94
  */
95
- declare const Spotlight: React.FC<SpotlightProps>;
95
+ declare const Spotlight: ({ dialogWidth, pulse, testId, targetNode, target, ...rest }: SpotlightProps) => JSX.Element;
96
96
  export default Spotlight;
@@ -1,4 +1,6 @@
1
1
  /// <reference types="react" />
2
+ /** @jsx jsx */
3
+ import { jsx } from '@emotion/react';
2
4
  type BlanketProps = {
3
5
  isTinted?: boolean;
4
6
  style?: React.CSSProperties;
@@ -14,5 +16,5 @@ type BlanketProps = {
14
16
  *
15
17
  * @internal
16
18
  */
17
- declare const Blanket: React.FC<BlanketProps>;
19
+ declare const Blanket: (props: BlanketProps) => jsx.JSX.Element;
18
20
  export default Blanket;
@@ -1,5 +1,7 @@
1
1
  /** @jsx jsx */
2
- import { ReactNode } from 'react';
2
+ import { ImgHTMLAttributes, ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
4
+ type DialogImageProps = ImgHTMLAttributes<HTMLImageElement>;
3
5
  /**
4
6
  * __Dialog image__
5
7
  *
@@ -7,7 +9,7 @@ import { ReactNode } from 'react';
7
9
  *
8
10
  * @internal
9
11
  */
10
- export declare const DialogImage: React.FC<React.ImgHTMLAttributes<HTMLImageElement>>;
12
+ export declare const DialogImage: ({ alt, ...props }: DialogImageProps) => jsx.JSX.Element;
11
13
  /**
12
14
  * __Dialog action item container__
13
15
  *
@@ -15,9 +17,9 @@ export declare const DialogImage: React.FC<React.ImgHTMLAttributes<HTMLImageElem
15
17
  *
16
18
  * @internal
17
19
  */
18
- export declare const DialogActionItemContainer: React.FC<{
20
+ export declare const DialogActionItemContainer: ({ children, }: {
19
21
  children: ReactNode;
20
- }>;
22
+ }) => jsx.JSX.Element;
21
23
  /**
22
24
  * __Dialog action item__
23
25
  *
@@ -25,6 +27,7 @@ export declare const DialogActionItemContainer: React.FC<{
25
27
  *
26
28
  * @internal
27
29
  */
28
- export declare const DialogActionItem: React.FC<{
30
+ export declare const DialogActionItem: ({ children }: {
29
31
  children: ReactNode;
30
- }>;
32
+ }) => jsx.JSX.Element;
33
+ export {};
@@ -1,44 +1,48 @@
1
1
  /** @jsx jsx */
2
2
  import { ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
4
+ type ModalImageProps = {
5
+ alt: string;
6
+ src?: string;
7
+ };
8
+ type ModalActionContainerProps = {
9
+ shouldReverseButtonOrder: boolean;
10
+ children: ReactNode;
11
+ };
3
12
  /**
4
13
  * __Modal body__
5
14
  *
6
15
  * @internal
7
16
  */
8
- export declare const ModalBody: React.FC<{
17
+ export declare const ModalBody: ({ children }: {
9
18
  children: ReactNode;
10
- }>;
19
+ }) => jsx.JSX.Element;
11
20
  /**
12
21
  * __Modal heading__
13
22
  *
14
23
  * @internal
15
24
  */
16
- export declare const ModalHeading: React.FC<{
17
- children: string;
18
- }>;
25
+ export declare const ModalHeading: ({ children }: {
26
+ children: ReactNode;
27
+ }) => jsx.JSX.Element;
19
28
  /**
20
29
  * __Modal image__
21
30
  *
22
31
  * @internal
23
32
  */
24
- export declare const ModalImage: React.FC<{
25
- alt: string;
26
- src?: string;
27
- }>;
33
+ export declare const ModalImage: ({ alt, src }: ModalImageProps) => jsx.JSX.Element;
28
34
  /**
29
35
  * __Modal action container__
30
36
  *
31
37
  * @internal
32
38
  */
33
- export declare const ModalActionContainer: React.FC<{
34
- shouldReverseButtonOrder: boolean;
35
- children: ReactNode;
36
- }>;
39
+ export declare const ModalActionContainer: ({ children, shouldReverseButtonOrder, }: ModalActionContainerProps) => jsx.JSX.Element;
37
40
  /**
38
41
  * __Modal action item__
39
42
  *
40
43
  * @internal
41
44
  */
42
- export declare const ModalActionItem: React.FC<{
45
+ export declare const ModalActionItem: ({ children }: {
43
46
  children: ReactNode;
44
- }>;
47
+ }) => jsx.JSX.Element;
48
+ export {};
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
- import { ReactNode } from 'react';
2
+ import { HTMLAttributes, ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
4
5
  bgColor?: string;
5
6
  radius?: number;
@@ -19,7 +20,7 @@ export declare const pulseKeyframesName: string;
19
20
  *
20
21
  * @internal
21
22
  */
22
- export declare const TargetInner: React.FC<TargetProps>;
23
+ export declare const TargetInner: ({ children, pulse, ...props }: TargetProps) => jsx.JSX.Element;
23
24
  /**
24
25
  * __Target overlay__
25
26
  *
@@ -28,7 +29,7 @@ export declare const TargetInner: React.FC<TargetProps>;
28
29
  *
29
30
  * @internal
30
31
  */
31
- export declare const TargetOverlay: React.FC<React.HTMLAttributes<HTMLDivElement>>;
32
+ export declare const TargetOverlay: (props: HTMLAttributes<HTMLDivElement>) => jsx.JSX.Element;
32
33
  /**
33
34
  * __Spotlight pulse__
34
35
  *
@@ -38,5 +39,5 @@ export declare const TargetOverlay: React.FC<React.HTMLAttributes<HTMLDivElement
38
39
  * - [Code](https://atlassian.design/components/onboarding/code)
39
40
  * - [Usage](https://atlassian.design/components/onboarding/usage)
40
41
  */
41
- export declare const Pulse: React.FC<TargetProps>;
42
+ export declare const Pulse: ({ children, pulse, testId, ...props }: TargetProps) => jsx.JSX.Element;
42
43
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/onboarding",
3
- "version": "10.8.2",
3
+ "version": "10.8.4",
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/"
@@ -26,7 +26,7 @@
26
26
  "atlassian": {
27
27
  "team": "Design System Team",
28
28
  "deprecatedAutoEntryPoints": true,
29
- "releaseModel": "scheduled",
29
+ "releaseModel": "continuous",
30
30
  "website": {
31
31
  "name": "Onboarding (spotlight)",
32
32
  "category": "Components"
@@ -34,14 +34,14 @@
34
34
  },
35
35
  "dependencies": {
36
36
  "@atlaskit/analytics-next": "^9.1.0",
37
- "@atlaskit/button": "^16.7.0",
37
+ "@atlaskit/button": "^16.8.0",
38
38
  "@atlaskit/ds-lib": "^2.2.0",
39
39
  "@atlaskit/heading": "^1.3.0",
40
- "@atlaskit/modal-dialog": "^12.5.0",
40
+ "@atlaskit/modal-dialog": "^12.6.0",
41
41
  "@atlaskit/popper": "^5.5.0",
42
42
  "@atlaskit/portal": "^4.3.0",
43
43
  "@atlaskit/theme": "^12.5.0",
44
- "@atlaskit/tokens": "^1.4.0",
44
+ "@atlaskit/tokens": "^1.9.0",
45
45
  "@babel/runtime": "^7.0.0",
46
46
  "@emotion/react": "^11.7.1",
47
47
  "bind-event-listener": "^2.1.1",
@@ -62,7 +62,6 @@
62
62
  "@atlaskit/docs": "*",
63
63
  "@atlaskit/icon": "^21.12.0",
64
64
  "@atlaskit/progress-indicator": "^9.5.0",
65
- "@atlaskit/select": "^16.2.0",
66
65
  "@atlaskit/ssr": "*",
67
66
  "@atlaskit/visual-regression": "*",
68
67
  "@atlaskit/webdriver-runner": "*",
package/report.api.md CHANGED
@@ -19,6 +19,7 @@ import { Component } from 'react';
19
19
  import { ComponentType } from 'react';
20
20
  import { CustomThemeButtonProps } from '@atlaskit/button/types';
21
21
  import { ElementType } from 'react';
22
+ import { ForwardRefExoticComponent } from 'react';
22
23
  import { jsx } from '@emotion/react';
23
24
  import { MemoizedFn } from 'memoize-one';
24
25
  import { ModalFooterProps } from '@atlaskit/modal-dialog';
@@ -29,6 +30,7 @@ import { PureComponent } from 'react';
29
30
  import { default as React_2 } from 'react';
30
31
  import { ReactNode } from 'react';
31
32
  import { Ref } from 'react';
33
+ import { RefAttributes } from 'react';
32
34
  import { ThemeProp } from '@atlaskit/theme/components';
33
35
 
34
36
  // @public (undocumented)
@@ -91,7 +93,14 @@ type ModalProps = {
91
93
  export { ModalTransition };
92
94
 
93
95
  // @public
94
- export const Spotlight: React_2.FC<SpotlightProps>;
96
+ export const Spotlight: ({
97
+ dialogWidth,
98
+ pulse,
99
+ testId,
100
+ targetNode,
101
+ target,
102
+ ...rest
103
+ }: SpotlightProps) => JSX.Element;
95
104
 
96
105
  // @public @deprecated (undocumented)
97
106
  export const spotlightButtonTheme: (
@@ -100,8 +109,8 @@ export const spotlightButtonTheme: (
100
109
  ) => any;
101
110
 
102
111
  // @public
103
- export const SpotlightCard: React_2.ForwardRefExoticComponent<
104
- SpotlightCardProps & React_2.RefAttributes<HTMLDivElement>
112
+ export const SpotlightCard: ForwardRefExoticComponent<
113
+ SpotlightCardProps & RefAttributes<HTMLDivElement>
105
114
  >;
106
115
 
107
116
  // @public (undocumented)
@@ -213,10 +222,18 @@ interface SpotlightProps {
213
222
  }
214
223
 
215
224
  // @public
216
- export const SpotlightPulse: React.FC<TargetProps>;
225
+ export const SpotlightPulse: ({
226
+ children,
227
+ pulse,
228
+ testId,
229
+ ...props
230
+ }: TargetProps) => jsx.JSX.Element;
217
231
 
218
232
  // @public
219
- export const SpotlightTarget: React_2.FC<SpotlightTargetProps>;
233
+ export const SpotlightTarget: ({
234
+ children,
235
+ name,
236
+ }: SpotlightTargetProps) => JSX.Element;
220
237
 
221
238
  // @public (undocumented)
222
239
  interface SpotlightTargetProps {
@@ -0,0 +1,226 @@
1
+ ## API Report File for "@atlaskit/onboarding"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { Component } from 'react';
8
+ import { ComponentType } from 'react';
9
+ import { CustomThemeButtonProps } from '@atlaskit/button/types';
10
+ import { ElementType } from 'react';
11
+ import { ForwardRefExoticComponent } from 'react';
12
+ import { jsx } from '@emotion/react';
13
+ import { MemoizedFn } from 'memoize-one';
14
+ import { ModalFooterProps } from '@atlaskit/modal-dialog';
15
+ import { ModalHeaderProps } from '@atlaskit/modal-dialog';
16
+ import { default as ModalTransition } from '@atlaskit/modal-dialog/modal-transition';
17
+ import { MouseEvent as MouseEvent_2 } from 'react';
18
+ import { PureComponent } from 'react';
19
+ import { default as React_2 } from 'react';
20
+ import { ReactNode } from 'react';
21
+ import { Ref } from 'react';
22
+ import { RefAttributes } from 'react';
23
+ import { ThemeProp } from '@atlaskit/theme/components';
24
+
25
+ // @public (undocumented)
26
+ interface Action extends Omit<CustomThemeButtonProps, 'children'> {
27
+ // (undocumented)
28
+ key?: string;
29
+ // (undocumented)
30
+ text?: ReactNode;
31
+ }
32
+
33
+ // @public (undocumented)
34
+ type Actions = Action[];
35
+
36
+ // @public (undocumented)
37
+ type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
38
+ bgColor?: string;
39
+ radius?: number;
40
+ className?: string;
41
+ testId?: string;
42
+ children?: ReactNode;
43
+ };
44
+
45
+ // @public @deprecated (undocumented)
46
+ interface CardTokens {
47
+ // @deprecated (undocumented)
48
+ container: Record<string, string | undefined>;
49
+ }
50
+
51
+ // @public
52
+ export class Modal extends Component<ModalProps> {
53
+ // (undocumented)
54
+ footerComponent: (props: ModalProps) => (() => jsx.JSX.Element | null) | ElementType<ModalFooterProps>;
55
+ // (undocumented)
56
+ headerComponent: (props: ModalProps) => (() => jsx.JSX.Element) | ElementType<ModalHeaderProps>;
57
+ // (undocumented)
58
+ render(): jsx.JSX.Element;
59
+ }
60
+
61
+ // @public @deprecated (undocumented)
62
+ export const modalButtonTheme: (current: any, themeProps: Record<string, any>) => any;
63
+
64
+ // @public (undocumented)
65
+ type ModalProps = {
66
+ actions?: Actions;
67
+ children: ReactNode;
68
+ image?: string;
69
+ header?: ElementType<ModalHeaderProps>;
70
+ footer?: ElementType<ModalFooterProps>;
71
+ heading?: string;
72
+ experimental_shouldShowPrimaryButtonOnRight?: boolean;
73
+ };
74
+
75
+ export { ModalTransition }
76
+
77
+ // @public
78
+ export const Spotlight: ({ dialogWidth, pulse, testId, targetNode, target, ...rest }: SpotlightProps) => JSX.Element;
79
+
80
+ // @public @deprecated (undocumented)
81
+ export const spotlightButtonTheme: (current: any, themeProps: Record<string, any>) => any;
82
+
83
+ // @public
84
+ export const SpotlightCard: ForwardRefExoticComponent<SpotlightCardProps & RefAttributes<HTMLDivElement>>;
85
+
86
+ // @public (undocumented)
87
+ interface SpotlightCardProps {
88
+ actions?: Actions;
89
+ actionsBeforeElement?: ReactNode;
90
+ children?: ReactNode;
91
+ components?: {
92
+ Header?: ComponentType<any>;
93
+ Footer?: ComponentType<any>;
94
+ };
95
+ heading?: ReactNode;
96
+ headingAfterElement?: ReactNode;
97
+ image?: ReactNode | string;
98
+ // @deprecated (undocumented)
99
+ innerRef?: Ref<HTMLDivElement> | null;
100
+ isFlat?: boolean;
101
+ testId?: string;
102
+ // @deprecated (undocumented)
103
+ theme?: ThemeProp<CardTokens, {}>;
104
+ width?: number;
105
+ }
106
+
107
+ // @public
108
+ export class SpotlightManager extends PureComponent<SpotlightManagerProps, {
109
+ spotlightCount: number;
110
+ targets: {
111
+ [key: string]: HTMLElement | void;
112
+ };
113
+ }> {
114
+ // (undocumented)
115
+ componentDidMount(): void;
116
+ // (undocumented)
117
+ static defaultProps: {
118
+ blanketIsTinted: boolean;
119
+ };
120
+ // (undocumented)
121
+ getStateProviderValue: MemoizedFn<(this: any, targets: any) => {
122
+ opened: () => void;
123
+ closed: () => void;
124
+ targets: any;
125
+ }>;
126
+ // (undocumented)
127
+ render(): JSX.Element;
128
+ // (undocumented)
129
+ spotlightClose: () => void;
130
+ // (undocumented)
131
+ spotlightOpen: () => void;
132
+ // (undocumented)
133
+ state: {
134
+ spotlightCount: number;
135
+ targets: {};
136
+ };
137
+ // (undocumented)
138
+ targetRef: (name: string) => (element: HTMLElement | void) => void;
139
+ }
140
+
141
+ // @public (undocumented)
142
+ interface SpotlightManagerProps {
143
+ blanketIsTinted?: boolean;
144
+ children: ReactNode;
145
+ // @deprecated (undocumented)
146
+ component?: ElementType;
147
+ }
148
+
149
+ // @public (undocumented)
150
+ interface SpotlightProps {
151
+ actions?: Actions;
152
+ actionsBeforeElement?: ReactNode;
153
+ children?: ReactNode;
154
+ dialogPlacement?: 'bottom center' | 'bottom left' | 'bottom right' | 'left bottom' | 'left middle' | 'left top' | 'right bottom' | 'right middle' | 'right top' | 'top center' | 'top left' | 'top right';
155
+ dialogWidth?: number;
156
+ footer?: ComponentType<any>;
157
+ header?: ComponentType<any>;
158
+ heading?: string;
159
+ headingAfterElement?: ReactNode;
160
+ image?: string;
161
+ pulse?: boolean;
162
+ target?: string;
163
+ targetBgColor?: string;
164
+ targetNode?: HTMLElement;
165
+ targetOnClick?: (eventData: {
166
+ event: MouseEvent_2<HTMLElement>;
167
+ target?: string;
168
+ }) => void;
169
+ targetRadius?: number;
170
+ targetReplacement?: ComponentType<any>;
171
+ testId?: string;
172
+ }
173
+
174
+ // @public
175
+ export const SpotlightPulse: ({ children, pulse, testId, ...props }: TargetProps) => jsx.JSX.Element;
176
+
177
+ // @public
178
+ export const SpotlightTarget: ({ children, name }: SpotlightTargetProps) => JSX.Element;
179
+
180
+ // @public (undocumented)
181
+ interface SpotlightTargetProps {
182
+ children: ReactNode;
183
+ name: string;
184
+ }
185
+
186
+ // @public
187
+ export class SpotlightTransition extends React_2.Component<SpotlightTransitionProps, State> {
188
+ // (undocumented)
189
+ static getDerivedStateFromProps(props: SpotlightTransitionProps, state: State): {
190
+ currentChildren: React_2.ReactNode;
191
+ };
192
+ // (undocumented)
193
+ onExited: () => void;
194
+ // (undocumented)
195
+ render(): JSX.Element;
196
+ // (undocumented)
197
+ state: {
198
+ currentChildren: undefined;
199
+ };
200
+ }
201
+
202
+ // @public (undocumented)
203
+ interface SpotlightTransitionProps {
204
+ children?: ReactNode;
205
+ }
206
+
207
+ // @public (undocumented)
208
+ interface State {
209
+ // (undocumented)
210
+ currentChildren: ReactNode;
211
+ }
212
+
213
+ // @public (undocumented)
214
+ type TargetProps = Omit<BaseProps, 'css'> & {
215
+ pulse?: boolean;
216
+ testId?: string;
217
+ };
218
+
219
+ // @public
220
+ export function useSpotlight(): {
221
+ isTargetRendered: (target: string) => boolean;
222
+ };
223
+
224
+ // (No @packageDocumentation comment for this package)
225
+
226
+ ```