@atlaskit/help 7.1.26 → 7.2.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.
Files changed (79) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/dist/cjs/components/Article/ArticleLoadingFail/styled.js +1 -0
  3. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/index.js +0 -1
  4. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/styled.js +3 -3
  5. package/dist/cjs/components/Article/WhatsNewArticle/styled.js +7 -6
  6. package/dist/cjs/components/Article/styled.js +2 -2
  7. package/dist/cjs/components/ArticlesList/ArticlesListItem/styled.js +5 -4
  8. package/dist/cjs/components/ArticlesList/styled.js +2 -2
  9. package/dist/cjs/components/HelpContentButton/styled.js +5 -5
  10. package/dist/cjs/components/RelatedArticles/index.js +28 -30
  11. package/dist/cjs/components/RelatedArticles/styled.js +4 -3
  12. package/dist/cjs/components/Search/SearchInput/styled.js +3 -3
  13. package/dist/cjs/components/Search/SearchResults/styled.js +1 -0
  14. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsEmpty/styled.js +1 -0
  15. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsError/styled.js +1 -0
  16. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/styled.js +5 -4
  17. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultsList.js +2 -3
  18. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/styled.js +4 -3
  19. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsLoading/styled.js +3 -3
  20. package/dist/cjs/components/WhatsNew/WhatsNewResults/styled.js +4 -3
  21. package/dist/cjs/components/constants.js +8 -8
  22. package/dist/cjs/components/contexts/navigationContext.js +122 -130
  23. package/dist/cjs/components/contexts/searchContext.js +28 -30
  24. package/dist/cjs/components/contexts/whatsNewArticleContext.js +51 -53
  25. package/dist/cjs/components/styled.js +3 -3
  26. package/dist/cjs/model/Article.js +4 -4
  27. package/dist/cjs/model/Help.js +4 -4
  28. package/dist/cjs/model/Requests.js +4 -4
  29. package/dist/cjs/model/WhatsNew.js +4 -4
  30. package/dist/cjs/util/styled.js +3 -2
  31. package/dist/cjs/version.json +1 -1
  32. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/styled.js +2 -3
  33. package/dist/es2019/components/Article/WhatsNewArticle/styled.js +8 -8
  34. package/dist/es2019/components/Article/styled.js +1 -2
  35. package/dist/es2019/components/ArticlesList/ArticlesListItem/styled.js +7 -7
  36. package/dist/es2019/components/ArticlesList/styled.js +1 -2
  37. package/dist/es2019/components/HelpContentButton/styled.js +6 -7
  38. package/dist/es2019/components/RelatedArticles/styled.js +5 -5
  39. package/dist/es2019/components/Search/SearchInput/styled.js +8 -9
  40. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/styled.js +4 -5
  41. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultsList.js +2 -3
  42. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/styled.js +5 -4
  43. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsLoading/styled.js +2 -4
  44. package/dist/es2019/components/WhatsNew/WhatsNewResults/styled.js +3 -3
  45. package/dist/es2019/components/constants.js +8 -8
  46. package/dist/es2019/components/styled.js +1 -2
  47. package/dist/es2019/model/Article.js +3 -3
  48. package/dist/es2019/model/Help.js +3 -3
  49. package/dist/es2019/model/Requests.js +3 -3
  50. package/dist/es2019/model/WhatsNew.js +3 -3
  51. package/dist/es2019/util/styled.js +4 -4
  52. package/dist/es2019/version.json +1 -1
  53. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/styled.js +2 -3
  54. package/dist/esm/components/Article/WhatsNewArticle/styled.js +7 -7
  55. package/dist/esm/components/Article/styled.js +1 -2
  56. package/dist/esm/components/ArticlesList/ArticlesListItem/styled.js +5 -5
  57. package/dist/esm/components/ArticlesList/styled.js +1 -2
  58. package/dist/esm/components/HelpContentButton/styled.js +4 -5
  59. package/dist/esm/components/RelatedArticles/index.js +28 -30
  60. package/dist/esm/components/RelatedArticles/styled.js +4 -4
  61. package/dist/esm/components/Search/SearchInput/styled.js +2 -3
  62. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/styled.js +4 -5
  63. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultsList.js +2 -3
  64. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/styled.js +4 -4
  65. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsLoading/styled.js +2 -4
  66. package/dist/esm/components/WhatsNew/WhatsNewResults/styled.js +3 -3
  67. package/dist/esm/components/constants.js +8 -8
  68. package/dist/esm/components/contexts/navigationContext.js +122 -130
  69. package/dist/esm/components/contexts/searchContext.js +28 -30
  70. package/dist/esm/components/contexts/whatsNewArticleContext.js +51 -53
  71. package/dist/esm/components/styled.js +2 -3
  72. package/dist/esm/model/Article.js +3 -3
  73. package/dist/esm/model/Help.js +3 -3
  74. package/dist/esm/model/Requests.js +3 -3
  75. package/dist/esm/model/WhatsNew.js +3 -3
  76. package/dist/esm/util/styled.js +2 -2
  77. package/dist/esm/version.json +1 -1
  78. package/package.json +21 -21
  79. package/tmp/api-report-tmp.d.ts +0 -300
@@ -41,61 +41,59 @@ export var WhatsNewArticleProvider = function WhatsNewArticleProvider(_ref) {
41
41
  _results,
42
42
  _args = arguments;
43
43
  return _regeneratorRuntime.wrap(function _callee$(_context) {
44
- while (1) {
45
- switch (_context.prev = _context.next) {
46
- case 0:
47
- filter = _args.length > 0 && _args[0] !== undefined ? _args[0] : '';
48
- numberOfItems = _args.length > 1 && _args[1] !== undefined ? _args[1] : NUMBER_OF_WHATS_NEW_ITEMS_PER_PAGE;
49
- page = _args.length > 2 && _args[2] !== undefined ? _args[2] : '';
50
- setWhatsNewSearchType(filter);
51
- if (!onSearchWhatsNewArticles) {
52
- _context.next = 28;
53
- break;
54
- }
55
- _context.prev = 5;
56
- setSearchWhatsNewArticlesState(REQUEST_STATE.loading);
57
- // If the filter type hasn't change, then we are loading an extra page
58
- if (!(filter === whatsNewSearchType && page !== '')) {
59
- _context.next = 14;
60
- break;
61
- }
62
- _context.next = 10;
63
- return onSearchWhatsNewArticles(filter, numberOfItems, page);
64
- case 10:
65
- results = _context.sent;
66
- setSearchWhatsNewArticlesResult({
67
- articles: [].concat(_toConsumableArray(searchWhatsNewArticlesResult !== null && searchWhatsNewArticlesResult !== void 0 && searchWhatsNewArticlesResult.articles ? searchWhatsNewArticlesResult.articles : []), _toConsumableArray(results.articles)),
68
- hasNextPage: results.hasNextPage,
69
- nextPage: results.nextPage
70
- });
71
- _context.next = 19;
44
+ while (1) switch (_context.prev = _context.next) {
45
+ case 0:
46
+ filter = _args.length > 0 && _args[0] !== undefined ? _args[0] : '';
47
+ numberOfItems = _args.length > 1 && _args[1] !== undefined ? _args[1] : NUMBER_OF_WHATS_NEW_ITEMS_PER_PAGE;
48
+ page = _args.length > 2 && _args[2] !== undefined ? _args[2] : '';
49
+ setWhatsNewSearchType(filter);
50
+ if (!onSearchWhatsNewArticles) {
51
+ _context.next = 28;
72
52
  break;
73
- case 14:
74
- // new search
75
- setSearchWhatsNewArticlesResult(null);
76
- _context.next = 17;
77
- return onSearchWhatsNewArticles(filter, numberOfItems, page);
78
- case 17:
79
- _results = _context.sent;
80
- setSearchWhatsNewArticlesResult(_results);
81
- case 19:
82
- setSearchWhatsNewArticlesState(REQUEST_STATE.done);
83
- _context.next = 26;
53
+ }
54
+ _context.prev = 5;
55
+ setSearchWhatsNewArticlesState(REQUEST_STATE.loading);
56
+ // If the filter type hasn't change, then we are loading an extra page
57
+ if (!(filter === whatsNewSearchType && page !== '')) {
58
+ _context.next = 14;
84
59
  break;
85
- case 22:
86
- _context.prev = 22;
87
- _context.t0 = _context["catch"](5);
88
- setSearchWhatsNewArticlesResult(null);
89
- setSearchWhatsNewArticlesState(REQUEST_STATE.error);
90
- case 26:
91
- _context.next = 29;
92
- break;
93
- case 28:
94
- setSearchWhatsNewArticlesState(REQUEST_STATE.error);
95
- case 29:
96
- case "end":
97
- return _context.stop();
98
- }
60
+ }
61
+ _context.next = 10;
62
+ return onSearchWhatsNewArticles(filter, numberOfItems, page);
63
+ case 10:
64
+ results = _context.sent;
65
+ setSearchWhatsNewArticlesResult({
66
+ articles: [].concat(_toConsumableArray(searchWhatsNewArticlesResult !== null && searchWhatsNewArticlesResult !== void 0 && searchWhatsNewArticlesResult.articles ? searchWhatsNewArticlesResult.articles : []), _toConsumableArray(results.articles)),
67
+ hasNextPage: results.hasNextPage,
68
+ nextPage: results.nextPage
69
+ });
70
+ _context.next = 19;
71
+ break;
72
+ case 14:
73
+ // new search
74
+ setSearchWhatsNewArticlesResult(null);
75
+ _context.next = 17;
76
+ return onSearchWhatsNewArticles(filter, numberOfItems, page);
77
+ case 17:
78
+ _results = _context.sent;
79
+ setSearchWhatsNewArticlesResult(_results);
80
+ case 19:
81
+ setSearchWhatsNewArticlesState(REQUEST_STATE.done);
82
+ _context.next = 26;
83
+ break;
84
+ case 22:
85
+ _context.prev = 22;
86
+ _context.t0 = _context["catch"](5);
87
+ setSearchWhatsNewArticlesResult(null);
88
+ setSearchWhatsNewArticlesState(REQUEST_STATE.error);
89
+ case 26:
90
+ _context.next = 29;
91
+ break;
92
+ case 28:
93
+ setSearchWhatsNewArticlesState(REQUEST_STATE.error);
94
+ case 29:
95
+ case "end":
96
+ return _context.stop();
99
97
  }
100
98
  }, _callee, null, [[5, 22]]);
101
99
  })), [onSearchWhatsNewArticles, whatsNewSearchType, searchWhatsNewArticlesResult]);
@@ -3,11 +3,10 @@ var _templateObject, _templateObject2, _templateObject3;
3
3
  /** @jsx jsx */
4
4
 
5
5
  import styled from '@emotion/styled';
6
- import { gridSize } from '@atlaskit/theme/constants';
7
6
  export var HelpBodyContainer = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n flex-grow: 1;\n min-height: 0;\n position: relative;\n overflow-y: auto;\n overflow-x: hidden;\n display: flex;\n flex-direction: column;\n flex-wrap: nowrap;\n justify-content: flex-start;\n align-content: stretch;\n align-items: flex-start;\n"])));
8
7
  export var HelpBody = styled.div(_templateObject2 || (_templateObject2 = _taggedTemplateLiteral(["\n width: 100%;\n box-sizing: border-box;\n order: 0;\n flex: 1 1 auto;\n align-self: auto;\n position: relative;\n overflow-x: hidden;\n overflow-y: auto;\n"])));
9
- export var Home = styled.div(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n display: ", ";\n height: 100%;\n overflow: ", ";\n padding: ", "px;\n box-sizing: border-box;\n"])), function (props) {
8
+ export var Home = styled.div(_templateObject3 || (_templateObject3 = _taggedTemplateLiteral(["\n display: ", ";\n height: 100%;\n overflow: ", ";\n padding: ", ";\n box-sizing: border-box;\n"])), function (props) {
10
9
  return props.isOverlayFullyVisible ? 'none' : 'block';
11
10
  }, function (props) {
12
11
  return props.isOverlayVisible ? 'hidden' : 'auto';
13
- }, gridSize() * 2);
12
+ }, "var(--ds-space-200, 16px)");
@@ -1,5 +1,5 @@
1
1
  // TODO - Check if we need to delete this
2
- export var ARTICLE_ITEM_TYPES;
3
- (function (ARTICLE_ITEM_TYPES) {
2
+ export var ARTICLE_ITEM_TYPES = /*#__PURE__*/function (ARTICLE_ITEM_TYPES) {
4
3
  ARTICLE_ITEM_TYPES["topicInProduct"] = "topicInProduct";
5
- })(ARTICLE_ITEM_TYPES || (ARTICLE_ITEM_TYPES = {}));
4
+ return ARTICLE_ITEM_TYPES;
5
+ }({});
@@ -1,6 +1,6 @@
1
1
  import { ArticleItem } from './Article';
2
- export var ARTICLE_TYPE;
3
- (function (ARTICLE_TYPE) {
2
+ export var ARTICLE_TYPE = /*#__PURE__*/function (ARTICLE_TYPE) {
4
3
  ARTICLE_TYPE["HELP_ARTICLE"] = "HELP_ARTICLE";
5
4
  ARTICLE_TYPE["WHATS_NEW"] = "WHATS_NEW";
6
- })(ARTICLE_TYPE || (ARTICLE_TYPE = {}));
5
+ return ARTICLE_TYPE;
6
+ }({});
@@ -1,8 +1,8 @@
1
- export var REQUEST_STATE;
2
- (function (REQUEST_STATE) {
1
+ export var REQUEST_STATE = /*#__PURE__*/function (REQUEST_STATE) {
3
2
  REQUEST_STATE["done"] = "done";
4
3
  REQUEST_STATE["loading"] = "loading";
5
4
  REQUEST_STATE["load"] = "load";
6
5
  REQUEST_STATE["error"] = "error";
7
6
  REQUEST_STATE["reload"] = "reload";
8
- })(REQUEST_STATE || (REQUEST_STATE = {}));
7
+ return REQUEST_STATE;
8
+ }({});
@@ -1,8 +1,8 @@
1
- export var WHATS_NEW_ITEM_TYPES;
2
- (function (WHATS_NEW_ITEM_TYPES) {
1
+ export var WHATS_NEW_ITEM_TYPES = /*#__PURE__*/function (WHATS_NEW_ITEM_TYPES) {
3
2
  WHATS_NEW_ITEM_TYPES["NEW_FEATURE"] = "Announcement";
4
3
  WHATS_NEW_ITEM_TYPES["IMPROVEMENT"] = "Improvement";
5
4
  WHATS_NEW_ITEM_TYPES["FIX"] = "Fix";
6
5
  WHATS_NEW_ITEM_TYPES["REMOVED"] = "Removed";
7
6
  WHATS_NEW_ITEM_TYPES["EXPERIMENT"] = "Experiment";
8
- })(WHATS_NEW_ITEM_TYPES || (WHATS_NEW_ITEM_TYPES = {}));
7
+ return WHATS_NEW_ITEM_TYPES;
8
+ }({});
@@ -7,7 +7,7 @@ import { gridSize } from '@atlaskit/theme/constants';
7
7
  import * as colors from '@atlaskit/theme/colors';
8
8
  import { keyframes } from '@emotion/core';
9
9
  import { WHATS_NEW_ITEM_TYPES } from '../model/WhatsNew';
10
- export var DividerLine = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n background-color: ", ";\n height: 2px;\n width: 100%;\n padding: 0 ", "px;\n margin-top: ", "px;\n box-sizing: border-box;\n"])), "var(--ds-border, ".concat(colors.N30A, ")"), 2 * gridSize(), gridSize() * 2);
10
+ export var DividerLine = styled.div(_templateObject || (_templateObject = _taggedTemplateLiteral(["\n background-color: ", ";\n height: 2px;\n width: 100%;\n padding: 0 ", ";\n margin-top: ", ";\n box-sizing: border-box;\n"])), "var(--ds-border, ".concat(colors.N30A, ")"), "var(--ds-space-200, 16px)", "var(--ds-space-200, 16px)");
11
11
 
12
12
  /**
13
13
  * Loading container
@@ -38,7 +38,7 @@ export var LoadingCircle = styled.div(_templateObject4 || (_templateObject4 = _t
38
38
  * What's new icon
39
39
  */
40
40
 
41
- export var WhatsNewTypeIcon = styled.div(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n display: inline-block;\n vertical-align: middle;\n position: relative;\n height: ", "px;\n width: ", "px;\n border-radius: 2px;\n background-color: ", ";\n\n & > img {\n width: calc(100% - ", "px);\n height: calc(100% - ", "px);\n position: absolute;\n left: 50%;\n top: 50%;\n transform: translate(-50%, -50%);\n\n & > svg {\n height: 100%;\n width: 100%;\n }\n }\n"])), gridSize() * 2, gridSize() * 2, function (_ref) {
41
+ export var WhatsNewTypeIcon = styled.div(_templateObject5 || (_templateObject5 = _taggedTemplateLiteral(["\n display: inline-block;\n vertical-align: middle;\n position: relative;\n height: ", ";\n width: ", ";\n border-radius: 2px;\n background-color: ", ";\n\n & > img {\n width: calc(100% - ", "px);\n height: calc(100% - ", "px);\n position: absolute;\n left: 50%;\n top: 50%;\n transform: translate(-50%, -50%);\n\n & > svg {\n height: 100%;\n width: 100%;\n }\n }\n"])), "var(--ds-space-200, 16px)", "var(--ds-space-200, 16px)", function (_ref) {
42
42
  var type = _ref.type;
43
43
  switch (type) {
44
44
  case WHATS_NEW_ITEM_TYPES.IMPROVEMENT:
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.1.26",
3
+ "version": "7.2.0",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.1.26",
3
+ "version": "7.2.0",
4
4
  "description": "A cross-product help component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -26,25 +26,25 @@
26
26
  "ak-postbuild": "ls -d dist/* | xargs -n 1 copyfiles -u 1 -V src/**/*.svg"
27
27
  },
28
28
  "dependencies": {
29
- "@atlaskit/analytics": "^8.0.0",
30
- "@atlaskit/analytics-next": "^9.0.0",
31
- "@atlaskit/button": "^16.5.0",
32
- "@atlaskit/checkbox": "^12.4.0",
33
- "@atlaskit/form": "^8.8.0",
34
- "@atlaskit/help-article": "^4.0.0",
35
- "@atlaskit/help-layout": "^4.1.0",
36
- "@atlaskit/icon": "^21.11.0",
37
- "@atlaskit/notification-indicator": "^9.0.0",
38
- "@atlaskit/notification-log-client": "^6.0.0",
39
- "@atlaskit/radio": "^5.4.0",
40
- "@atlaskit/section-message": "^6.3.0",
41
- "@atlaskit/select": "^16.1.0",
42
- "@atlaskit/spinner": "^15.3.0",
43
- "@atlaskit/textarea": "^4.5.0",
44
- "@atlaskit/textfield": "^5.3.0",
45
- "@atlaskit/theme": "^12.2.0",
46
- "@atlaskit/tokens": "^1.2.0",
47
- "@atlaskit/tooltip": "^17.6.0",
29
+ "@atlaskit/analytics": "^8.1.0",
30
+ "@atlaskit/analytics-next": "^9.1.0",
31
+ "@atlaskit/button": "^16.7.0",
32
+ "@atlaskit/checkbox": "^12.5.0",
33
+ "@atlaskit/form": "^8.11.0",
34
+ "@atlaskit/help-article": "^4.1.0",
35
+ "@atlaskit/help-layout": "^4.2.0",
36
+ "@atlaskit/icon": "^21.12.0",
37
+ "@atlaskit/notification-indicator": "^9.1.0",
38
+ "@atlaskit/notification-log-client": "^6.1.0",
39
+ "@atlaskit/radio": "^5.5.0",
40
+ "@atlaskit/section-message": "^6.4.0",
41
+ "@atlaskit/select": "^16.2.0",
42
+ "@atlaskit/spinner": "^15.5.0",
43
+ "@atlaskit/textarea": "^4.6.0",
44
+ "@atlaskit/textfield": "^5.4.0",
45
+ "@atlaskit/theme": "^12.5.0",
46
+ "@atlaskit/tokens": "^1.3.0",
47
+ "@atlaskit/tooltip": "^17.8.0",
48
48
  "@babel/runtime": "^7.0.0",
49
49
  "@emotion/core": "^10.0.9",
50
50
  "@emotion/styled": "^10.0.7",
@@ -62,7 +62,7 @@
62
62
  "devDependencies": {
63
63
  "@atlaskit/docs": "*",
64
64
  "@atlaskit/navigation": "^37.0.0",
65
- "@atlaskit/page": "^12.2.0",
65
+ "@atlaskit/page": "^12.3.0",
66
66
  "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
67
67
  "@testing-library/react": "^12.1.5",
68
68
  "algoliasearch": "^3.35.1",
@@ -1,300 +0,0 @@
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
- ```