@atlaskit/onboarding 10.5.4 → 10.6.0
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 +11 -0
- package/dist/cjs/components/clone.js +1 -0
- package/dist/cjs/components/modal.js +8 -8
- package/dist/cjs/components/spotlight-card.js +18 -18
- package/dist/cjs/components/spotlight-dialog.js +1 -1
- package/dist/cjs/styled/blanket.js +3 -3
- package/dist/cjs/styled/dialog.js +7 -7
- package/dist/cjs/styled/modal.js +14 -14
- package/dist/cjs/styled/target.js +9 -9
- package/dist/cjs/version.json +1 -1
- package/dist/es2019/components/clone.js +1 -0
- package/dist/es2019/components/modal.js +1 -1
- package/dist/es2019/components/spotlight-card.js +1 -1
- package/dist/es2019/components/spotlight-dialog.js +1 -1
- package/dist/es2019/styled/blanket.js +1 -1
- package/dist/es2019/styled/dialog.js +1 -1
- package/dist/es2019/styled/modal.js +1 -1
- package/dist/es2019/styled/target.js +1 -1
- package/dist/es2019/version.json +1 -1
- package/dist/esm/components/clone.js +1 -0
- package/dist/esm/components/modal.js +1 -1
- package/dist/esm/components/spotlight-card.js +1 -1
- package/dist/esm/components/spotlight-dialog.js +1 -1
- package/dist/esm/styled/blanket.js +1 -1
- package/dist/esm/styled/dialog.js +1 -1
- package/dist/esm/styled/modal.js +1 -1
- package/dist/esm/styled/target.js +1 -1
- package/dist/esm/version.json +1 -1
- package/dist/types/components/modal.d.ts +4 -3
- package/dist/types/components/spotlight-dialog.d.ts +1 -1
- package/dist/types-ts4.0/components/modal.d.ts +4 -3
- package/dist/types-ts4.0/components/spotlight-dialog.d.ts +1 -1
- package/package.json +5 -5
- package/report.api.md +68 -34
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
# @atlaskit/onboarding
|
|
2
2
|
|
|
3
|
+
## 10.6.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`e0015d4e201`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e0015d4e201) - Updates `@emotion/core` to `@emotion/react`; v10 to v11. There is no expected behavior change.
|
|
8
|
+
|
|
9
|
+
### Patch Changes
|
|
10
|
+
|
|
11
|
+
- [`05efb20bca8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/05efb20bca8) - Fixes an issue with the Spotlight target element height when this is determined by a parent element.
|
|
12
|
+
- Updated dependencies
|
|
13
|
+
|
|
3
14
|
## 10.5.4
|
|
4
15
|
|
|
5
16
|
### Patch Changes
|
|
@@ -29,7 +29,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
|
|
|
29
29
|
|
|
30
30
|
var _react = require("react");
|
|
31
31
|
|
|
32
|
-
var
|
|
32
|
+
var _react2 = require("@emotion/react");
|
|
33
33
|
|
|
34
34
|
var _customThemeButton = _interopRequireWildcard(require("@atlaskit/button/custom-theme-button"));
|
|
35
35
|
|
|
@@ -79,7 +79,7 @@ var BenefitsModal = /*#__PURE__*/function (_Component) {
|
|
|
79
79
|
src = props.image;
|
|
80
80
|
|
|
81
81
|
var ImageElement = function ImageElement() {
|
|
82
|
-
return (0,
|
|
82
|
+
return (0, _react2.jsx)(_modal.ModalImage, {
|
|
83
83
|
src: src,
|
|
84
84
|
alt: ""
|
|
85
85
|
});
|
|
@@ -94,18 +94,18 @@ var BenefitsModal = /*#__PURE__*/function (_Component) {
|
|
|
94
94
|
experimental_shouldShowPrimaryButtonOnRight = _props$experimental_s === void 0 ? false : _props$experimental_s;
|
|
95
95
|
|
|
96
96
|
var ActionsElement = function ActionsElement() {
|
|
97
|
-
return actionList ? (0,
|
|
97
|
+
return actionList ? (0, _react2.jsx)(_customThemeButton.Theme.Provider, {
|
|
98
98
|
value: _theme.modalButtonTheme
|
|
99
|
-
}, (0,
|
|
99
|
+
}, (0, _react2.jsx)(_modal.ModalActionContainer, {
|
|
100
100
|
shouldReverseButtonOrder: experimental_shouldShowPrimaryButtonOnRight
|
|
101
101
|
}, actionList.map(function (_ref, idx) {
|
|
102
102
|
var text = _ref.text,
|
|
103
103
|
key = _ref.key,
|
|
104
104
|
rest = (0, _objectWithoutProperties2.default)(_ref, _excluded);
|
|
105
105
|
var variant = idx ? 'subtle-link' : 'primary';
|
|
106
|
-
return (0,
|
|
106
|
+
return (0, _react2.jsx)(_modal.ModalActionItem, {
|
|
107
107
|
key: key || (typeof text === 'string' ? text : "".concat(idx))
|
|
108
|
-
}, (0,
|
|
108
|
+
}, (0, _react2.jsx)(_customThemeButton.default, (0, _extends2.default)({
|
|
109
109
|
appearance: variant,
|
|
110
110
|
autoFocus: !idx
|
|
111
111
|
}, rest), text));
|
|
@@ -127,12 +127,12 @@ var BenefitsModal = /*#__PURE__*/function (_Component) {
|
|
|
127
127
|
props = (0, _objectWithoutProperties2.default)(_this$props, _excluded2);
|
|
128
128
|
var Header = this.headerComponent(this.props);
|
|
129
129
|
var Footer = this.footerComponent(this.props);
|
|
130
|
-
return (0,
|
|
130
|
+
return (0, _react2.jsx)(_modalDialog.default, (0, _extends2.default)({
|
|
131
131
|
autoFocus: true,
|
|
132
132
|
shouldScrollInViewport: true,
|
|
133
133
|
shouldCloseOnOverlayClick: false,
|
|
134
134
|
shouldCloseOnEscapePress: false
|
|
135
|
-
}, props), (0,
|
|
135
|
+
}, props), (0, _react2.jsx)(Header, null), (0, _react2.jsx)(_modalDialog.ModalBody, null, (0, _react2.jsx)(_modal.ModalBody, null, heading && (0, _react2.jsx)(_modal.ModalHeading, null, heading), children)), (0, _react2.jsx)(Footer, null));
|
|
136
136
|
}
|
|
137
137
|
}]);
|
|
138
138
|
return BenefitsModal;
|
|
@@ -13,7 +13,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
|
|
|
13
13
|
|
|
14
14
|
var _react = _interopRequireWildcard(require("react"));
|
|
15
15
|
|
|
16
|
-
var
|
|
16
|
+
var _react2 = require("@emotion/react");
|
|
17
17
|
|
|
18
18
|
var _customThemeButton = _interopRequireWildcard(require("@atlaskit/button/custom-theme-button"));
|
|
19
19
|
|
|
@@ -36,12 +36,12 @@ function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "functio
|
|
|
36
36
|
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
37
37
|
|
|
38
38
|
var gridSize = (0, _constants.gridSize)();
|
|
39
|
-
var bodyStyles = (0,
|
|
39
|
+
var bodyStyles = (0, _react2.css)({
|
|
40
40
|
display: 'flex',
|
|
41
41
|
padding: "".concat(gridSize * 2, "px ").concat(gridSize * 2.5, "px"),
|
|
42
42
|
flexDirection: 'column'
|
|
43
43
|
});
|
|
44
|
-
var defaultHeaderStyles = (0,
|
|
44
|
+
var defaultHeaderStyles = (0, _react2.css)({
|
|
45
45
|
display: 'flex',
|
|
46
46
|
paddingBottom: "".concat(gridSize, "px"),
|
|
47
47
|
alignItems: 'baseline',
|
|
@@ -50,12 +50,12 @@ var defaultHeaderStyles = (0, _core.css)({
|
|
|
50
50
|
|
|
51
51
|
var DefaultHeader = function DefaultHeader(_ref) {
|
|
52
52
|
var children = _ref.children;
|
|
53
|
-
return (0,
|
|
53
|
+
return (0, _react2.jsx)("div", {
|
|
54
54
|
css: defaultHeaderStyles
|
|
55
55
|
}, children);
|
|
56
56
|
};
|
|
57
57
|
|
|
58
|
-
var defaultFooterStyles = (0,
|
|
58
|
+
var defaultFooterStyles = (0, _react2.css)({
|
|
59
59
|
display: 'flex',
|
|
60
60
|
paddingTop: "".concat(gridSize, "px"),
|
|
61
61
|
alignItems: 'center',
|
|
@@ -64,12 +64,12 @@ var defaultFooterStyles = (0, _core.css)({
|
|
|
64
64
|
|
|
65
65
|
var DefaultFooter = function DefaultFooter(_ref2) {
|
|
66
66
|
var children = _ref2.children;
|
|
67
|
-
return (0,
|
|
67
|
+
return (0, _react2.jsx)("div", {
|
|
68
68
|
css: defaultFooterStyles
|
|
69
69
|
}, children);
|
|
70
70
|
};
|
|
71
71
|
|
|
72
|
-
var containerStyles = (0,
|
|
72
|
+
var containerStyles = (0, _react2.css)({
|
|
73
73
|
height: 'fit-content',
|
|
74
74
|
zIndex: _constants.layers.spotlight() + 1,
|
|
75
75
|
background: "var(--ds-background-discovery-bold, ".concat(_colors.P300, ")"),
|
|
@@ -77,7 +77,7 @@ var containerStyles = (0, _core.css)({
|
|
|
77
77
|
color: "var(--ds-text-inverse, ".concat(_colors.N0, ")"),
|
|
78
78
|
overflow: 'auto'
|
|
79
79
|
});
|
|
80
|
-
var containerShadowStyles = (0,
|
|
80
|
+
var containerShadowStyles = (0, _react2.css)({
|
|
81
81
|
boxShadow: "var(--ds-shadow-raised, ".concat("0 4px 8px -2px ".concat(_colors.N50A, ", 0 0 1px ").concat(_colors.N60A), ")")
|
|
82
82
|
});
|
|
83
83
|
/**
|
|
@@ -122,13 +122,13 @@ var SpotlightCard = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
|
|
|
122
122
|
Header = _components$Header === void 0 ? DefaultHeader : _components$Header,
|
|
123
123
|
_components$Footer = components.Footer,
|
|
124
124
|
Footer = _components$Footer === void 0 ? DefaultFooter : _components$Footer;
|
|
125
|
-
return (0,
|
|
125
|
+
return (0, _react2.jsx)(_customThemeButton.Theme.Provider, {
|
|
126
126
|
value: _theme.spotlightButtonTheme
|
|
127
|
-
}, (0,
|
|
127
|
+
}, (0, _react2.jsx)(Theme.Provider, {
|
|
128
128
|
value: theme
|
|
129
|
-
}, (0,
|
|
129
|
+
}, (0, _react2.jsx)(Theme.Consumer, null, function (_ref3) {
|
|
130
130
|
var container = _ref3.container;
|
|
131
|
-
return (0,
|
|
131
|
+
return (0, _react2.jsx)("div", {
|
|
132
132
|
css: [containerStyles, !isFlat && containerShadowStyles, // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
|
|
133
133
|
container],
|
|
134
134
|
style: {
|
|
@@ -136,22 +136,22 @@ var SpotlightCard = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
|
|
|
136
136
|
},
|
|
137
137
|
ref: ref || innerRef,
|
|
138
138
|
"data-testid": testId
|
|
139
|
-
}, typeof image === 'string' ? (0,
|
|
139
|
+
}, typeof image === 'string' ? (0, _react2.jsx)("img", {
|
|
140
140
|
src: image,
|
|
141
141
|
alt: ""
|
|
142
|
-
}) : image, (0,
|
|
142
|
+
}) : image, (0, _react2.jsx)("div", {
|
|
143
143
|
css: bodyStyles
|
|
144
|
-
}, heading || headingAfterElement ? (0,
|
|
144
|
+
}, heading || headingAfterElement ? (0, _react2.jsx)(Header, null, (0, _react2.jsx)(_heading.default, {
|
|
145
145
|
color: "inverse",
|
|
146
146
|
level: "h600",
|
|
147
147
|
as: "h4"
|
|
148
|
-
}, heading), headingAfterElement) : null, children, actions.length > 0 || actionsBeforeElement ? (0,
|
|
148
|
+
}, heading), headingAfterElement) : null, children, actions.length > 0 || actionsBeforeElement ? (0, _react2.jsx)(Footer, null, actionsBeforeElement || (0, _react2.jsx)("span", null), (0, _react2.jsx)(_dialog.DialogActionItemContainer, null, actions.map(function (_ref4, idx) {
|
|
149
149
|
var text = _ref4.text,
|
|
150
150
|
key = _ref4.key,
|
|
151
151
|
rest = (0, _objectWithoutProperties2.default)(_ref4, _excluded);
|
|
152
|
-
return (0,
|
|
152
|
+
return (0, _react2.jsx)(_dialog.DialogActionItem, {
|
|
153
153
|
key: key || (typeof text === 'string' ? text : "".concat(idx))
|
|
154
|
-
}, (0,
|
|
154
|
+
}, (0, _react2.jsx)(_customThemeButton.default, rest, text));
|
|
155
155
|
}))) : null));
|
|
156
156
|
})));
|
|
157
157
|
});
|
|
@@ -50,7 +50,7 @@ function _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflec
|
|
|
50
50
|
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; } }
|
|
51
51
|
|
|
52
52
|
var packageName = "@atlaskit/onboarding";
|
|
53
|
-
var packageVersion = "10.
|
|
53
|
+
var packageVersion = "10.6.0";
|
|
54
54
|
|
|
55
55
|
var SpotlightDialog = /*#__PURE__*/function (_Component) {
|
|
56
56
|
(0, _inherits2.default)(SpotlightDialog, _Component);
|
|
@@ -9,7 +9,7 @@ exports.default = void 0;
|
|
|
9
9
|
|
|
10
10
|
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
|
|
11
11
|
|
|
12
|
-
var
|
|
12
|
+
var _react = require("@emotion/react");
|
|
13
13
|
|
|
14
14
|
var _colors = require("@atlaskit/theme/colors");
|
|
15
15
|
|
|
@@ -27,7 +27,7 @@ var backgroundColor = (0, _components.themed)({
|
|
|
27
27
|
}); // IE11 and Edge: z-index needed because fixed position calculates z-index relative
|
|
28
28
|
// to body instead of nearest stacking context (Portal in our case).
|
|
29
29
|
|
|
30
|
-
var blanketStyles = (0,
|
|
30
|
+
var blanketStyles = (0, _react.css)({
|
|
31
31
|
position: 'fixed',
|
|
32
32
|
zIndex: _constants.layers.spotlight(),
|
|
33
33
|
top: 0,
|
|
@@ -50,7 +50,7 @@ var blanketStyles = (0, _core.css)({
|
|
|
50
50
|
*/
|
|
51
51
|
var Blanket = function Blanket(props) {
|
|
52
52
|
var theme = (0, _components.useGlobalTheme)();
|
|
53
|
-
return (0,
|
|
53
|
+
return (0, _react.jsx)("div", {
|
|
54
54
|
css: blanketStyles,
|
|
55
55
|
style: _objectSpread(_objectSpread({}, props.style), {}, {
|
|
56
56
|
backgroundColor: props.isTinted ? backgroundColor({
|
|
@@ -11,17 +11,17 @@ var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends")
|
|
|
11
11
|
|
|
12
12
|
var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
|
|
13
13
|
|
|
14
|
-
var
|
|
14
|
+
var _react = require("@emotion/react");
|
|
15
15
|
|
|
16
16
|
var _constants = require("@atlaskit/theme/constants");
|
|
17
17
|
|
|
18
18
|
var _excluded = ["alt"];
|
|
19
19
|
var gridSize = (0, _constants.gridSize)();
|
|
20
|
-
var imageStyles = (0,
|
|
20
|
+
var imageStyles = (0, _react.css)({
|
|
21
21
|
maxWidth: '100%',
|
|
22
22
|
height: 'auto'
|
|
23
23
|
});
|
|
24
|
-
var actionItemContainerStyles = (0,
|
|
24
|
+
var actionItemContainerStyles = (0, _react.css)({
|
|
25
25
|
display: 'flex',
|
|
26
26
|
margin: "0 -".concat(gridSize / 2, "px"),
|
|
27
27
|
|
|
@@ -29,7 +29,7 @@ var actionItemContainerStyles = (0, _core.css)({
|
|
|
29
29
|
right, but keep it's position as the first focusable element in the DOM */
|
|
30
30
|
flexDirection: 'row-reverse'
|
|
31
31
|
});
|
|
32
|
-
var actionItemStyles = (0,
|
|
32
|
+
var actionItemStyles = (0, _react.css)({
|
|
33
33
|
margin: "0 ".concat(gridSize / 2, "px")
|
|
34
34
|
});
|
|
35
35
|
/**
|
|
@@ -43,7 +43,7 @@ var actionItemStyles = (0, _core.css)({
|
|
|
43
43
|
var DialogImage = function DialogImage(_ref) {
|
|
44
44
|
var alt = _ref.alt,
|
|
45
45
|
props = (0, _objectWithoutProperties2.default)(_ref, _excluded);
|
|
46
|
-
return (0,
|
|
46
|
+
return (0, _react.jsx)("img", (0, _extends2.default)({
|
|
47
47
|
css: imageStyles,
|
|
48
48
|
alt: alt
|
|
49
49
|
}, props));
|
|
@@ -61,7 +61,7 @@ exports.DialogImage = DialogImage;
|
|
|
61
61
|
|
|
62
62
|
var DialogActionItemContainer = function DialogActionItemContainer(_ref2) {
|
|
63
63
|
var children = _ref2.children;
|
|
64
|
-
return (0,
|
|
64
|
+
return (0, _react.jsx)("div", {
|
|
65
65
|
css: actionItemContainerStyles
|
|
66
66
|
}, children);
|
|
67
67
|
};
|
|
@@ -78,7 +78,7 @@ exports.DialogActionItemContainer = DialogActionItemContainer;
|
|
|
78
78
|
|
|
79
79
|
var DialogActionItem = function DialogActionItem(_ref3) {
|
|
80
80
|
var children = _ref3.children;
|
|
81
|
-
return (0,
|
|
81
|
+
return (0, _react.jsx)("div", {
|
|
82
82
|
css: actionItemStyles
|
|
83
83
|
}, children);
|
|
84
84
|
};
|
package/dist/cjs/styled/modal.js
CHANGED
|
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.ModalImage = exports.ModalHeading = exports.ModalBody = exports.ModalActionItem = exports.ModalActionContainer = void 0;
|
|
7
7
|
|
|
8
|
-
var
|
|
8
|
+
var _react = require("@emotion/react");
|
|
9
9
|
|
|
10
10
|
var _components = require("@atlaskit/theme/components");
|
|
11
11
|
|
|
@@ -18,27 +18,27 @@ var gridSize = (0, _constants.gridSize)();
|
|
|
18
18
|
var borderRadius = (0, _constants.borderRadius)();
|
|
19
19
|
var actionItemBottomMargin = gridSize / 2; // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
|
|
20
20
|
|
|
21
|
-
var lightH600Styles = (0,
|
|
21
|
+
var lightH600Styles = (0, _react.css)((0, _typography.h600)({
|
|
22
22
|
theme: {
|
|
23
23
|
mode: 'light'
|
|
24
24
|
}
|
|
25
25
|
})); // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
|
|
26
26
|
|
|
27
|
-
var darkH600Styles = (0,
|
|
27
|
+
var darkH600Styles = (0, _react.css)((0, _typography.h600)({
|
|
28
28
|
theme: {
|
|
29
29
|
mode: 'dark'
|
|
30
30
|
}
|
|
31
31
|
}));
|
|
32
|
-
var modalBodyStyles = (0,
|
|
32
|
+
var modalBodyStyles = (0, _react.css)({
|
|
33
33
|
padding: '40px 20px',
|
|
34
34
|
textAlign: 'center'
|
|
35
35
|
}); // eslint-disable-next-line @repo/internal/react/consistent-css-prop-usage
|
|
36
36
|
|
|
37
|
-
var modalHeadingStyles = (0,
|
|
37
|
+
var modalHeadingStyles = (0, _react.css)({
|
|
38
38
|
marginBottom: "".concat(gridSize, "px"),
|
|
39
39
|
color: 'inherit'
|
|
40
40
|
});
|
|
41
|
-
var modalImageStyles = (0,
|
|
41
|
+
var modalImageStyles = (0, _react.css)({
|
|
42
42
|
width: '100%',
|
|
43
43
|
height: 'auto',
|
|
44
44
|
borderTopLeftRadius: "".concat(borderRadius, "px"),
|
|
@@ -47,17 +47,17 @@ var modalImageStyles = (0, _core.css)({
|
|
|
47
47
|
borderRadius: 0
|
|
48
48
|
}
|
|
49
49
|
});
|
|
50
|
-
var modalActionContainerStyles = (0,
|
|
50
|
+
var modalActionContainerStyles = (0, _react.css)({
|
|
51
51
|
display: 'flex',
|
|
52
52
|
padding: "0 40px ".concat(40 - actionItemBottomMargin, "px"),
|
|
53
53
|
justifyContent: 'center',
|
|
54
54
|
flexDirection: 'row',
|
|
55
55
|
flexFlow: 'wrap'
|
|
56
56
|
});
|
|
57
|
-
var modalActionContainerReversedStyles = (0,
|
|
57
|
+
var modalActionContainerReversedStyles = (0, _react.css)({
|
|
58
58
|
flexDirection: 'row-reverse'
|
|
59
59
|
});
|
|
60
|
-
var modalActionItemStyles = (0,
|
|
60
|
+
var modalActionItemStyles = (0, _react.css)({
|
|
61
61
|
margin: "0 ".concat(gridSize / 2, "px ").concat(actionItemBottomMargin, "px")
|
|
62
62
|
});
|
|
63
63
|
/**
|
|
@@ -68,7 +68,7 @@ var modalActionItemStyles = (0, _core.css)({
|
|
|
68
68
|
|
|
69
69
|
var ModalBody = function ModalBody(_ref) {
|
|
70
70
|
var children = _ref.children;
|
|
71
|
-
return (0,
|
|
71
|
+
return (0, _react.jsx)("div", {
|
|
72
72
|
css: modalBodyStyles
|
|
73
73
|
}, children);
|
|
74
74
|
};
|
|
@@ -87,7 +87,7 @@ var ModalHeading = function ModalHeading(_ref2) {
|
|
|
87
87
|
var _useGlobalTheme = (0, _components.useGlobalTheme)(),
|
|
88
88
|
mode = _useGlobalTheme.mode;
|
|
89
89
|
|
|
90
|
-
return (0,
|
|
90
|
+
return (0, _react.jsx)("h4", {
|
|
91
91
|
css: [mode === 'light' ? lightH600Styles : darkH600Styles, modalHeadingStyles]
|
|
92
92
|
}, children);
|
|
93
93
|
};
|
|
@@ -103,7 +103,7 @@ exports.ModalHeading = ModalHeading;
|
|
|
103
103
|
var ModalImage = function ModalImage(_ref3) {
|
|
104
104
|
var alt = _ref3.alt,
|
|
105
105
|
src = _ref3.src;
|
|
106
|
-
return (0,
|
|
106
|
+
return (0, _react.jsx)("img", {
|
|
107
107
|
css: modalImageStyles,
|
|
108
108
|
alt: alt,
|
|
109
109
|
src: src
|
|
@@ -121,7 +121,7 @@ exports.ModalImage = ModalImage;
|
|
|
121
121
|
var ModalActionContainer = function ModalActionContainer(_ref4) {
|
|
122
122
|
var children = _ref4.children,
|
|
123
123
|
shouldReverseButtonOrder = _ref4.shouldReverseButtonOrder;
|
|
124
|
-
return (0,
|
|
124
|
+
return (0, _react.jsx)("div", {
|
|
125
125
|
css: [modalActionContainerStyles, shouldReverseButtonOrder && modalActionContainerReversedStyles]
|
|
126
126
|
}, children);
|
|
127
127
|
};
|
|
@@ -136,7 +136,7 @@ exports.ModalActionContainer = ModalActionContainer;
|
|
|
136
136
|
|
|
137
137
|
var ModalActionItem = function ModalActionItem(_ref5) {
|
|
138
138
|
var children = _ref5.children;
|
|
139
|
-
return (0,
|
|
139
|
+
return (0, _react.jsx)("div", {
|
|
140
140
|
css: modalActionItemStyles
|
|
141
141
|
}, children);
|
|
142
142
|
};
|
|
@@ -13,7 +13,7 @@ var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/de
|
|
|
13
13
|
|
|
14
14
|
var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/helpers/objectWithoutProperties"));
|
|
15
15
|
|
|
16
|
-
var
|
|
16
|
+
var _react = require("@emotion/react");
|
|
17
17
|
|
|
18
18
|
var _colors = require("@atlaskit/theme/colors");
|
|
19
19
|
|
|
@@ -31,7 +31,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
|
|
|
31
31
|
// Pulse color "rgb(101, 84, 192)" derived from "colors.P300"
|
|
32
32
|
var baseShadow = "0 0 0 2px ".concat("var(--ds-border-discovery, ".concat(_colors.P300, ")"));
|
|
33
33
|
var easing = 'cubic-bezier(0.55, 0.055, 0.675, 0.19)';
|
|
34
|
-
var pulseKeyframes = (0,
|
|
34
|
+
var pulseKeyframes = (0, _react.keyframes)({
|
|
35
35
|
'0%, 33%': {
|
|
36
36
|
boxShadow: "".concat(baseShadow, ", 0 0 0 ", "var(--ds-border-discovery, rgba(101, 84, 192, 1))")
|
|
37
37
|
},
|
|
@@ -42,12 +42,12 @@ var pulseKeyframes = (0, _core.keyframes)({
|
|
|
42
42
|
|
|
43
43
|
var pulseKeyframesName = pulseKeyframes.name;
|
|
44
44
|
exports.pulseKeyframesName = pulseKeyframesName;
|
|
45
|
-
var animationStyles = (0,
|
|
45
|
+
var animationStyles = (0, _react.css)({
|
|
46
46
|
animation: "".concat(pulseKeyframes, " 3000ms ").concat(easing, " infinite")
|
|
47
47
|
}); // IE11 and Edge: z-index needed because fixed position calculates z-index relative
|
|
48
48
|
// to body instead of nearest stacking context (Portal in our case).
|
|
49
49
|
|
|
50
|
-
var baseStyles = (0,
|
|
50
|
+
var baseStyles = (0, _react.css)({
|
|
51
51
|
zIndex: _constants.layers.spotlight() + 1
|
|
52
52
|
});
|
|
53
53
|
|
|
@@ -58,7 +58,7 @@ var Base = function Base(_ref) {
|
|
|
58
58
|
style = _ref.style,
|
|
59
59
|
testId = _ref.testId,
|
|
60
60
|
props = (0, _objectWithoutProperties2.default)(_ref, _excluded);
|
|
61
|
-
return (0,
|
|
61
|
+
return (0, _react.jsx)("div", (0, _extends2.default)({
|
|
62
62
|
css: baseStyles,
|
|
63
63
|
"data-testid": testId,
|
|
64
64
|
style: _objectSpread(_objectSpread({}, style), {}, {
|
|
@@ -82,14 +82,14 @@ var TargetInner = function TargetInner(_ref2) {
|
|
|
82
82
|
pulse = _ref2.pulse,
|
|
83
83
|
props = (0, _objectWithoutProperties2.default)(_ref2, _excluded2);
|
|
84
84
|
return (// eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
|
|
85
|
-
(0,
|
|
85
|
+
(0, _react.jsx)(Base, (0, _extends2.default)({}, props, {
|
|
86
86
|
css: [pulse && animationStyles]
|
|
87
87
|
}), children)
|
|
88
88
|
);
|
|
89
89
|
};
|
|
90
90
|
|
|
91
91
|
exports.TargetInner = TargetInner;
|
|
92
|
-
var targetOverlayStyles = (0,
|
|
92
|
+
var targetOverlayStyles = (0, _react.css)({
|
|
93
93
|
width: '100%',
|
|
94
94
|
height: '100%',
|
|
95
95
|
position: 'absolute',
|
|
@@ -106,7 +106,7 @@ var targetOverlayStyles = (0, _core.css)({
|
|
|
106
106
|
*/
|
|
107
107
|
|
|
108
108
|
var TargetOverlay = function TargetOverlay(props) {
|
|
109
|
-
return (0,
|
|
109
|
+
return (0, _react.jsx)("div", (0, _extends2.default)({}, props, {
|
|
110
110
|
css: targetOverlayStyles,
|
|
111
111
|
style: {
|
|
112
112
|
cursor: props.onClick ? 'pointer' : 'auto'
|
|
@@ -133,7 +133,7 @@ var Pulse = function Pulse(_ref3) {
|
|
|
133
133
|
testId = _ref3.testId,
|
|
134
134
|
props = (0, _objectWithoutProperties2.default)(_ref3, _excluded3);
|
|
135
135
|
return (// eslint-disable-next-line @repo/internal/react/no-unsafe-spread-props
|
|
136
|
-
(0,
|
|
136
|
+
(0, _react.jsx)(Base, (0, _extends2.default)({}, props, {
|
|
137
137
|
css: [pulse && animationStyles],
|
|
138
138
|
testId: testId
|
|
139
139
|
}), children)
|
package/dist/cjs/version.json
CHANGED
|
@@ -3,7 +3,7 @@ import _defineProperty from "@babel/runtime/helpers/defineProperty";
|
|
|
3
3
|
|
|
4
4
|
/** @jsx jsx */
|
|
5
5
|
import { Component } from 'react';
|
|
6
|
-
import { jsx } from '@emotion/
|
|
6
|
+
import { jsx } from '@emotion/react';
|
|
7
7
|
import Button, { Theme as ButtonTheme } from '@atlaskit/button/custom-theme-button';
|
|
8
8
|
import Modal, { ModalBody } from '@atlaskit/modal-dialog';
|
|
9
9
|
import { ModalBody as Body, ModalHeading as Heading, ModalActionContainer, ModalActionItem, ModalImage } from '../styled/modal';
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import React, { forwardRef } from 'react';
|
|
3
|
-
import { css, jsx } from '@emotion/
|
|
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';
|
|
6
6
|
import { N0, N50A, N60A, P300 } from '@atlaskit/theme/colors';
|
|
@@ -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.
|
|
10
|
+
const packageVersion = "10.6.0";
|
|
11
11
|
|
|
12
12
|
class SpotlightDialog extends Component {
|
|
13
13
|
constructor(...args) {
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
|
-
import { css, jsx } from '@emotion/
|
|
2
|
+
import { css, jsx } from '@emotion/react';
|
|
3
3
|
import { DN90A, N100A } from '@atlaskit/theme/colors';
|
|
4
4
|
import { themed, useGlobalTheme } from '@atlaskit/theme/components';
|
|
5
5
|
import { layers } from '@atlaskit/theme/constants';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import _extends from "@babel/runtime/helpers/extends";
|
|
2
2
|
|
|
3
3
|
/** @jsx jsx */
|
|
4
|
-
import { css, jsx } from '@emotion/
|
|
4
|
+
import { css, jsx } from '@emotion/react';
|
|
5
5
|
import { gridSize as getGridSize } from '@atlaskit/theme/constants';
|
|
6
6
|
const gridSize = getGridSize();
|
|
7
7
|
const imageStyles = css({
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
|
-
import { css, jsx } from '@emotion/
|
|
2
|
+
import { css, jsx } from '@emotion/react';
|
|
3
3
|
import { useGlobalTheme } from '@atlaskit/theme/components';
|
|
4
4
|
import { borderRadius as getBorderRadius, gridSize as getGridSize } from '@atlaskit/theme/constants';
|
|
5
5
|
import { h600 } from '@atlaskit/theme/typography';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import _extends from "@babel/runtime/helpers/extends";
|
|
2
2
|
|
|
3
3
|
/** @jsx jsx */
|
|
4
|
-
import { css, jsx, keyframes } from '@emotion/
|
|
4
|
+
import { css, jsx, keyframes } from '@emotion/react';
|
|
5
5
|
import { P300 } from '@atlaskit/theme/colors';
|
|
6
6
|
import { layers } from '@atlaskit/theme/constants';
|
|
7
7
|
// NOTE:
|
package/dist/es2019/version.json
CHANGED
|
@@ -16,7 +16,7 @@ function _isNativeReflectConstruct() { if (typeof Reflect === "undefined" || !Re
|
|
|
16
16
|
|
|
17
17
|
/** @jsx jsx */
|
|
18
18
|
import { Component } from 'react';
|
|
19
|
-
import { jsx } from '@emotion/
|
|
19
|
+
import { jsx } from '@emotion/react';
|
|
20
20
|
import Button, { Theme as ButtonTheme } from '@atlaskit/button/custom-theme-button';
|
|
21
21
|
import Modal, { ModalBody } from '@atlaskit/modal-dialog';
|
|
22
22
|
import { ModalBody as Body, ModalHeading as Heading, ModalActionContainer, ModalActionItem, ModalImage } from '../styled/modal';
|
|
@@ -3,7 +3,7 @@ var _excluded = ["text", "key"];
|
|
|
3
3
|
|
|
4
4
|
/** @jsx jsx */
|
|
5
5
|
import React, { forwardRef } from 'react';
|
|
6
|
-
import { css, jsx } from '@emotion/
|
|
6
|
+
import { css, jsx } from '@emotion/react';
|
|
7
7
|
import Button, { Theme as ButtonTheme } from '@atlaskit/button/custom-theme-button';
|
|
8
8
|
import Heading from '@atlaskit/heading';
|
|
9
9
|
import { N0, N50A, N60A, P300 } from '@atlaskit/theme/colors';
|
|
@@ -22,7 +22,7 @@ import { DialogImage } from '../styled/dialog';
|
|
|
22
22
|
import SpotlightCard from './spotlight-card';
|
|
23
23
|
import ValueChanged from './value-changed';
|
|
24
24
|
var packageName = "@atlaskit/onboarding";
|
|
25
|
-
var packageVersion = "10.
|
|
25
|
+
var packageVersion = "10.6.0";
|
|
26
26
|
|
|
27
27
|
var SpotlightDialog = /*#__PURE__*/function (_Component) {
|
|
28
28
|
_inherits(SpotlightDialog, _Component);
|
|
@@ -5,7 +5,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
|
|
|
5
5
|
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
6
6
|
|
|
7
7
|
/** @jsx jsx */
|
|
8
|
-
import { css, jsx } from '@emotion/
|
|
8
|
+
import { css, jsx } from '@emotion/react';
|
|
9
9
|
import { DN90A, N100A } from '@atlaskit/theme/colors';
|
|
10
10
|
import { themed, useGlobalTheme } from '@atlaskit/theme/components';
|
|
11
11
|
import { layers } from '@atlaskit/theme/constants';
|
|
@@ -3,7 +3,7 @@ import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProper
|
|
|
3
3
|
var _excluded = ["alt"];
|
|
4
4
|
|
|
5
5
|
/** @jsx jsx */
|
|
6
|
-
import { css, jsx } from '@emotion/
|
|
6
|
+
import { css, jsx } from '@emotion/react';
|
|
7
7
|
import { gridSize as getGridSize } from '@atlaskit/theme/constants';
|
|
8
8
|
var gridSize = getGridSize();
|
|
9
9
|
var imageStyles = css({
|
package/dist/esm/styled/modal.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
|
-
import { css, jsx } from '@emotion/
|
|
2
|
+
import { css, jsx } from '@emotion/react';
|
|
3
3
|
import { useGlobalTheme } from '@atlaskit/theme/components';
|
|
4
4
|
import { borderRadius as getBorderRadius, gridSize as getGridSize } from '@atlaskit/theme/constants';
|
|
5
5
|
import { h600 } from '@atlaskit/theme/typography';
|
|
@@ -10,7 +10,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
|
|
|
10
10
|
function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
|
|
11
11
|
|
|
12
12
|
/** @jsx jsx */
|
|
13
|
-
import { css, jsx, keyframes } from '@emotion/
|
|
13
|
+
import { css, jsx, keyframes } from '@emotion/react';
|
|
14
14
|
import { P300 } from '@atlaskit/theme/colors';
|
|
15
15
|
import { layers } from '@atlaskit/theme/constants';
|
|
16
16
|
// NOTE:
|
package/dist/esm/version.json
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import { Component, ElementType, ReactNode } from 'react';
|
|
3
|
+
import { jsx } from '@emotion/react';
|
|
3
4
|
import { ModalFooterProps as FooterComponentProps, ModalHeaderProps as HeaderComponentProps } from '@atlaskit/modal-dialog';
|
|
4
5
|
import { Actions } from '../types';
|
|
5
6
|
declare type ModalProps = {
|
|
@@ -42,8 +43,8 @@ declare type ModalProps = {
|
|
|
42
43
|
* - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
|
|
43
44
|
*/
|
|
44
45
|
export default class BenefitsModal extends Component<ModalProps> {
|
|
45
|
-
headerComponent: (props: ModalProps) => ElementType<HeaderComponentProps> | (() => JSX.Element);
|
|
46
|
-
footerComponent: (props: ModalProps) => ElementType<FooterComponentProps> | (() => JSX.Element | null);
|
|
47
|
-
render(): JSX.Element;
|
|
46
|
+
headerComponent: (props: ModalProps) => ElementType<HeaderComponentProps> | (() => jsx.JSX.Element);
|
|
47
|
+
footerComponent: (props: ModalProps) => ElementType<FooterComponentProps> | (() => jsx.JSX.Element | null);
|
|
48
|
+
render(): jsx.JSX.Element;
|
|
48
49
|
}
|
|
49
50
|
export {};
|
|
@@ -57,5 +57,5 @@ export interface SpotlightDialogProps extends WithAnalyticsEventsProps {
|
|
|
57
57
|
*/
|
|
58
58
|
testId?: string;
|
|
59
59
|
}
|
|
60
|
-
declare const _default: React.ForwardRefExoticComponent<Pick<Omit<SpotlightDialogProps, keyof WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "footer" | "header" | "image" | "
|
|
60
|
+
declare const _default: React.ForwardRefExoticComponent<Pick<Omit<SpotlightDialogProps, keyof WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "footer" | "header" | "image" | "key" | "testId" | "analyticsContext" | "actions" | "heading" | "targetNode" | "actionsBeforeElement" | "headingAfterElement" | "dialogPlacement" | "dialogWidth" | "animationStyles"> & React.RefAttributes<any>>;
|
|
61
61
|
export default _default;
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
/** @jsx jsx */
|
|
2
2
|
import { Component, ElementType, ReactNode } from 'react';
|
|
3
|
+
import { jsx } from '@emotion/react';
|
|
3
4
|
import { ModalFooterProps as FooterComponentProps, ModalHeaderProps as HeaderComponentProps } from '@atlaskit/modal-dialog';
|
|
4
5
|
import { Actions } from '../types';
|
|
5
6
|
declare type ModalProps = {
|
|
@@ -42,8 +43,8 @@ declare type ModalProps = {
|
|
|
42
43
|
* - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
|
|
43
44
|
*/
|
|
44
45
|
export default class BenefitsModal extends Component<ModalProps> {
|
|
45
|
-
headerComponent: (props: ModalProps) => ElementType<HeaderComponentProps> | (() => JSX.Element);
|
|
46
|
-
footerComponent: (props: ModalProps) => ElementType<FooterComponentProps> | (() => JSX.Element | null);
|
|
47
|
-
render(): JSX.Element;
|
|
46
|
+
headerComponent: (props: ModalProps) => ElementType<HeaderComponentProps> | (() => jsx.JSX.Element);
|
|
47
|
+
footerComponent: (props: ModalProps) => ElementType<FooterComponentProps> | (() => jsx.JSX.Element | null);
|
|
48
|
+
render(): jsx.JSX.Element;
|
|
48
49
|
}
|
|
49
50
|
export {};
|
|
@@ -57,5 +57,5 @@ export interface SpotlightDialogProps extends WithAnalyticsEventsProps {
|
|
|
57
57
|
*/
|
|
58
58
|
testId?: string;
|
|
59
59
|
}
|
|
60
|
-
declare const _default: React.ForwardRefExoticComponent<Pick<Omit<SpotlightDialogProps, keyof WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "footer" | "header" | "image" | "
|
|
60
|
+
declare const _default: React.ForwardRefExoticComponent<Pick<Omit<SpotlightDialogProps, keyof WithAnalyticsEventsProps> & React.RefAttributes<any> & import("@atlaskit/analytics-next").WithContextProps, "children" | "footer" | "header" | "image" | "key" | "testId" | "analyticsContext" | "actions" | "heading" | "targetNode" | "actionsBeforeElement" | "headingAfterElement" | "dialogPlacement" | "dialogWidth" | "animationStyles"> & React.RefAttributes<any>>;
|
|
61
61
|
export default _default;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/onboarding",
|
|
3
|
-
"version": "10.
|
|
3
|
+
"version": "10.6.0",
|
|
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/"
|
|
@@ -36,13 +36,13 @@
|
|
|
36
36
|
"@atlaskit/button": "^16.3.0",
|
|
37
37
|
"@atlaskit/ds-lib": "^2.1.0",
|
|
38
38
|
"@atlaskit/heading": "^0.1.14",
|
|
39
|
-
"@atlaskit/modal-dialog": "^12.
|
|
39
|
+
"@atlaskit/modal-dialog": "^12.4.0",
|
|
40
40
|
"@atlaskit/popper": "^5.0.0",
|
|
41
41
|
"@atlaskit/portal": "^4.0.0",
|
|
42
42
|
"@atlaskit/theme": "^12.2.0",
|
|
43
43
|
"@atlaskit/tokens": "^0.10.0",
|
|
44
44
|
"@babel/runtime": "^7.0.0",
|
|
45
|
-
"@emotion/
|
|
45
|
+
"@emotion/react": "^11.7.1",
|
|
46
46
|
"bind-event-listener": "^2.1.1",
|
|
47
47
|
"exenv": "^1.2.2",
|
|
48
48
|
"memoize-one": "^6.0.0",
|
|
@@ -57,9 +57,9 @@
|
|
|
57
57
|
"react-dom": "^16.8.0"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
|
-
"@atlaskit/avatar": "^21.
|
|
60
|
+
"@atlaskit/avatar": "^21.1.0",
|
|
61
61
|
"@atlaskit/docs": "*",
|
|
62
|
-
"@atlaskit/icon": "^21.
|
|
62
|
+
"@atlaskit/icon": "^21.11.0",
|
|
63
63
|
"@atlaskit/progress-indicator": "^9.3.0",
|
|
64
64
|
"@atlaskit/select": "^15.7.0",
|
|
65
65
|
"@atlaskit/ssr": "*",
|
package/report.api.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
## API Report File for "@atlaskit/onboarding"
|
|
1
|
+
## API Report File for "@atlaskit/onboarding".
|
|
2
2
|
|
|
3
|
-
> Do not edit this file.
|
|
3
|
+
> Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
[Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
4
6
|
|
|
5
7
|
```ts
|
|
6
8
|
/// <reference types="react" />
|
|
@@ -9,6 +11,7 @@ import { Component } from 'react';
|
|
|
9
11
|
import { ComponentType } from 'react';
|
|
10
12
|
import { CustomThemeButtonProps } from '@atlaskit/button/types';
|
|
11
13
|
import { ElementType } from 'react';
|
|
14
|
+
import { jsx } from '@emotion/react';
|
|
12
15
|
import { MemoizedFn } from 'memoize-one';
|
|
13
16
|
import { ModalFooterProps } from '@atlaskit/modal-dialog';
|
|
14
17
|
import { ModalHeaderProps } from '@atlaskit/modal-dialog';
|
|
@@ -34,28 +37,39 @@ declare type BaseProps = React.HTMLAttributes<HTMLDivElement> & {
|
|
|
34
37
|
testId?: string;
|
|
35
38
|
};
|
|
36
39
|
|
|
40
|
+
/**
|
|
41
|
+
* @deprecated
|
|
42
|
+
*/
|
|
37
43
|
declare interface CardTokens {
|
|
44
|
+
/**
|
|
45
|
+
* @deprecated
|
|
46
|
+
*/
|
|
38
47
|
container: Record<string, string | undefined>;
|
|
39
48
|
}
|
|
40
49
|
|
|
41
50
|
/**
|
|
42
|
-
*
|
|
51
|
+
* __Benefits modal__
|
|
43
52
|
*
|
|
44
|
-
*
|
|
45
|
-
* this component can be used to outline the benefits of the change to the user.
|
|
53
|
+
* A benefits modal explains the benefits of a significant new feature or experience change.
|
|
46
54
|
*
|
|
47
|
-
* - [Examples](https://
|
|
55
|
+
* - [Examples](https://atlassian.design/components/onboarding/benefits-modal/examples)
|
|
56
|
+
* - [Code](https://atlassian.design/components/onboarding/benefits-modal/code)
|
|
57
|
+
* - [Usage](https://atlassian.design/components/onboarding/benefits-modal/usage)
|
|
48
58
|
*/
|
|
49
59
|
export declare class Modal extends Component<ModalProps> {
|
|
50
60
|
headerComponent: (
|
|
51
61
|
props: ModalProps,
|
|
52
|
-
) => ElementType<ModalHeaderProps> | (() => JSX.Element);
|
|
62
|
+
) => ElementType<ModalHeaderProps> | (() => jsx.JSX.Element);
|
|
53
63
|
footerComponent: (
|
|
54
64
|
props: ModalProps,
|
|
55
|
-
) => ElementType<ModalFooterProps> | (() => JSX.Element | null);
|
|
56
|
-
render(): JSX.Element;
|
|
65
|
+
) => ElementType<ModalFooterProps> | (() => jsx.JSX.Element | null);
|
|
66
|
+
render(): jsx.JSX.Element;
|
|
57
67
|
}
|
|
58
68
|
|
|
69
|
+
/**
|
|
70
|
+
* @deprecated
|
|
71
|
+
* Custom button themes are deprecated and will be removed in the future.
|
|
72
|
+
*/
|
|
59
73
|
export declare const modalButtonTheme: (
|
|
60
74
|
current: any,
|
|
61
75
|
themeProps: Record<string, any>,
|
|
@@ -97,21 +111,34 @@ export { ModalTransition };
|
|
|
97
111
|
/**
|
|
98
112
|
* __Spotlight__
|
|
99
113
|
*
|
|
100
|
-
*
|
|
114
|
+
* An onboarding spotlight introduces new features to users through focused messages or multi-step tours.
|
|
101
115
|
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
* - [
|
|
116
|
+
* - [Examples](https://atlassian.design/components/onboarding/examples)
|
|
117
|
+
* - [Code](https://atlassian.design/components/onboarding/code)
|
|
118
|
+
* - [Usage](https://atlassian.design/components/onboarding/usage)
|
|
105
119
|
*/
|
|
106
120
|
export declare const Spotlight: React_2.FC<SpotlightProps>;
|
|
107
121
|
|
|
122
|
+
/**
|
|
123
|
+
* @deprecated
|
|
124
|
+
* Custom button themes are deprecated and will be removed in the future.
|
|
125
|
+
*/
|
|
108
126
|
export declare const spotlightButtonTheme: (
|
|
109
127
|
current: any,
|
|
110
128
|
themeProps: Record<string, any>,
|
|
111
129
|
) => any;
|
|
112
130
|
|
|
131
|
+
/**
|
|
132
|
+
* __Spotlight card__
|
|
133
|
+
*
|
|
134
|
+
* A spotlight card is for onboarding messages that need a more flexible layout, or don't require a dialog.
|
|
135
|
+
*
|
|
136
|
+
* - [Examples](https://atlassian.design/components/onboarding/spotlight-card/examples)
|
|
137
|
+
* - [Code](https://atlassian.design/components/onboarding/spotlight-card/code)
|
|
138
|
+
* - [Usage](https://atlassian.design/components/onboarding/spotlight-card/usage)
|
|
139
|
+
*/
|
|
113
140
|
export declare const SpotlightCard: React_2.ForwardRefExoticComponent<
|
|
114
|
-
SpotlightCardProps & React_2.RefAttributes<
|
|
141
|
+
SpotlightCardProps & React_2.RefAttributes<HTMLDivElement>
|
|
115
142
|
>;
|
|
116
143
|
|
|
117
144
|
declare interface SpotlightCardProps {
|
|
@@ -151,14 +178,19 @@ declare interface SpotlightCardProps {
|
|
|
151
178
|
*/
|
|
152
179
|
isFlat?: boolean;
|
|
153
180
|
/**
|
|
154
|
-
*
|
|
181
|
+
* @deprecated
|
|
182
|
+
* Theme prop is deprecated and will be removed in the future.
|
|
155
183
|
*/
|
|
156
184
|
theme?: ThemeProp<CardTokens, {}>;
|
|
157
185
|
/**
|
|
158
|
-
* Width of the card in pixels
|
|
186
|
+
* Width of the card in pixels.
|
|
159
187
|
*/
|
|
160
188
|
width?: number;
|
|
161
|
-
|
|
189
|
+
/**
|
|
190
|
+
* @deprecated
|
|
191
|
+
* Use `ref` instead.
|
|
192
|
+
*/
|
|
193
|
+
innerRef?: Ref<HTMLDivElement> | null;
|
|
162
194
|
/**
|
|
163
195
|
* A `testId` prop is provided for specified elements,
|
|
164
196
|
* which is a unique string that appears as a data attribute `data-testid` in the rendered code,
|
|
@@ -170,9 +202,11 @@ declare interface SpotlightCardProps {
|
|
|
170
202
|
/**
|
|
171
203
|
* __Spotlight manager__
|
|
172
204
|
*
|
|
173
|
-
*
|
|
205
|
+
* A spotlight manager manages the visibility of spotlights used to introduce new features to users through focused messages or multi-step tours.
|
|
174
206
|
*
|
|
175
|
-
* - [Examples](https://
|
|
207
|
+
* - [Examples](https://atlassian.design/components/onboarding/examples)
|
|
208
|
+
* - [Code](https://atlassian.design/components/onboarding/code)
|
|
209
|
+
* - [Usage](https://atlassian.design/components/onboarding/usage)
|
|
176
210
|
*/
|
|
177
211
|
export declare class SpotlightManager extends PureComponent<
|
|
178
212
|
SpotlightManagerProps,
|
|
@@ -218,7 +252,7 @@ declare interface SpotlightManagerProps {
|
|
|
218
252
|
children: ReactNode;
|
|
219
253
|
/**
|
|
220
254
|
* @deprecated
|
|
221
|
-
*
|
|
255
|
+
* Component is deprecated and will be removed in the future.
|
|
222
256
|
*/
|
|
223
257
|
component?: ElementType;
|
|
224
258
|
}
|
|
@@ -320,20 +354,24 @@ declare interface SpotlightProps {
|
|
|
320
354
|
}
|
|
321
355
|
|
|
322
356
|
/**
|
|
323
|
-
*
|
|
357
|
+
* __Spotlight pulse__
|
|
324
358
|
*
|
|
325
|
-
*
|
|
359
|
+
* A spotlight pulse draws attention to a new feature.
|
|
326
360
|
*
|
|
327
|
-
* - [Examples](https://
|
|
361
|
+
* - [Examples](https://atlassian.design/components/onboarding/examples)
|
|
362
|
+
* - [Code](https://atlassian.design/components/onboarding/code)
|
|
363
|
+
* - [Usage](https://atlassian.design/components/onboarding/usage)
|
|
328
364
|
*/
|
|
329
365
|
export declare const SpotlightPulse: React.FC<TargetProps>;
|
|
330
366
|
|
|
331
367
|
/**
|
|
332
368
|
* __Spotlight target__
|
|
333
369
|
*
|
|
334
|
-
*
|
|
370
|
+
* A spotlight target marks a component to be used for introducing new features to users through focused messages or multi-step tours.
|
|
335
371
|
*
|
|
336
|
-
* - [Examples](https://
|
|
372
|
+
* - [Examples](https://atlassian.design/components/onboarding/examples)
|
|
373
|
+
* - [Code](https://atlassian.design/components/onboarding/code)
|
|
374
|
+
* - [Usage](https://atlassian.design/components/onboarding/usage)
|
|
337
375
|
*/
|
|
338
376
|
export declare const SpotlightTarget: React_2.FC<SpotlightTargetProps>;
|
|
339
377
|
|
|
@@ -351,9 +389,11 @@ declare interface SpotlightTargetProps {
|
|
|
351
389
|
/**
|
|
352
390
|
* __Spotlight transition__
|
|
353
391
|
*
|
|
354
|
-
*
|
|
392
|
+
* A spotlight transition holds onto spotlights so they can fade out when exiting the viewport.
|
|
355
393
|
*
|
|
356
|
-
* - [Examples](https://
|
|
394
|
+
* - [Examples](https://atlassian.design/components/onboarding/examples)
|
|
395
|
+
* - [Code](https://atlassian.design/components/onboarding/code)
|
|
396
|
+
* - [Usage](https://atlassian.design/components/onboarding/usage)
|
|
357
397
|
*/
|
|
358
398
|
export declare class SpotlightTransition extends React_2.Component<
|
|
359
399
|
SpotlightTransitionProps,
|
|
@@ -390,13 +430,7 @@ declare type TargetProps = Omit<BaseProps, 'css'> & {
|
|
|
390
430
|
};
|
|
391
431
|
|
|
392
432
|
/**
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
* Provides the following methods:
|
|
396
|
-
* - `isTargetRendered`
|
|
397
|
-
*
|
|
398
|
-
* Checks if the given spotlight target is currently
|
|
399
|
-
* being rendered.
|
|
433
|
+
* Use spotlight hook returns information about available spotlight targets.
|
|
400
434
|
*/
|
|
401
435
|
export declare function useSpotlight(): {
|
|
402
436
|
isTargetRendered: (target: string) => boolean;
|