@atlaskit/help 7.2.0 → 7.2.2

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 (34) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/analytics/package.json +2 -2
  3. package/dist/cjs/components/Article/ArticleLoadingFail/styled.js +2 -3
  4. package/dist/cjs/components/ArticlesList/ArticlesListItem/styled.js +2 -0
  5. package/dist/cjs/components/Search/SearchResults/styled.js +5 -6
  6. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/styled.js +2 -3
  7. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/styled.js +2 -3
  8. package/dist/cjs/version.json +1 -1
  9. package/dist/es2019/components/Article/ArticleLoadingFail/styled.js +2 -3
  10. package/dist/es2019/components/ArticlesList/ArticlesListItem/styled.js +2 -0
  11. package/dist/es2019/components/Search/SearchResults/styled.js +7 -6
  12. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/styled.js +4 -3
  13. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/styled.js +4 -3
  14. package/dist/es2019/version.json +1 -1
  15. package/dist/esm/components/Article/ArticleLoadingFail/styled.js +2 -3
  16. package/dist/esm/components/ArticlesList/ArticlesListItem/styled.js +2 -0
  17. package/dist/esm/components/Search/SearchResults/styled.js +5 -6
  18. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/styled.js +2 -3
  19. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/styled.js +2 -3
  20. package/dist/esm/version.json +1 -1
  21. package/dist/types/components/ArticlesList/ArticlesListItem/styled.d.ts +1 -1
  22. package/dist/types/components/Help.d.ts +1 -1
  23. package/dist/types/components/HelpContentButton/index.d.ts +1 -1
  24. package/dist/types/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/styled.d.ts +1 -1
  25. package/dist/types/components/contexts/navigationContext.d.ts +1 -1
  26. package/dist/types/components/styled.d.ts +2 -2
  27. package/dist/types/util/hooks/ctx.d.ts +1 -1
  28. package/dist/types/util/i18n-util.d.ts +3 -3
  29. package/dist/types/util/index.d.ts +1 -1
  30. package/dist/types/util/styled.d.ts +3 -3
  31. package/dist/types/util/testing/mock.d.ts +1 -1
  32. package/messages/package.json +2 -2
  33. package/package.json +14 -5
  34. package/tmp/api-report-tmp.d.ts +300 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/help
2
2
 
3
+ ## 7.2.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`41fae2c6f68`](https://bitbucket.org/atlassian/atlassian-frontend/commits/41fae2c6f68) - Upgrade Typescript from `4.5.5` to `4.9.5`
8
+
9
+ ## 7.2.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [`7e051bad115`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7e051bad115) - Internal change to enforce token usage for spacing properties. There is no expected visual or behaviour change.
14
+
3
15
  ## 7.2.0
4
16
 
5
17
  ### Minor Changes
@@ -6,9 +6,9 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/analytics.d.ts",
8
8
  "typesVersions": {
9
- ">=4.0 <4.5": {
9
+ ">=4.5 <4.9": {
10
10
  "*": [
11
- "../dist/types-ts4.0/analytics.d.ts"
11
+ "../dist/types-ts4.5/analytics.d.ts"
12
12
  ]
13
13
  }
14
14
  }
@@ -7,10 +7,9 @@ Object.defineProperty(exports, "__esModule", {
7
7
  exports.LoadingErrorMessage = exports.LoadingErrorButtonContainer = void 0;
8
8
  var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
9
9
  var _styled = _interopRequireDefault(require("@emotion/styled"));
10
- var _constants = require("@atlaskit/theme/constants");
11
10
  var _templateObject, _templateObject2;
12
11
  /** @jsx jsx */
13
- var LoadingErrorMessage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", "px;\n text-align: center;\n"])), 3 * (0, _constants.gridSize)());
12
+ var LoadingErrorMessage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)");
14
13
  exports.LoadingErrorMessage = LoadingErrorMessage;
15
- var LoadingErrorButtonContainer = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", "px;\n text-align: center;\n"])), 3 * (0, _constants.gridSize)());
14
+ var LoadingErrorButtonContainer = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)");
16
15
  exports.LoadingErrorButtonContainer = LoadingErrorButtonContainer;
@@ -45,6 +45,8 @@ exports.ArticlesListItemWrapper = ArticlesListItemWrapper;
45
45
  var ArticlesListItemContainer = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n width: 100%;\n white-space: nowrap;\n"])));
46
46
  exports.ArticlesListItemContainer = ArticlesListItemContainer;
47
47
  var ArticlesListItemTypeTitle = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n font-weight: bold;\n font-size: 11px;\n line-height: ", ";\n color: ", ";\n padding-bottom: ", ";\n"])), "var(--ds-font-lineHeight-100, 16px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"), "var(--ds-space-050, 4px)");
48
+
49
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
48
50
  exports.ArticlesListItemTypeTitle = ArticlesListItemTypeTitle;
49
51
  var ArticlesListItemLinkIcon = _styled.default.span(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n align-self: auto;\n padding-inline-start: 5px;\n vertical-align: middle;\n"])));
50
52
  exports.ArticlesListItemLinkIcon = ArticlesListItemLinkIcon;
@@ -8,19 +8,18 @@ Object.defineProperty(exports, "__esModule", {
8
8
  exports.SearchResultsList = exports.SearchResultsContainer = exports.SearchResultSearchExternalSiteContainer = exports.SearchResultEmptyMessageText = exports.SearchResultEmptyMessageImage = void 0;
9
9
  var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
10
10
  var _styled = _interopRequireDefault(require("@emotion/styled"));
11
- var _constants = require("@atlaskit/theme/constants");
12
11
  var colors = _interopRequireWildcard(require("@atlaskit/theme/colors"));
13
12
  var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
14
13
  /** @jsx jsx */
15
14
  function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
16
15
  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; }
17
- var SearchResultsContainer = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n position: absolute;\n height: 100%;\n width: 100%;\n top: 0;\n background-color: ", ";\n flex: 1;\n flex-direction: column;\n box-sizing: border-box;\n overflow-x: hidden;\n overflow-y: auto;\n z-index: 10;\n padding: 0 ", "px;\n"])), "var(--ds-surface, #FFFFFF)", 2 * (0, _constants.gridSize)());
16
+ var SearchResultsContainer = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n position: absolute;\n height: 100%;\n width: 100%;\n top: 0;\n background-color: ", ";\n flex: 1;\n flex-direction: column;\n box-sizing: border-box;\n overflow-x: hidden;\n overflow-y: auto;\n z-index: 10;\n padding: 0 ", ";\n"])), "var(--ds-surface, #FFFFFF)", "var(--ds-space-200, 16px)");
18
17
  exports.SearchResultsContainer = SearchResultsContainer;
19
- var SearchResultsList = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", "px;\n position: relative;\n"])), 3 * (0, _constants.gridSize)());
18
+ var SearchResultsList = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding-top: ", ";\n position: relative;\n"])), "var(--ds-space-300, 24px)");
20
19
  exports.SearchResultsList = SearchResultsList;
21
- var SearchResultEmptyMessageImage = _styled.default.div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)());
20
+ var SearchResultEmptyMessageImage = _styled.default.div(_templateObject3 || (_templateObject3 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
22
21
  exports.SearchResultEmptyMessageImage = SearchResultEmptyMessageImage;
23
- var SearchResultEmptyMessageText = _styled.default.div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
22
+ var SearchResultEmptyMessageText = _styled.default.div(_templateObject4 || (_templateObject4 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
24
23
  exports.SearchResultEmptyMessageText = SearchResultEmptyMessageText;
25
- var SearchResultSearchExternalSiteContainer = _styled.default.div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * (0, _constants.gridSize)(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
24
+ var SearchResultSearchExternalSiteContainer = _styled.default.div(_templateObject5 || (_templateObject5 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
26
25
  exports.SearchResultSearchExternalSiteContainer = SearchResultSearchExternalSiteContainer;
@@ -8,13 +8,12 @@ Object.defineProperty(exports, "__esModule", {
8
8
  exports.WhatsNewResultsEmptyMessageText = exports.WhatsNewResultsEmptyMessageImage = void 0;
9
9
  var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
10
10
  var _styled = _interopRequireDefault(require("@emotion/styled"));
11
- var _constants = require("@atlaskit/theme/constants");
12
11
  var colors = _interopRequireWildcard(require("@atlaskit/theme/colors"));
13
12
  var _templateObject, _templateObject2;
14
13
  /** @jsx jsx */
15
14
  function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
16
15
  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; }
17
- var WhatsNewResultsEmptyMessageImage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)());
16
+ var WhatsNewResultsEmptyMessageImage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
18
17
  exports.WhatsNewResultsEmptyMessageImage = WhatsNewResultsEmptyMessageImage;
19
- var WhatsNewResultsEmptyMessageText = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
18
+ var WhatsNewResultsEmptyMessageText = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
20
19
  exports.WhatsNewResultsEmptyMessageText = WhatsNewResultsEmptyMessageText;
@@ -8,13 +8,12 @@ Object.defineProperty(exports, "__esModule", {
8
8
  exports.SearchResultEmptyMessageText = exports.SearchResultEmptyMessageImage = void 0;
9
9
  var _taggedTemplateLiteral2 = _interopRequireDefault(require("@babel/runtime/helpers/taggedTemplateLiteral"));
10
10
  var _styled = _interopRequireDefault(require("@emotion/styled"));
11
- var _constants = require("@atlaskit/theme/constants");
12
11
  var colors = _interopRequireWildcard(require("@atlaskit/theme/colors"));
13
12
  var _templateObject, _templateObject2;
14
13
  /** @jsx jsx */
15
14
  function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
16
15
  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; }
17
- var SearchResultEmptyMessageImage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)());
16
+ var SearchResultEmptyMessageImage = _styled.default.div(_templateObject || (_templateObject = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
18
17
  exports.SearchResultEmptyMessageImage = SearchResultEmptyMessageImage;
19
- var SearchResultEmptyMessageText = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), 3 * (0, _constants.gridSize)(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
18
+ var SearchResultEmptyMessageText = _styled.default.div(_templateObject2 || (_templateObject2 = (0, _taggedTemplateLiteral2.default)(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
20
19
  exports.SearchResultEmptyMessageText = SearchResultEmptyMessageText;
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.2.0",
3
+ "version": "7.2.2",
4
4
  "sideEffects": false
5
5
  }
@@ -1,11 +1,10 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
- import { gridSize } from '@atlaskit/theme/constants';
4
3
  export const LoadingErrorMessage = styled.div`
5
- padding-top: ${3 * gridSize()}px;
4
+ padding-top: ${"var(--ds-space-300, 24px)"};
6
5
  text-align: center;
7
6
  `;
8
7
  export const LoadingErrorButtonContainer = styled.div`
9
- padding-top: ${3 * gridSize()}px;
8
+ padding-top: ${"var(--ds-space-300, 24px)"};
10
9
  text-align: center;
11
10
  `;
@@ -38,6 +38,8 @@ export const ArticlesListItemTypeTitle = styled.div`
38
38
  color: ${`var(--ds-text-subtlest, ${colors.N200})`};
39
39
  padding-bottom: ${"var(--ds-space-050, 4px)"};
40
40
  `;
41
+
42
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
41
43
  export const ArticlesListItemLinkIcon = styled.span`
42
44
  align-self: auto;
43
45
  padding-inline-start: 5px;
@@ -1,6 +1,5 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
- import { gridSize } from '@atlaskit/theme/constants';
4
3
  import * as colors from '@atlaskit/theme/colors';
5
4
  export const SearchResultsContainer = styled.div`
6
5
  position: absolute;
@@ -14,18 +13,20 @@ export const SearchResultsContainer = styled.div`
14
13
  overflow-x: hidden;
15
14
  overflow-y: auto;
16
15
  z-index: 10;
17
- padding: 0 ${2 * gridSize()}px;
16
+ padding: 0 ${"var(--ds-space-200, 16px)"};
18
17
  `;
19
18
  export const SearchResultsList = styled.div`
20
- padding-top: ${3 * gridSize()}px;
19
+ padding-top: ${"var(--ds-space-300, 24px)"};
21
20
  position: relative;
22
21
  `;
23
22
  export const SearchResultEmptyMessageImage = styled.div`
24
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
23
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
24
+ ${"var(--ds-space-300, 24px)"};
25
25
  text-align: center;
26
26
  `;
27
27
  export const SearchResultEmptyMessageText = styled.div`
28
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
28
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
29
+ ${"var(--ds-space-300, 24px)"};
29
30
  text-align: center;
30
31
 
31
32
  p {
@@ -33,7 +34,7 @@ export const SearchResultEmptyMessageText = styled.div`
33
34
  }
34
35
  `;
35
36
  export const SearchResultSearchExternalSiteContainer = styled.div`
36
- padding: ${3 * gridSize()}px;
37
+ padding: ${"var(--ds-space-300, 24px)"};
37
38
  text-align: center;
38
39
 
39
40
  p {
@@ -1,13 +1,14 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
- import { gridSize } from '@atlaskit/theme/constants';
4
3
  import * as colors from '@atlaskit/theme/colors';
5
4
  export const WhatsNewResultsEmptyMessageImage = styled.div`
6
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
5
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
6
+ ${"var(--ds-space-300, 24px)"};
7
7
  text-align: center;
8
8
  `;
9
9
  export const WhatsNewResultsEmptyMessageText = styled.div`
10
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
10
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
11
+ ${"var(--ds-space-300, 24px)"};
11
12
  text-align: center;
12
13
 
13
14
  p {
@@ -1,13 +1,14 @@
1
1
  /** @jsx jsx */
2
2
  import styled from '@emotion/styled';
3
- import { gridSize } from '@atlaskit/theme/constants';
4
3
  import * as colors from '@atlaskit/theme/colors';
5
4
  export const SearchResultEmptyMessageImage = styled.div`
6
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
5
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
6
+ ${"var(--ds-space-300, 24px)"};
7
7
  text-align: center;
8
8
  `;
9
9
  export const SearchResultEmptyMessageText = styled.div`
10
- padding: ${3 * gridSize()}px ${3 * gridSize()}px 0 ${3 * gridSize()}px;
10
+ padding: ${"var(--ds-space-300, 24px)"} ${"var(--ds-space-300, 24px)"} 0
11
+ ${"var(--ds-space-300, 24px)"};
11
12
  text-align: center;
12
13
 
13
14
  p {
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.2.0",
3
+ "version": "7.2.2",
4
4
  "sideEffects": false
5
5
  }
@@ -2,6 +2,5 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject, _templateObject2;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
- import { gridSize } from '@atlaskit/theme/constants';
6
- export var LoadingErrorMessage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding-top: ", "px;\n text-align: center;\n"])), 3 * gridSize());
7
- export var LoadingErrorButtonContainer = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-top: ", "px;\n text-align: center;\n"])), 3 * gridSize());
5
+ export var LoadingErrorMessage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding-top: ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)");
6
+ export var LoadingErrorButtonContainer = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-top: ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)");
@@ -33,6 +33,8 @@ export var ArticlesListItemWrapper = styled.a({
33
33
  });
34
34
  export var ArticlesListItemContainer = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n width: 100%;\n white-space: nowrap;\n"])));
35
35
  export var ArticlesListItemTypeTitle = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n font-weight: bold;\n font-size: 11px;\n line-height: ", ";\n color: ", ";\n padding-bottom: ", ";\n"])), "var(--ds-font-lineHeight-100, 16px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"), "var(--ds-space-050, 4px)");
36
+
37
+ // eslint-disable-next-line @atlaskit/design-system/ensure-design-token-usage-spacing
36
38
  export var ArticlesListItemLinkIcon = styled.span(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n align-self: auto;\n padding-inline-start: 5px;\n vertical-align: middle;\n"])));
37
39
  export var ArticlesListItemTitleText = styled.span(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n text-decoration: none;\n color: ", ";\n font-size: ", "px;\n font-weight: 600;\n display: inline-block;\n line-height: ", ";\n white-space: normal;\n overflow-x: hidden;\n margin-bottom: ", ";\n"])), "var(--ds-text, ".concat(colors.N800, ")"), fontSize(), "var(--ds-font-lineHeight-200, 20px)", "var(--ds-space-100, 8px)");
38
40
  export var ArticlesListItemDescription = styled.p(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n display: block;\n line-height: ", ";\n color: ", ";\n margin: 0;\n"])), "var(--ds-font-lineHeight-200, 20px)", "var(--ds-text-subtle, ".concat(colors.N400, ")"));
@@ -2,10 +2,9 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject, _templateObject2, _templateObject3, _templateObject4, _templateObject5;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
- import { gridSize } from '@atlaskit/theme/constants';
6
5
  import * as colors from '@atlaskit/theme/colors';
7
- export var SearchResultsContainer = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n position: absolute;\n height: 100%;\n width: 100%;\n top: 0;\n background-color: ", ";\n flex: 1;\n flex-direction: column;\n box-sizing: border-box;\n overflow-x: hidden;\n overflow-y: auto;\n z-index: 10;\n padding: 0 ", "px;\n"])), "var(--ds-surface, #FFFFFF)", 2 * gridSize());
8
- export var SearchResultsList = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-top: ", "px;\n position: relative;\n"])), 3 * gridSize());
9
- export var SearchResultEmptyMessageImage = styled.div(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize());
10
- export var SearchResultEmptyMessageText = styled.div(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
11
- export var SearchResultSearchExternalSiteContainer = styled.div(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n padding: ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * gridSize(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
6
+ export var SearchResultsContainer = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n position: absolute;\n height: 100%;\n width: 100%;\n top: 0;\n background-color: ", ";\n flex: 1;\n flex-direction: column;\n box-sizing: border-box;\n overflow-x: hidden;\n overflow-y: auto;\n z-index: 10;\n padding: 0 ", ";\n"])), "var(--ds-surface, #FFFFFF)", "var(--ds-space-200, 16px)");
7
+ export var SearchResultsList = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding-top: ", ";\n position: relative;\n"])), "var(--ds-space-300, 24px)");
8
+ export var SearchResultEmptyMessageImage = styled.div(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
9
+ export var SearchResultEmptyMessageText = styled.div(_templateObject4 || (_templateObject4 = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
10
+ export var SearchResultSearchExternalSiteContainer = styled.div(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n padding: ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
@@ -2,7 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject, _templateObject2;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
- import { gridSize } from '@atlaskit/theme/constants';
6
5
  import * as colors from '@atlaskit/theme/colors';
7
- export var WhatsNewResultsEmptyMessageImage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize());
8
- export var WhatsNewResultsEmptyMessageText = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
6
+ export var WhatsNewResultsEmptyMessageImage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
7
+ export var WhatsNewResultsEmptyMessageText = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
@@ -2,7 +2,6 @@ import _taggedTemplateLiteral from "@babel/runtime/helpers/taggedTemplateLiteral
2
2
  var _templateObject, _templateObject2;
3
3
  /** @jsx jsx */
4
4
  import styled from '@emotion/styled';
5
- import { gridSize } from '@atlaskit/theme/constants';
6
5
  import * as colors from '@atlaskit/theme/colors';
7
- export var SearchResultEmptyMessageImage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize());
8
- export var SearchResultEmptyMessageText = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding: ", "px ", "px 0 ", "px;\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), 3 * gridSize(), 3 * gridSize(), 3 * gridSize(), "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
6
+ export var SearchResultEmptyMessageImage = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)");
7
+ export var SearchResultEmptyMessageText = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n padding: ", " ", " 0\n ", ";\n text-align: center;\n\n p {\n color: ", ";\n }\n"])), "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-space-300, 24px)", "var(--ds-text-subtlest, ".concat(colors.N200, ")"));
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.2.0",
3
+ "version": "7.2.2",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
- declare type ArticlesListItemWrapperProps = {
2
+ type ArticlesListItemWrapperProps = {
3
3
  styles: any;
4
4
  };
5
5
  export declare const ArticlesListItemWrapper: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, ArticlesListItemWrapperProps, object>;
@@ -1,7 +1,7 @@
1
1
  import React from 'react';
2
2
  import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
3
3
  import { Help as HelpInterface } from '../model/Help';
4
- export declare type Props = HelpInterface & WithAnalyticsEventsProps;
4
+ export type Props = HelpInterface & WithAnalyticsEventsProps;
5
5
  export declare class Help extends React.PureComponent<Props> {
6
6
  render(): JSX.Element;
7
7
  }
@@ -1,7 +1,7 @@
1
1
  import React from 'react';
2
2
  import { NotificationLogProvider } from '@atlaskit/notification-log-client';
3
3
  import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
4
- export declare type Props = {
4
+ export type Props = {
5
5
  id?: string;
6
6
  href?: string;
7
7
  notificationMax?: number;
@@ -1,5 +1,5 @@
1
1
  /// <reference types="react" />
2
- declare type WhatsNewResultListItemWrapperProps = {
2
+ type WhatsNewResultListItemWrapperProps = {
3
3
  styles: any;
4
4
  };
5
5
  export declare const WhatsNewResultListItemWrapper: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").AnchorHTMLAttributes<HTMLAnchorElement>, HTMLAnchorElement>, WhatsNewResultListItemWrapperProps, object>;
@@ -4,7 +4,7 @@ import { Article, ArticleItem } from '../../model/Article';
4
4
  import { WhatsNewArticleItem, WhatsNewArticle } from '../../model/WhatsNew';
5
5
  import { HistoryItem, articleId } from '../../model/Help';
6
6
  import { VIEW } from '../constants';
7
- declare type ViewType = keyof typeof VIEW;
7
+ type ViewType = keyof typeof VIEW;
8
8
  interface NavigationProviderInterface {
9
9
  navigationData?: {
10
10
  articleId: articleId;
@@ -1,11 +1,11 @@
1
1
  /** @jsx jsx */
2
2
  /// <reference types="react" />
3
- declare type HelpBodyProps = {
3
+ type HelpBodyProps = {
4
4
  isOverlayVisible?: boolean;
5
5
  };
6
6
  export declare const HelpBodyContainer: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, HelpBodyProps, object>;
7
7
  export declare const HelpBody: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, HelpBodyProps, object>;
8
- declare type HomeProps = {
8
+ type HomeProps = {
9
9
  isOverlayFullyVisible?: boolean;
10
10
  isOverlayVisible?: boolean;
11
11
  };
@@ -1,2 +1,2 @@
1
1
  /// <reference types="react" />
2
- export declare function createCtx<ContextType>(): readonly [() => ContextType, import("react").Provider<ContextType | undefined>];
2
+ export declare function createCtx<ContextType>(): readonly [() => NonNullable<ContextType>, import("react").Provider<ContextType | undefined>];
@@ -1,6 +1,6 @@
1
- declare type LanguageCode = 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'et' | 'fi' | 'fr' | 'de' | 'hu' | 'is' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt_BR' | 'pt_PT' | 'ro' | 'ru' | 'sk' | 'es' | 'sv';
2
- export declare type LangCode = LanguageCode | 'pt-BR' | 'pt-PT';
3
- declare type LocaleMessages = {
1
+ type LanguageCode = 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'en_GB' | 'et' | 'fi' | 'fr' | 'de' | 'hu' | 'is' | 'it' | 'ja' | 'ko' | 'nb' | 'pl' | 'pt_BR' | 'pt_PT' | 'ro' | 'ru' | 'sk' | 'es' | 'sv';
2
+ export type LangCode = LanguageCode | 'pt-BR' | 'pt-PT';
3
+ type LocaleMessages = {
4
4
  [key: string]: string;
5
5
  };
6
6
  /**
@@ -1,6 +1,6 @@
1
1
  /// <reference types="react" />
2
2
  import { WHATS_NEW_ITEM_TYPES } from '../model/WhatsNew';
3
- export declare const getTypeIcon: (itemType?: WHATS_NEW_ITEM_TYPES | undefined) => "" | JSX.Element;
3
+ export declare const getTypeIcon: (itemType?: WHATS_NEW_ITEM_TYPES) => "" | JSX.Element;
4
4
  export declare const getTypeTitle: (itemType: WHATS_NEW_ITEM_TYPES) => {
5
5
  id: string;
6
6
  defaultMessage: string;
@@ -5,7 +5,7 @@ export declare const DividerLine: import("@emotion/styled-base").StyledComponent
5
5
  /**
6
6
  * Loading container
7
7
  */
8
- declare type LoadingRectangleProps = {
8
+ type LoadingRectangleProps = {
9
9
  contentWidth?: string;
10
10
  contentHeight?: string;
11
11
  marginTop?: string;
@@ -14,7 +14,7 @@ export declare const LoadingRectangle: import("@emotion/styled-base").StyledComp
14
14
  /**
15
15
  * Loading Circle
16
16
  */
17
- declare type LoadingCircleProps = {
17
+ type LoadingCircleProps = {
18
18
  radius?: string;
19
19
  marginTop?: string;
20
20
  };
@@ -22,7 +22,7 @@ export declare const LoadingCircle: import("@emotion/styled-base").StyledCompone
22
22
  /**
23
23
  * What's new icon
24
24
  */
25
- declare type WhatsNewTypeIconProps = {
25
+ type WhatsNewTypeIconProps = {
26
26
  type?: WHATS_NEW_ITEM_TYPES;
27
27
  };
28
28
  export declare const WhatsNewTypeIcon: import("@emotion/styled-base").StyledComponent<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, WhatsNewTypeIconProps, object>;
@@ -4,5 +4,5 @@ export declare const getMockArticle: (id: string, routeName?: string, routeGroup
4
4
  export declare const getMockArticleItem: (id: string, routeName?: string, routeGroup?: string, productName?: string, href?: string) => ArticleItem;
5
5
  export declare const getMockArticleItemList: (numberOfItems: number) => ArticleItem[];
6
6
  export declare const getMockWhatsNewArticle: (id: string, routeName?: string, routeGroup?: string, productName?: string, href?: string) => Article;
7
- export declare const getMockWhatsNewArticleItem: (id: string, type?: WHATS_NEW_ITEM_TYPES | undefined, title?: string, description?: string, changeTargetSchedule?: string, status?: string, featureRolloutDate?: string, href?: string) => WhatsNewArticleItem;
7
+ export declare const getMockWhatsNewArticleItem: (id: string, type?: WHATS_NEW_ITEM_TYPES, title?: string, description?: string, changeTargetSchedule?: string, status?: string, featureRolloutDate?: string, href?: string) => WhatsNewArticleItem;
8
8
  export declare const getMockWhatsNewArticleItemList: (numberOfItems: number) => WhatsNewArticleItem[];
@@ -6,9 +6,9 @@
6
6
  "sideEffects": false,
7
7
  "types": "../dist/types/messages.d.ts",
8
8
  "typesVersions": {
9
- ">=4.0 <4.5": {
9
+ ">=4.5 <4.9": {
10
10
  "*": [
11
- "../dist/types-ts4.0/messages.d.ts"
11
+ "../dist/types-ts4.5/messages.d.ts"
12
12
  ]
13
13
  }
14
14
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.2.0",
3
+ "version": "7.2.2",
4
4
  "description": "A cross-product help component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -12,6 +12,14 @@
12
12
  "module": "dist/esm/index.js",
13
13
  "module:es2019": "dist/es2019/index.js",
14
14
  "types": "dist/types/index.d.ts",
15
+ "typesVersions": {
16
+ ">=4.5 <4.9": {
17
+ "*": [
18
+ "dist/types-ts4.5/*",
19
+ "dist/types-ts4.5/index.d.ts"
20
+ ]
21
+ }
22
+ },
15
23
  "sideEffects": false,
16
24
  "atlaskit:src": "src/index.ts",
17
25
  "atlassian": {
@@ -29,7 +37,7 @@
29
37
  "@atlaskit/analytics": "^8.1.0",
30
38
  "@atlaskit/analytics-next": "^9.1.0",
31
39
  "@atlaskit/button": "^16.7.0",
32
- "@atlaskit/checkbox": "^12.5.0",
40
+ "@atlaskit/checkbox": "^12.6.0",
33
41
  "@atlaskit/form": "^8.11.0",
34
42
  "@atlaskit/help-article": "^4.1.0",
35
43
  "@atlaskit/help-layout": "^4.2.0",
@@ -43,7 +51,7 @@
43
51
  "@atlaskit/textarea": "^4.6.0",
44
52
  "@atlaskit/textfield": "^5.4.0",
45
53
  "@atlaskit/theme": "^12.5.0",
46
- "@atlaskit/tokens": "^1.3.0",
54
+ "@atlaskit/tokens": "^1.4.0",
47
55
  "@atlaskit/tooltip": "^17.8.0",
48
56
  "@babel/runtime": "^7.0.0",
49
57
  "@emotion/core": "^10.0.9",
@@ -68,7 +76,7 @@
68
76
  "algoliasearch": "^3.35.1",
69
77
  "enzyme": "^3.10.0",
70
78
  "react-test-renderer": "^16.8.0",
71
- "typescript": "4.5.5"
79
+ "typescript": "~4.9.5"
72
80
  },
73
81
  "keywords": [
74
82
  "atlaskit",
@@ -80,7 +88,8 @@
80
88
  "techstack": {
81
89
  "@repo/internal": {
82
90
  "design-tokens": [
83
- "color"
91
+ "color",
92
+ "spacing"
84
93
  ]
85
94
  }
86
95
  }
@@ -0,0 +1,300 @@
1
+ ## API Report File for "@atlaskit/help"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ /// <reference types="react" />
8
+
9
+ import type { AdfDoc } from '@atlaskit/help-article';
10
+ import { BODY_FORMAT_TYPES } from '@atlaskit/help-article';
11
+ import { ClassAttributes } from 'react';
12
+ import { DetailedHTMLProps } from 'react';
13
+ import { HTMLAttributes } from 'react';
14
+ import { NotificationLogProvider } from '@atlaskit/notification-log-client';
15
+ import { default as React_2 } from 'react';
16
+ import { StyledComponent } from '@emotion/styled-base';
17
+ import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
18
+ import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
19
+ import { WithContextProps } from '@atlaskit/analytics-next';
20
+ import { WithIntlProps } from 'react-intl-next';
21
+ import { WrappedComponentProps } from 'react-intl-next';
22
+
23
+ // @public (undocumented)
24
+ export interface Article extends ArticleItem {
25
+ // (undocumented)
26
+ body: AdfDoc | string;
27
+ // (undocumented)
28
+ bodyFormat?: BODY_FORMAT_TYPES;
29
+ // (undocumented)
30
+ relatedArticles?: ArticleItem[];
31
+ }
32
+
33
+ // @public (undocumented)
34
+ export enum ARTICLE_ITEM_TYPES {
35
+ // (undocumented)
36
+ topicInProduct = "topicInProduct"
37
+ }
38
+
39
+ // @public (undocumented)
40
+ export enum ARTICLE_TYPE {
41
+ // (undocumented)
42
+ HELP_ARTICLE = "HELP_ARTICLE",
43
+ // (undocumented)
44
+ WHATS_NEW = "WHATS_NEW"
45
+ }
46
+
47
+ // @public (undocumented)
48
+ export interface ArticleFeedback {
49
+ // (undocumented)
50
+ contactMe: boolean;
51
+ // (undocumented)
52
+ feedbackReason: string;
53
+ // (undocumented)
54
+ feedbackReasonText: string;
55
+ // (undocumented)
56
+ wasHelpful: boolean;
57
+ }
58
+
59
+ // @public (undocumented)
60
+ export interface articleId {
61
+ // (undocumented)
62
+ id: string;
63
+ // (undocumented)
64
+ type: ARTICLE_TYPE;
65
+ }
66
+
67
+ // @public (undocumented)
68
+ export interface ArticleItem {
69
+ // (undocumented)
70
+ description?: string;
71
+ // (undocumented)
72
+ href?: string;
73
+ // (undocumented)
74
+ id: string;
75
+ // (undocumented)
76
+ lastPublished: string;
77
+ // (undocumented)
78
+ productName?: string;
79
+ // (undocumented)
80
+ routes?: {
81
+ routeName: string;
82
+ routeGroup: string;
83
+ }[];
84
+ // (undocumented)
85
+ title: string;
86
+ // (undocumented)
87
+ topicId?: string;
88
+ // (undocumented)
89
+ type: ARTICLE_ITEM_TYPES;
90
+ }
91
+
92
+ // @public (undocumented)
93
+ export const ArticlesListItem: React_2.FC<WithIntlProps<Props_3 & Partial<ArticleItem> & WrappedComponentProps<"intl">>> & {
94
+ WrappedComponent: React_2.ComponentType<Props_3 & Partial<ArticleItem> & WrappedComponentProps<"intl">>;
95
+ };
96
+
97
+ // @public (undocumented)
98
+ const _default: React_2.ForwardRefExoticComponent<Pick<Omit<Props, keyof WithAnalyticsEventsProps> & React_2.RefAttributes<any> & WithContextProps, "analyticsContext" | "key" | keyof Help> & React_2.RefAttributes<any>>;
99
+ export default _default;
100
+
101
+ // @public (undocumented)
102
+ export const DividerLine: StyledComponent<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, Pick<ClassAttributes<HTMLDivElement> & HTMLAttributes<HTMLDivElement>, keyof HTMLAttributes<HTMLDivElement>>, object>;
103
+
104
+ // @public (undocumented)
105
+ export interface Help {
106
+ // (undocumented)
107
+ children?: React.ReactNode;
108
+ // (undocumented)
109
+ footer?: React.ReactNode;
110
+ // (undocumented)
111
+ header?: {
112
+ onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
113
+ onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
114
+ };
115
+ // (undocumented)
116
+ helpArticle?: {
117
+ onGetHelpArticle?(articleId: articleId): Promise<Article>;
118
+ onHelpArticleLoadingFailTryAgainButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleId: articleId): void;
119
+ onWasHelpfulSubmit?(analyticsEvent: UIAnalyticsEvent, articleFeedback: ArticleFeedback, articleData: ArticleItem): Promise<boolean>;
120
+ onWasHelpfulYesButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, ArticleItem: ArticleItem): void;
121
+ onWasHelpfulNoButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, ArticleItem: ArticleItem): void;
122
+ };
123
+ // (undocumented)
124
+ home?: {
125
+ homeOptions?: Props_2[];
126
+ };
127
+ // (undocumented)
128
+ navigation?: {
129
+ navigationData?: {
130
+ articleId: articleId;
131
+ history: HistoryItem[];
132
+ };
133
+ setNavigationData?(navigationData: {
134
+ articleId?: articleId;
135
+ history?: HistoryItem[];
136
+ }): void;
137
+ };
138
+ // (undocumented)
139
+ relatedArticles?: {
140
+ routeGroup?: string;
141
+ routeName?: string;
142
+ onGetRelatedArticles?(routeGroup?: string, routeName?: string): Promise<ArticleItem[]>;
143
+ onRelatedArticlesShowMoreClick?(event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent, isCollapsed: boolean): void;
144
+ onRelatedArticlesListItemClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem) => void;
145
+ };
146
+ // (undocumented)
147
+ search?: {
148
+ onSearch?(value: string): Promise<ArticleItem[]>;
149
+ onSearchInputChanged?(event: React.KeyboardEvent<HTMLInputElement>, analyticsEvent: UIAnalyticsEvent, value: string): void;
150
+ onSearchInputCleared?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
151
+ onSearchResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
152
+ onSearchExternalUrlClick?(event?: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
153
+ searchExternalUrl?: string;
154
+ };
155
+ // (undocumented)
156
+ whatsNew?: {
157
+ whatsNewGetNotificationProvider?: Promise<NotificationLogProvider>;
158
+ productName?: string;
159
+ onWhatsNewButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
160
+ onSearchWhatsNewArticles?(filter?: '' | WHATS_NEW_ITEM_TYPES, numberOfItems?: number, page?: string): Promise<whatsNewSearchResult>;
161
+ onWhatsNewResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, whatsNewArticleData: WhatsNewArticleItem): void;
162
+ onSearchWhatsNewShowMoreClick?(event: React.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent): void;
163
+ onGetWhatsNewArticle?(id: articleId): Promise<WhatsNewArticle>;
164
+ };
165
+ }
166
+
167
+ // @public (undocumented)
168
+ export const HelpContentButton: ({ id, href, notificationMax, notificationLogProvider, text, icon, onClick, tooltipText, }: Props_2) => JSX.Element;
169
+
170
+ // @public (undocumented)
171
+ export interface HistoryItem {
172
+ // (undocumented)
173
+ article?: Article | WhatsNewArticle;
174
+ // (undocumented)
175
+ id: string;
176
+ // (undocumented)
177
+ state: REQUEST_STATE;
178
+ // (undocumented)
179
+ type: ARTICLE_TYPE;
180
+ // (undocumented)
181
+ uid: number;
182
+ }
183
+
184
+ // @public (undocumented)
185
+ type Props = Help & WithAnalyticsEventsProps;
186
+
187
+ // @public (undocumented)
188
+ type Props_2 = {
189
+ id?: string;
190
+ href?: string;
191
+ notificationMax?: number;
192
+ notificationLogProvider?: Promise<NotificationLogProvider>;
193
+ text: string;
194
+ icon?: React_2.ReactChild;
195
+ tooltipText?: string;
196
+ onClick?: (id: string, analytics: UIAnalyticsEvent, event: React_2.MouseEvent<HTMLElement>) => void;
197
+ };
198
+
199
+ // @public (undocumented)
200
+ interface Props_3 {
201
+ // (undocumented)
202
+ onClick?: (event: React_2.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent) => void;
203
+ // (undocumented)
204
+ styles?: {};
205
+ }
206
+
207
+ // @public (undocumented)
208
+ interface Props_4 {
209
+ // (undocumented)
210
+ onGetRelatedArticles?(routeGroup?: string, routeName?: string): Promise<ArticleItem[]>;
211
+ // (undocumented)
212
+ onRelatedArticlesListItemClick?: (event: React_2.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem) => void;
213
+ // (undocumented)
214
+ onRelatedArticlesShowMoreClick?: (event: React_2.MouseEvent<HTMLElement>, analyticsEvent: UIAnalyticsEvent, isCollapsed: boolean) => void;
215
+ // (undocumented)
216
+ routeGroup?: string;
217
+ // (undocumented)
218
+ routeName?: string;
219
+ // (undocumented)
220
+ style?: 'primary' | 'secondary';
221
+ }
222
+
223
+ // @public (undocumented)
224
+ export const RelatedArticles: React_2.ForwardRefExoticComponent<Omit<Props_4 & WrappedComponentProps<"intl">, "intl"> & {
225
+ forwardedRef?: React_2.Ref<any> | undefined;
226
+ } & {
227
+ children?: React_2.ReactNode;
228
+ } & WithContextProps & React_2.RefAttributes<any>>;
229
+
230
+ // @public (undocumented)
231
+ enum REQUEST_STATE {
232
+ // (undocumented)
233
+ done = "done",
234
+ // (undocumented)
235
+ error = "error",
236
+ // (undocumented)
237
+ load = "load",
238
+ // (undocumented)
239
+ loading = "loading",
240
+ // (undocumented)
241
+ reload = "reload"
242
+ }
243
+
244
+ // @public (undocumented)
245
+ export enum WHATS_NEW_ITEM_TYPES {
246
+ // (undocumented)
247
+ EXPERIMENT = "Experiment",
248
+ // (undocumented)
249
+ FIX = "Fix",
250
+ // (undocumented)
251
+ IMPROVEMENT = "Improvement",
252
+ // (undocumented)
253
+ NEW_FEATURE = "Announcement",
254
+ // (undocumented)
255
+ REMOVED = "Removed"
256
+ }
257
+
258
+ // @public (undocumented)
259
+ export interface WhatsNewArticle extends WhatsNewArticleItem {
260
+ // (undocumented)
261
+ bodyFormat?: BODY_FORMAT_TYPES;
262
+ // (undocumented)
263
+ description: AdfDoc | string;
264
+ }
265
+
266
+ // @public (undocumented)
267
+ export interface WhatsNewArticleItem {
268
+ // (undocumented)
269
+ changeTargetSchedule?: string;
270
+ // (undocumented)
271
+ communityUrl?: string;
272
+ // (undocumented)
273
+ featureRolloutDate?: string;
274
+ // (undocumented)
275
+ href?: string;
276
+ // (undocumented)
277
+ id: string;
278
+ // (undocumented)
279
+ relatedExternalLinks?: string;
280
+ // (undocumented)
281
+ status?: string;
282
+ // (undocumented)
283
+ title?: string;
284
+ // (undocumented)
285
+ type?: WHATS_NEW_ITEM_TYPES;
286
+ }
287
+
288
+ // @public (undocumented)
289
+ interface whatsNewSearchResult {
290
+ // (undocumented)
291
+ articles: WhatsNewArticleItem[];
292
+ // (undocumented)
293
+ hasNextPage: boolean;
294
+ // (undocumented)
295
+ nextPage: string;
296
+ }
297
+
298
+ // (No @packageDocumentation comment for this package)
299
+
300
+ ```