@atlaskit/help 7.3.1 → 7.3.3

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 (54) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/dist/cjs/analytics.js +1 -1
  3. package/dist/cjs/components/Article/ArticleLoadingFail/index.js +1 -1
  4. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  5. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  6. package/dist/cjs/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  7. package/dist/cjs/components/Article/HelpArticle/index.js +1 -1
  8. package/dist/cjs/components/Article/WhatsNewArticle/index.js +1 -1
  9. package/dist/cjs/components/ArticlesList/ArticlesListItem/index.js +1 -1
  10. package/dist/cjs/components/ArticlesList/ArticlesListItem/styled.js +1 -1
  11. package/dist/cjs/components/HelpContentButton/index.js +1 -1
  12. package/dist/cjs/components/RelatedArticles/index.js +1 -1
  13. package/dist/cjs/components/Search/SearchInput/index.js +1 -1
  14. package/dist/cjs/components/WhatsNew/WhatsNewButton/index.js +1 -1
  15. package/dist/cjs/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  16. package/dist/cjs/components/contexts/navigationContext.js +29 -10
  17. package/dist/cjs/components/contexts/searchContext.js +0 -1
  18. package/dist/es2019/analytics.js +1 -1
  19. package/dist/es2019/components/Article/ArticleLoadingFail/index.js +1 -1
  20. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  21. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  22. package/dist/es2019/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  23. package/dist/es2019/components/Article/HelpArticle/index.js +1 -1
  24. package/dist/es2019/components/Article/WhatsNewArticle/index.js +1 -1
  25. package/dist/es2019/components/ArticlesList/ArticlesListItem/index.js +1 -1
  26. package/dist/es2019/components/ArticlesList/ArticlesListItem/styled.js +1 -1
  27. package/dist/es2019/components/HelpContentButton/index.js +1 -1
  28. package/dist/es2019/components/RelatedArticles/index.js +1 -1
  29. package/dist/es2019/components/Search/SearchInput/index.js +1 -1
  30. package/dist/es2019/components/WhatsNew/WhatsNewButton/index.js +1 -1
  31. package/dist/es2019/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  32. package/dist/es2019/components/contexts/navigationContext.js +29 -10
  33. package/dist/es2019/components/contexts/searchContext.js +0 -1
  34. package/dist/esm/analytics.js +1 -1
  35. package/dist/esm/components/Article/ArticleLoadingFail/index.js +1 -1
  36. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulNoButton.js +1 -1
  37. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/WasHelpfulYesButton.js +1 -1
  38. package/dist/esm/components/Article/HelpArticle/WasHelpfulForm/index.js +1 -1
  39. package/dist/esm/components/Article/HelpArticle/index.js +1 -1
  40. package/dist/esm/components/Article/WhatsNewArticle/index.js +1 -1
  41. package/dist/esm/components/ArticlesList/ArticlesListItem/index.js +1 -1
  42. package/dist/esm/components/ArticlesList/ArticlesListItem/styled.js +1 -1
  43. package/dist/esm/components/HelpContentButton/index.js +1 -1
  44. package/dist/esm/components/RelatedArticles/index.js +1 -1
  45. package/dist/esm/components/Search/SearchInput/index.js +1 -1
  46. package/dist/esm/components/WhatsNew/WhatsNewButton/index.js +1 -1
  47. package/dist/esm/components/WhatsNew/WhatsNewResults/WhatsNewResultsList/WhatsNewResultItem/index.js +1 -1
  48. package/dist/esm/components/contexts/navigationContext.js +29 -10
  49. package/dist/esm/components/contexts/searchContext.js +0 -1
  50. package/dist/types/components/contexts/navigationContext.d.ts +5 -5
  51. package/dist/types/components/contexts/searchContext.d.ts +1 -1
  52. package/dist/types-ts4.5/components/contexts/navigationContext.d.ts +5 -5
  53. package/dist/types-ts4.5/components/contexts/searchContext.d.ts +1 -1
  54. package/package.json +2 -2
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @atlaskit/help
2
2
 
3
+ ## 7.3.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [#99831](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/99831)
8
+ [`9652182a0292`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/9652182a0292) -
9
+ Fix issue where the back button used to lose context of the search results and takes back to the
10
+ default page. Now it takes back to the place where the user started from
11
+ - [#99831](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/99831)
12
+ [`e5fd89bc770c`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/e5fd89bc770c) -
13
+ Fix individual scroll bars appearing for titles when an external URL icon is present in safari
14
+
15
+ ## 7.3.2
16
+
17
+ ### Patch Changes
18
+
19
+ - [#99227](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/99227)
20
+ [`3b95bb1a838e`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/3b95bb1a838e) -
21
+ Fix issue where opening articles in new tab leads to the IPH panel remaining blank
22
+
3
23
  ## 7.3.1
4
24
 
5
25
  ### Patch Changes
@@ -14,5 +14,5 @@ var createAndFire = exports.createAndFire = x.createAndFireEvent('atlaskit');
14
14
  var defaultAnalyticsAttributes = exports.defaultAnalyticsAttributes = {
15
15
  componentName: 'help',
16
16
  packageName: "@atlaskit/help",
17
- packageVersion: "7.3.1"
17
+ packageVersion: "7.3.3"
18
18
  };
@@ -15,7 +15,7 @@ var _styled = require("./styled");
15
15
  var ANALYTICS_CONTEXT_DATA = {
16
16
  componentName: 'ArticleLoadingFail',
17
17
  packageName: "@atlaskit/help",
18
- packageVersion: "7.3.1"
18
+ packageVersion: "7.3.3"
19
19
  };
20
20
  var ArticleLoadingFail = exports.ArticleLoadingFail = function ArticleLoadingFail(_ref) {
21
21
  var onTryAgainButtonClick = _ref.onTryAgainButtonClick,
@@ -13,7 +13,7 @@ var _messages = require("../../../../messages");
13
13
  var ANALYTICS_CONTEXT_DATA = {
14
14
  componentName: 'ArticleWasHelpfulNoButton',
15
15
  packageName: "@atlaskit/help",
16
- packageVersion: "7.3.1"
16
+ packageVersion: "7.3.3"
17
17
  };
18
18
  var ArticleWasHelpfulNoButton = exports.ArticleWasHelpfulNoButton = function ArticleWasHelpfulNoButton(_ref) {
19
19
  var _ref$isSelected = _ref.isSelected,
@@ -13,7 +13,7 @@ var _messages = require("../../../../messages");
13
13
  var ANALYTICS_CONTEXT_DATA = {
14
14
  componentName: 'ArticleWasHelpfulYesButton',
15
15
  packageName: "@atlaskit/help",
16
- packageVersion: "7.3.1"
16
+ packageVersion: "7.3.3"
17
17
  };
18
18
  var ArticleWasHelpfulYesButton = exports.ArticleWasHelpfulYesButton = function ArticleWasHelpfulYesButton(_ref) {
19
19
  var _ref$isSelected = _ref.isSelected,
@@ -37,7 +37,7 @@ var FEEDBACK_REASON_TEXT_MAX_LENGTH = '16000';
37
37
  var ANALYTICS_CONTEXT_DATA = {
38
38
  componentName: 'ArticleWasHelpfulForm',
39
39
  packageName: "@atlaskit/help",
40
- packageVersion: "7.3.1"
40
+ packageVersion: "7.3.3"
41
41
  };
42
42
  var ArticleWasHelpfulForm = exports.ArticleWasHelpfulForm = function ArticleWasHelpfulForm(_ref) {
43
43
  var onWasHelpfulSubmit = _ref.onWasHelpfulSubmit,
@@ -64,7 +64,7 @@ var HelpArticle = exports.HelpArticle = function HelpArticle(_ref) {
64
64
  analyticsEvent.payload.attributes = {
65
65
  componentName: 'Article',
66
66
  packageName: "@atlaskit/help",
67
- packageVersion: "7.3.1"
67
+ packageVersion: "7.3.3"
68
68
  };
69
69
  if (onRelatedArticlesShowMoreClick) {
70
70
  onRelatedArticlesShowMoreClick(event, analyticsEvent, isCollapsed);
@@ -22,7 +22,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
22
22
  var analyticsContextData = {
23
23
  componentName: 'ArticlesListItem',
24
24
  packageName: "@atlaskit/help",
25
- packageVersion: "7.3.1"
25
+ packageVersion: "7.3.3"
26
26
  };
27
27
  var WhatsNewArticle = exports.WhatsNewArticle = function WhatsNewArticle(_ref) {
28
28
  var formatMessage = _ref.intl.formatMessage,
@@ -17,7 +17,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
17
17
  var ANALYTICS_CONTEXT_DATA = {
18
18
  componentName: 'ArticlesListItem',
19
19
  packageName: "@atlaskit/help",
20
- packageVersion: "7.3.1"
20
+ packageVersion: "7.3.3"
21
21
  };
22
22
  var ArticlesListItem = exports.ArticlesListItem = function ArticlesListItem(_ref) {
23
23
  var styles = _ref.styles,
@@ -61,7 +61,7 @@ var ArticlesListItemTitleText = exports.ArticlesListItemTitleText = _styled.defa
61
61
  font: "var(--ds-font-heading-xsmall, ".concat(_typography.fontFallback.heading.xsmall, ")"),
62
62
  display: 'inline-block',
63
63
  whiteSpace: 'normal',
64
- overflowX: 'hidden',
64
+ overflow: 'hidden',
65
65
  marginBottom: "var(--ds-space-100, 8px)"
66
66
  });
67
67
  var ArticlesListItemDescription = exports.ArticlesListItemDescription = _styled.default.p({
@@ -17,7 +17,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
17
17
  var analitycsContextData = {
18
18
  componentName: 'HelpContentButton',
19
19
  packageName: "@atlaskit/help",
20
- packageVersion: "7.3.1"
20
+ packageVersion: "7.3.3"
21
21
  };
22
22
  var HelpContentButton = function HelpContentButton(_ref) {
23
23
  var _ref$id = _ref.id,
@@ -28,7 +28,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
28
28
  /** @jsxFrag */
29
29
 
30
30
  var packageName = "@atlaskit/help";
31
- var packageVersion = "7.3.1";
31
+ var packageVersion = "7.3.3";
32
32
  var RelatedArticles = exports.RelatedArticles = function RelatedArticles(_ref) {
33
33
  var _ref$style = _ref.style,
34
34
  style = _ref$style === void 0 ? 'primary' : _ref$style,
@@ -27,7 +27,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
27
27
  var ANALYTICS_CONTEXT_DATA = {
28
28
  componentName: 'searchInput',
29
29
  packageName: "@atlaskit/help",
30
- packageVersion: "7.3.1"
30
+ packageVersion: "7.3.3"
31
31
  };
32
32
  var SearchInput = exports.SearchInput = function SearchInput(_ref) {
33
33
  var formatMessage = _ref.intl.formatMessage;
@@ -21,7 +21,7 @@ function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e;
21
21
  var ANALYTICS_CONTEXT_DATA = {
22
22
  componentName: 'WhatsNewButton',
23
23
  packageName: "@atlaskit/help",
24
- packageVersion: "7.3.1"
24
+ packageVersion: "7.3.3"
25
25
  };
26
26
  var WhatsNewButton = exports.WhatsNewButton = function WhatsNewButton(_ref) {
27
27
  var productName = _ref.productName,
@@ -15,7 +15,7 @@ var _styled2 = require("./styled");
15
15
  var ANALYTICS_CONTEXT_DATA = {
16
16
  componentName: 'ArticlesListItem',
17
17
  packageName: "@atlaskit/help",
18
- packageVersion: "7.3.1"
18
+ packageVersion: "7.3.3"
19
19
  };
20
20
  var WhatsNewResultListItem = exports.WhatsNewResultListItem = function WhatsNewResultListItem(_ref) {
21
21
  var formatMessage = _ref.intl.formatMessage,
@@ -195,13 +195,14 @@ var navigationReducer = function navigationReducer(_ref3, action) {
195
195
  newState = {
196
196
  articleId: _newArticleId2,
197
197
  history: currentHistory,
198
- view: getViewForArticleId(_newArticleId2)
198
+ // If the current view is the search view and the new article id is empty, keep the current view
199
+ view: currentView === _constants.VIEW.SEARCH && _newArticleId2.id === '' ? currentView : getViewForArticleId(_newArticleId2)
199
200
  };
200
201
  } else if (action.type === 'updateView' && action.payload) {
201
202
  var newView = action.payload;
202
203
  newState = {
203
204
  articleId: currentArticleId,
204
- history: currentHistory,
205
+ history: newView === _constants.VIEW.SEARCH ? [] : currentHistory,
205
206
  view: newView
206
207
  };
207
208
  }
@@ -225,7 +226,8 @@ var NavigationContextProvider = exports.NavigationContextProvider = function Nav
225
226
  var _useSearchContext = (0, _searchContext.useSearchContext)(),
226
227
  onSearch = _useSearchContext.onSearch,
227
228
  isSearchResultVisible = _useSearchContext.isSearchResultVisible,
228
- searchValue = _useSearchContext.searchValue;
229
+ searchValue = _useSearchContext.searchValue,
230
+ searchResult = _useSearchContext.searchResult;
229
231
  var _useHeaderContext = (0, _headerContext.useHeaderContext)(),
230
232
  onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
231
233
  var propsArticleId = navigationData.articleId,
@@ -358,6 +360,7 @@ var NavigationContextProvider = exports.NavigationContextProvider = function Nav
358
360
  };
359
361
  }(), []);
360
362
  var navigateBack = (0, _react.useCallback)( /*#__PURE__*/(0, _asyncToGenerator2.default)( /*#__PURE__*/_regenerator.default.mark(function _callee3() {
363
+ var _searchResult$length;
361
364
  return _regenerator.default.wrap(function _callee3$(_context3) {
362
365
  while (1) switch (_context3.prev = _context3.next) {
363
366
  case 0:
@@ -387,10 +390,19 @@ var NavigationContextProvider = exports.NavigationContextProvider = function Nav
387
390
  type: 'removeLastHistoryItem'
388
391
  });
389
392
  } else if (currentHistory.length === 1) {
390
- // but if the history only has one item, clear the history
391
- dispatchNavigationAction({
392
- type: 'removeAllHistoryItems'
393
- });
393
+ // If the search value is not empty and search result is not empty, show the search results
394
+ if (searchValue !== '' && ((_searchResult$length = searchResult === null || searchResult === void 0 ? void 0 : searchResult.length) !== null && _searchResult$length !== void 0 ? _searchResult$length : 0) > 0 && onSearch !== undefined) {
395
+ dispatchNavigationAction({
396
+ type: 'updateView',
397
+ payload: _constants.VIEW.SEARCH
398
+ });
399
+ }
400
+ // If the search value is empty, show the default content
401
+ else {
402
+ dispatchNavigationAction({
403
+ type: 'removeAllHistoryItems'
404
+ });
405
+ }
394
406
  }
395
407
  }
396
408
  case 9:
@@ -398,7 +410,7 @@ var NavigationContextProvider = exports.NavigationContextProvider = function Nav
398
410
  return _context3.stop();
399
411
  }
400
412
  }, _callee3);
401
- })), [currentView, onSearch, currentHistory.length, searchValue, currentArticleId.type]);
413
+ })), [currentView, searchValue, currentArticleId, currentHistory, onSearch, searchResult === null || searchResult === void 0 ? void 0 : searchResult.length]);
402
414
  var onClose = (0, _react.useCallback)(function (event, analyticsEvent) {
403
415
  if (onCloseButtonClick) {
404
416
  dispatchNavigationAction({
@@ -414,13 +426,20 @@ var NavigationContextProvider = exports.NavigationContextProvider = function Nav
414
426
  });
415
427
  }, []);
416
428
  (0, _react.useEffect)(function () {
417
- if (isSearchResultVisible) {
429
+ // If the search result is visible or the search value is not empty, show the search result
430
+ if (isSearchResultVisible || searchValue !== '') {
418
431
  dispatchNavigationAction({
419
432
  type: 'updateView',
420
433
  payload: _constants.VIEW.SEARCH
421
434
  });
435
+ // If the search result is not visible and the search value is empty, show the default content
436
+ } else if (!isSearchResultVisible && searchValue === '') {
437
+ dispatchNavigationAction({
438
+ type: 'updateView',
439
+ payload: _constants.VIEW.DEFAULT_CONTENT
440
+ });
422
441
  }
423
- }, [isSearchResultVisible]);
442
+ }, [isSearchResultVisible, searchValue]);
424
443
  (0, _react.useEffect)(function () {
425
444
  var lastHistoryItem = currentHistory.length > 0 ? _getCurrentArticle2(currentHistory) : getNewHistoryItem(DEFAULT_ARTICLE_ID.id, DEFAULT_ARTICLE_ID.type);
426
445
 
@@ -112,7 +112,6 @@ var SearchContextProvider = exports.SearchContextProvider = function SearchConte
112
112
  if (onSearchResultItemClick) {
113
113
  onSearchResultItemClick(event, analyticsEvent, articleData);
114
114
  }
115
- setSearchResultsVisible(false);
116
115
  };
117
116
  return /*#__PURE__*/_react.default.createElement(CtxProvider, {
118
117
  value: {
@@ -5,5 +5,5 @@ export const createAndFire = x.createAndFireEvent('atlaskit');
5
5
  export const defaultAnalyticsAttributes = {
6
6
  componentName: 'help',
7
7
  packageName: "@atlaskit/help",
8
- packageVersion: "7.3.1"
8
+ packageVersion: "7.3.3"
9
9
  };
@@ -8,7 +8,7 @@ import { LoadingErrorMessage, LoadingErrorButtonContainer } from './styled';
8
8
  const ANALYTICS_CONTEXT_DATA = {
9
9
  componentName: 'ArticleLoadingFail',
10
10
  packageName: "@atlaskit/help",
11
- packageVersion: "7.3.1"
11
+ packageVersion: "7.3.3"
12
12
  };
13
13
  export const ArticleLoadingFail = ({
14
14
  onTryAgainButtonClick,
@@ -6,7 +6,7 @@ import { messages } from '../../../../messages';
6
6
  const ANALYTICS_CONTEXT_DATA = {
7
7
  componentName: 'ArticleWasHelpfulNoButton',
8
8
  packageName: "@atlaskit/help",
9
- packageVersion: "7.3.1"
9
+ packageVersion: "7.3.3"
10
10
  };
11
11
  export const ArticleWasHelpfulNoButton = ({
12
12
  isSelected = false,
@@ -6,7 +6,7 @@ import { messages } from '../../../../messages';
6
6
  const ANALYTICS_CONTEXT_DATA = {
7
7
  componentName: 'ArticleWasHelpfulYesButton',
8
8
  packageName: "@atlaskit/help",
9
- packageVersion: "7.3.1"
9
+ packageVersion: "7.3.3"
10
10
  };
11
11
  export const ArticleWasHelpfulYesButton = ({
12
12
  isSelected = false,
@@ -25,7 +25,7 @@ const FEEDBACK_REASON_TEXT_MAX_LENGTH = '16000';
25
25
  const ANALYTICS_CONTEXT_DATA = {
26
26
  componentName: 'ArticleWasHelpfulForm',
27
27
  packageName: "@atlaskit/help",
28
- packageVersion: "7.3.1"
28
+ packageVersion: "7.3.3"
29
29
  };
30
30
  export const ArticleWasHelpfulForm = ({
31
31
  onWasHelpfulSubmit,
@@ -59,7 +59,7 @@ export const HelpArticle = ({
59
59
  analyticsEvent.payload.attributes = {
60
60
  componentName: 'Article',
61
61
  packageName: "@atlaskit/help",
62
- packageVersion: "7.3.1"
62
+ packageVersion: "7.3.3"
63
63
  };
64
64
  if (onRelatedArticlesShowMoreClick) {
65
65
  onRelatedArticlesShowMoreClick(event, analyticsEvent, isCollapsed);
@@ -13,7 +13,7 @@ import { WhatsNewTypeTitle, WhatsNewTitleText, WhatsNewIconContainer, RelatedLin
13
13
  const analyticsContextData = {
14
14
  componentName: 'ArticlesListItem',
15
15
  packageName: "@atlaskit/help",
16
- packageVersion: "7.3.1"
16
+ packageVersion: "7.3.3"
17
17
  };
18
18
  export const WhatsNewArticle = ({
19
19
  intl: {
@@ -7,7 +7,7 @@ import { ArticlesListItemWrapper, ArticlesListItemContainer, ArticlesListItemTit
7
7
  const ANALYTICS_CONTEXT_DATA = {
8
8
  componentName: 'ArticlesListItem',
9
9
  packageName: "@atlaskit/help",
10
- packageVersion: "7.3.1"
10
+ packageVersion: "7.3.3"
11
11
  };
12
12
  export const ArticlesListItem = ({
13
13
  styles,
@@ -48,7 +48,7 @@ export const ArticlesListItemTitleText = styled.span({
48
48
  font: `var(--ds-font-heading-xsmall, ${fontFallback.heading.xsmall})`,
49
49
  display: 'inline-block',
50
50
  whiteSpace: 'normal',
51
- overflowX: 'hidden',
51
+ overflow: 'hidden',
52
52
  marginBottom: "var(--ds-space-100, 8px)"
53
53
  });
54
54
  export const ArticlesListItemDescription = styled.p({
@@ -7,7 +7,7 @@ import { HelpContentButtonContainer, HelpContentButtonIcon, HelpContentButtonTex
7
7
  const analitycsContextData = {
8
8
  componentName: 'HelpContentButton',
9
9
  packageName: "@atlaskit/help",
10
- packageVersion: "7.3.1"
10
+ packageVersion: "7.3.3"
11
11
  };
12
12
  const HelpContentButton = ({
13
13
  id = '',
@@ -15,7 +15,7 @@ import useCancellablePromise from '../../util/hooks/cancellablePromise';
15
15
  import { usePrevious } from '../../util/hooks/previous';
16
16
  import { jsx } from '@emotion/react';
17
17
  const packageName = "@atlaskit/help";
18
- const packageVersion = "7.3.1";
18
+ const packageVersion = "7.3.3";
19
19
  export const RelatedArticles = ({
20
20
  style = 'primary',
21
21
  routeGroup,
@@ -17,7 +17,7 @@ import { SearchInputContainer, SearchIconContainer, CloseButtonAndSpinnerContain
17
17
  const ANALYTICS_CONTEXT_DATA = {
18
18
  componentName: 'searchInput',
19
19
  packageName: "@atlaskit/help",
20
- packageVersion: "7.3.1"
20
+ packageVersion: "7.3.3"
21
21
  };
22
22
  export const SearchInput = ({
23
23
  intl: {
@@ -11,7 +11,7 @@ import { ARTICLE_TYPE } from '../../../model/Help';
11
11
  const ANALYTICS_CONTEXT_DATA = {
12
12
  componentName: 'WhatsNewButton',
13
13
  packageName: "@atlaskit/help",
14
- packageVersion: "7.3.1"
14
+ packageVersion: "7.3.3"
15
15
  };
16
16
  export const WhatsNewButton = ({
17
17
  productName,
@@ -8,7 +8,7 @@ import { WhatsNewResultListItemWrapper, WhatsNewResultListItemTitleContainer, Wh
8
8
  const ANALYTICS_CONTEXT_DATA = {
9
9
  componentName: 'ArticlesListItem',
10
10
  packageName: "@atlaskit/help",
11
- packageVersion: "7.3.1"
11
+ packageVersion: "7.3.3"
12
12
  };
13
13
  export const WhatsNewResultListItem = ({
14
14
  intl: {
@@ -182,7 +182,8 @@ const navigationReducer = ({
182
182
  newState = {
183
183
  articleId: newArticleId,
184
184
  history: currentHistory,
185
- view: getViewForArticleId(newArticleId)
185
+ // If the current view is the search view and the new article id is empty, keep the current view
186
+ view: currentView === VIEW.SEARCH && newArticleId.id === '' ? currentView : getViewForArticleId(newArticleId)
186
187
  };
187
188
  } else if (action.type === 'updateView' && action.payload) {
188
189
  const {
@@ -190,7 +191,7 @@ const navigationReducer = ({
190
191
  } = action;
191
192
  newState = {
192
193
  articleId: currentArticleId,
193
- history: currentHistory,
194
+ history: newView === VIEW.SEARCH ? [] : currentHistory,
194
195
  view: newView
195
196
  };
196
197
  }
@@ -217,7 +218,8 @@ export const NavigationContextProvider = ({
217
218
  const {
218
219
  onSearch,
219
220
  isSearchResultVisible,
220
- searchValue
221
+ searchValue,
222
+ searchResult
221
223
  } = useSearchContext();
222
224
  const {
223
225
  onCloseButtonClick
@@ -339,13 +341,23 @@ export const NavigationContextProvider = ({
339
341
  type: 'removeLastHistoryItem'
340
342
  });
341
343
  } else if (currentHistory.length === 1) {
342
- // but if the history only has one item, clear the history
343
- dispatchNavigationAction({
344
- type: 'removeAllHistoryItems'
345
- });
344
+ var _searchResult$length;
345
+ // If the search value is not empty and search result is not empty, show the search results
346
+ if (searchValue !== '' && ((_searchResult$length = searchResult === null || searchResult === void 0 ? void 0 : searchResult.length) !== null && _searchResult$length !== void 0 ? _searchResult$length : 0) > 0 && onSearch !== undefined) {
347
+ dispatchNavigationAction({
348
+ type: 'updateView',
349
+ payload: VIEW.SEARCH
350
+ });
351
+ }
352
+ // If the search value is empty, show the default content
353
+ else {
354
+ dispatchNavigationAction({
355
+ type: 'removeAllHistoryItems'
356
+ });
357
+ }
346
358
  }
347
359
  }
348
- }, [currentView, onSearch, currentHistory.length, searchValue, currentArticleId.type]);
360
+ }, [currentView, searchValue, currentArticleId, currentHistory, onSearch, searchResult === null || searchResult === void 0 ? void 0 : searchResult.length]);
349
361
  const onClose = useCallback((event, analyticsEvent) => {
350
362
  if (onCloseButtonClick) {
351
363
  dispatchNavigationAction({
@@ -361,13 +373,20 @@ export const NavigationContextProvider = ({
361
373
  });
362
374
  }, []);
363
375
  useEffect(() => {
364
- if (isSearchResultVisible) {
376
+ // If the search result is visible or the search value is not empty, show the search result
377
+ if (isSearchResultVisible || searchValue !== '') {
365
378
  dispatchNavigationAction({
366
379
  type: 'updateView',
367
380
  payload: VIEW.SEARCH
368
381
  });
382
+ // If the search result is not visible and the search value is empty, show the default content
383
+ } else if (!isSearchResultVisible && searchValue === '') {
384
+ dispatchNavigationAction({
385
+ type: 'updateView',
386
+ payload: VIEW.DEFAULT_CONTENT
387
+ });
369
388
  }
370
- }, [isSearchResultVisible]);
389
+ }, [isSearchResultVisible, searchValue]);
371
390
  useEffect(() => {
372
391
  const lastHistoryItem = currentHistory.length > 0 ? getCurrentArticle(currentHistory) : getNewHistoryItem(DEFAULT_ARTICLE_ID.id, DEFAULT_ARTICLE_ID.type);
373
392
 
@@ -62,7 +62,6 @@ export const SearchContextProvider = ({
62
62
  if (onSearchResultItemClick) {
63
63
  onSearchResultItemClick(event, analyticsEvent, articleData);
64
64
  }
65
- setSearchResultsVisible(false);
66
65
  };
67
66
  return /*#__PURE__*/React.createElement(CtxProvider, {
68
67
  value: {
@@ -5,5 +5,5 @@ export var createAndFire = x.createAndFireEvent('atlaskit');
5
5
  export var defaultAnalyticsAttributes = {
6
6
  componentName: 'help',
7
7
  packageName: "@atlaskit/help",
8
- packageVersion: "7.3.1"
8
+ packageVersion: "7.3.3"
9
9
  };
@@ -8,7 +8,7 @@ import { LoadingErrorMessage, LoadingErrorButtonContainer } from './styled';
8
8
  var ANALYTICS_CONTEXT_DATA = {
9
9
  componentName: 'ArticleLoadingFail',
10
10
  packageName: "@atlaskit/help",
11
- packageVersion: "7.3.1"
11
+ packageVersion: "7.3.3"
12
12
  };
13
13
  export var ArticleLoadingFail = function ArticleLoadingFail(_ref) {
14
14
  var onTryAgainButtonClick = _ref.onTryAgainButtonClick,
@@ -6,7 +6,7 @@ import { messages } from '../../../../messages';
6
6
  var ANALYTICS_CONTEXT_DATA = {
7
7
  componentName: 'ArticleWasHelpfulNoButton',
8
8
  packageName: "@atlaskit/help",
9
- packageVersion: "7.3.1"
9
+ packageVersion: "7.3.3"
10
10
  };
11
11
  export var ArticleWasHelpfulNoButton = function ArticleWasHelpfulNoButton(_ref) {
12
12
  var _ref$isSelected = _ref.isSelected,
@@ -6,7 +6,7 @@ import { messages } from '../../../../messages';
6
6
  var ANALYTICS_CONTEXT_DATA = {
7
7
  componentName: 'ArticleWasHelpfulYesButton',
8
8
  packageName: "@atlaskit/help",
9
- packageVersion: "7.3.1"
9
+ packageVersion: "7.3.3"
10
10
  };
11
11
  export var ArticleWasHelpfulYesButton = function ArticleWasHelpfulYesButton(_ref) {
12
12
  var _ref$isSelected = _ref.isSelected,
@@ -26,7 +26,7 @@ var FEEDBACK_REASON_TEXT_MAX_LENGTH = '16000';
26
26
  var ANALYTICS_CONTEXT_DATA = {
27
27
  componentName: 'ArticleWasHelpfulForm',
28
28
  packageName: "@atlaskit/help",
29
- packageVersion: "7.3.1"
29
+ packageVersion: "7.3.3"
30
30
  };
31
31
  export var ArticleWasHelpfulForm = function ArticleWasHelpfulForm(_ref) {
32
32
  var onWasHelpfulSubmit = _ref.onWasHelpfulSubmit,
@@ -55,7 +55,7 @@ export var HelpArticle = function HelpArticle(_ref) {
55
55
  analyticsEvent.payload.attributes = {
56
56
  componentName: 'Article',
57
57
  packageName: "@atlaskit/help",
58
- packageVersion: "7.3.1"
58
+ packageVersion: "7.3.3"
59
59
  };
60
60
  if (onRelatedArticlesShowMoreClick) {
61
61
  onRelatedArticlesShowMoreClick(event, analyticsEvent, isCollapsed);
@@ -13,7 +13,7 @@ import { WhatsNewTypeTitle, WhatsNewTitleText, WhatsNewIconContainer, RelatedLin
13
13
  var analyticsContextData = {
14
14
  componentName: 'ArticlesListItem',
15
15
  packageName: "@atlaskit/help",
16
- packageVersion: "7.3.1"
16
+ packageVersion: "7.3.3"
17
17
  };
18
18
  export var WhatsNewArticle = function WhatsNewArticle(_ref) {
19
19
  var formatMessage = _ref.intl.formatMessage,
@@ -7,7 +7,7 @@ import { ArticlesListItemWrapper, ArticlesListItemContainer, ArticlesListItemTit
7
7
  var ANALYTICS_CONTEXT_DATA = {
8
8
  componentName: 'ArticlesListItem',
9
9
  packageName: "@atlaskit/help",
10
- packageVersion: "7.3.1"
10
+ packageVersion: "7.3.3"
11
11
  };
12
12
  export var ArticlesListItem = function ArticlesListItem(_ref) {
13
13
  var styles = _ref.styles,
@@ -50,7 +50,7 @@ export var ArticlesListItemTitleText = styled.span({
50
50
  font: "var(--ds-font-heading-xsmall, ".concat(fontFallback.heading.xsmall, ")"),
51
51
  display: 'inline-block',
52
52
  whiteSpace: 'normal',
53
- overflowX: 'hidden',
53
+ overflow: 'hidden',
54
54
  marginBottom: "var(--ds-space-100, 8px)"
55
55
  });
56
56
  export var ArticlesListItemDescription = styled.p({
@@ -7,7 +7,7 @@ import { HelpContentButtonContainer, HelpContentButtonIcon, HelpContentButtonTex
7
7
  var analitycsContextData = {
8
8
  componentName: 'HelpContentButton',
9
9
  packageName: "@atlaskit/help",
10
- packageVersion: "7.3.1"
10
+ packageVersion: "7.3.3"
11
11
  };
12
12
  var HelpContentButton = function HelpContentButton(_ref) {
13
13
  var _ref$id = _ref.id,
@@ -18,7 +18,7 @@ import useCancellablePromise from '../../util/hooks/cancellablePromise';
18
18
  import { usePrevious } from '../../util/hooks/previous';
19
19
  import { jsx } from '@emotion/react';
20
20
  var packageName = "@atlaskit/help";
21
- var packageVersion = "7.3.1";
21
+ var packageVersion = "7.3.3";
22
22
  export var RelatedArticles = function RelatedArticles(_ref) {
23
23
  var _ref$style = _ref.style,
24
24
  style = _ref$style === void 0 ? 'primary' : _ref$style,
@@ -17,7 +17,7 @@ import { SearchInputContainer, SearchIconContainer, CloseButtonAndSpinnerContain
17
17
  var ANALYTICS_CONTEXT_DATA = {
18
18
  componentName: 'searchInput',
19
19
  packageName: "@atlaskit/help",
20
- packageVersion: "7.3.1"
20
+ packageVersion: "7.3.3"
21
21
  };
22
22
  export var SearchInput = function SearchInput(_ref) {
23
23
  var formatMessage = _ref.intl.formatMessage;
@@ -11,7 +11,7 @@ import { ARTICLE_TYPE } from '../../../model/Help';
11
11
  var ANALYTICS_CONTEXT_DATA = {
12
12
  componentName: 'WhatsNewButton',
13
13
  packageName: "@atlaskit/help",
14
- packageVersion: "7.3.1"
14
+ packageVersion: "7.3.3"
15
15
  };
16
16
  export var WhatsNewButton = function WhatsNewButton(_ref) {
17
17
  var productName = _ref.productName,
@@ -8,7 +8,7 @@ import { WhatsNewResultListItemWrapper, WhatsNewResultListItemTitleContainer, Wh
8
8
  var ANALYTICS_CONTEXT_DATA = {
9
9
  componentName: 'ArticlesListItem',
10
10
  packageName: "@atlaskit/help",
11
- packageVersion: "7.3.1"
11
+ packageVersion: "7.3.3"
12
12
  };
13
13
  export var WhatsNewResultListItem = function WhatsNewResultListItem(_ref) {
14
14
  var formatMessage = _ref.intl.formatMessage,
@@ -186,13 +186,14 @@ var navigationReducer = function navigationReducer(_ref3, action) {
186
186
  newState = {
187
187
  articleId: _newArticleId2,
188
188
  history: currentHistory,
189
- view: getViewForArticleId(_newArticleId2)
189
+ // If the current view is the search view and the new article id is empty, keep the current view
190
+ view: currentView === VIEW.SEARCH && _newArticleId2.id === '' ? currentView : getViewForArticleId(_newArticleId2)
190
191
  };
191
192
  } else if (action.type === 'updateView' && action.payload) {
192
193
  var newView = action.payload;
193
194
  newState = {
194
195
  articleId: currentArticleId,
195
- history: currentHistory,
196
+ history: newView === VIEW.SEARCH ? [] : currentHistory,
196
197
  view: newView
197
198
  };
198
199
  }
@@ -216,7 +217,8 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
216
217
  var _useSearchContext = useSearchContext(),
217
218
  onSearch = _useSearchContext.onSearch,
218
219
  isSearchResultVisible = _useSearchContext.isSearchResultVisible,
219
- searchValue = _useSearchContext.searchValue;
220
+ searchValue = _useSearchContext.searchValue,
221
+ searchResult = _useSearchContext.searchResult;
220
222
  var _useHeaderContext = useHeaderContext(),
221
223
  onCloseButtonClick = _useHeaderContext.onCloseButtonClick;
222
224
  var propsArticleId = navigationData.articleId,
@@ -349,6 +351,7 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
349
351
  };
350
352
  }(), []);
351
353
  var navigateBack = useCallback( /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
354
+ var _searchResult$length;
352
355
  return _regeneratorRuntime.wrap(function _callee3$(_context3) {
353
356
  while (1) switch (_context3.prev = _context3.next) {
354
357
  case 0:
@@ -378,10 +381,19 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
378
381
  type: 'removeLastHistoryItem'
379
382
  });
380
383
  } else if (currentHistory.length === 1) {
381
- // but if the history only has one item, clear the history
382
- dispatchNavigationAction({
383
- type: 'removeAllHistoryItems'
384
- });
384
+ // If the search value is not empty and search result is not empty, show the search results
385
+ if (searchValue !== '' && ((_searchResult$length = searchResult === null || searchResult === void 0 ? void 0 : searchResult.length) !== null && _searchResult$length !== void 0 ? _searchResult$length : 0) > 0 && onSearch !== undefined) {
386
+ dispatchNavigationAction({
387
+ type: 'updateView',
388
+ payload: VIEW.SEARCH
389
+ });
390
+ }
391
+ // If the search value is empty, show the default content
392
+ else {
393
+ dispatchNavigationAction({
394
+ type: 'removeAllHistoryItems'
395
+ });
396
+ }
385
397
  }
386
398
  }
387
399
  case 9:
@@ -389,7 +401,7 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
389
401
  return _context3.stop();
390
402
  }
391
403
  }, _callee3);
392
- })), [currentView, onSearch, currentHistory.length, searchValue, currentArticleId.type]);
404
+ })), [currentView, searchValue, currentArticleId, currentHistory, onSearch, searchResult === null || searchResult === void 0 ? void 0 : searchResult.length]);
393
405
  var onClose = useCallback(function (event, analyticsEvent) {
394
406
  if (onCloseButtonClick) {
395
407
  dispatchNavigationAction({
@@ -405,13 +417,20 @@ export var NavigationContextProvider = function NavigationContextProvider(_ref4)
405
417
  });
406
418
  }, []);
407
419
  useEffect(function () {
408
- if (isSearchResultVisible) {
420
+ // If the search result is visible or the search value is not empty, show the search result
421
+ if (isSearchResultVisible || searchValue !== '') {
409
422
  dispatchNavigationAction({
410
423
  type: 'updateView',
411
424
  payload: VIEW.SEARCH
412
425
  });
426
+ // If the search result is not visible and the search value is empty, show the default content
427
+ } else if (!isSearchResultVisible && searchValue === '') {
428
+ dispatchNavigationAction({
429
+ type: 'updateView',
430
+ payload: VIEW.DEFAULT_CONTENT
431
+ });
413
432
  }
414
- }, [isSearchResultVisible]);
433
+ }, [isSearchResultVisible, searchValue]);
415
434
  useEffect(function () {
416
435
  var lastHistoryItem = currentHistory.length > 0 ? _getCurrentArticle2(currentHistory) : getNewHistoryItem(DEFAULT_ARTICLE_ID.id, DEFAULT_ARTICLE_ID.type);
417
436
 
@@ -103,7 +103,6 @@ export var SearchContextProvider = function SearchContextProvider(_ref) {
103
103
  if (onSearchResultItemClick) {
104
104
  onSearchResultItemClick(event, analyticsEvent, articleData);
105
105
  }
106
- setSearchResultsVisible(false);
107
106
  };
108
107
  return /*#__PURE__*/React.createElement(CtxProvider, {
109
108
  value: {
@@ -1,8 +1,8 @@
1
- import React, { PropsWithChildren } from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { Article, ArticleItem } from '../../model/Article';
4
- import { WhatsNewArticleItem, WhatsNewArticle } from '../../model/WhatsNew';
5
- import { HistoryItem, articleId } from '../../model/Help';
1
+ import React, { type PropsWithChildren } from 'react';
2
+ import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import { type Article, type ArticleItem } from '../../model/Article';
4
+ import { type WhatsNewArticleItem, type WhatsNewArticle } from '../../model/WhatsNew';
5
+ import { type HistoryItem, type articleId } from '../../model/Help';
6
6
  import { VIEW } from '../constants';
7
7
  type ViewType = keyof typeof VIEW;
8
8
  type NavigationProviderInterface = PropsWithChildren<{
@@ -22,5 +22,5 @@ export interface SearchProviderInterface extends SearchSharedInterface {
22
22
  onSearchResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
23
23
  }
24
24
  export declare const useSearchContext: () => SearchContextInterface, CtxProvider: React.Provider<SearchContextInterface | undefined>;
25
- export declare const SearchContextProvider: ({ onSearch, onSearchInputChanged, onSearchInputCleared, onSearchResultItemClick, onSearchExternalUrlClick, searchExternalUrl, children, openExternalSearchUrlInNewTab }: PropsWithChildren<SearchProviderInterface>) => JSX.Element;
25
+ export declare const SearchContextProvider: ({ onSearch, onSearchInputChanged, onSearchInputCleared, onSearchResultItemClick, onSearchExternalUrlClick, searchExternalUrl, children, openExternalSearchUrlInNewTab, }: PropsWithChildren<SearchProviderInterface>) => JSX.Element;
26
26
  export {};
@@ -1,8 +1,8 @@
1
- import React, { PropsWithChildren } from 'react';
2
- import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
- import { Article, ArticleItem } from '../../model/Article';
4
- import { WhatsNewArticleItem, WhatsNewArticle } from '../../model/WhatsNew';
5
- import { HistoryItem, articleId } from '../../model/Help';
1
+ import React, { type PropsWithChildren } from 'react';
2
+ import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
3
+ import { type Article, type ArticleItem } from '../../model/Article';
4
+ import { type WhatsNewArticleItem, type WhatsNewArticle } from '../../model/WhatsNew';
5
+ import { type HistoryItem, type articleId } from '../../model/Help';
6
6
  import { VIEW } from '../constants';
7
7
  type ViewType = keyof typeof VIEW;
8
8
  type NavigationProviderInterface = PropsWithChildren<{
@@ -22,5 +22,5 @@ export interface SearchProviderInterface extends SearchSharedInterface {
22
22
  onSearchResultItemClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent, articleData: ArticleItem): void;
23
23
  }
24
24
  export declare const useSearchContext: () => SearchContextInterface, CtxProvider: React.Provider<SearchContextInterface | undefined>;
25
- export declare const SearchContextProvider: ({ onSearch, onSearchInputChanged, onSearchInputCleared, onSearchResultItemClick, onSearchExternalUrlClick, searchExternalUrl, children, openExternalSearchUrlInNewTab }: PropsWithChildren<SearchProviderInterface>) => JSX.Element;
25
+ export declare const SearchContextProvider: ({ onSearch, onSearchInputChanged, onSearchInputCleared, onSearchResultItemClick, onSearchExternalUrlClick, searchExternalUrl, children, openExternalSearchUrlInNewTab, }: PropsWithChildren<SearchProviderInterface>) => JSX.Element;
26
26
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/help",
3
- "version": "7.3.1",
3
+ "version": "7.3.3",
4
4
  "description": "A cross-product help component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -57,7 +57,7 @@
57
57
  "@atlaskit/textarea": "^5.4.0",
58
58
  "@atlaskit/textfield": "^6.3.0",
59
59
  "@atlaskit/theme": "^12.8.0",
60
- "@atlaskit/tokens": "^1.47.0",
60
+ "@atlaskit/tokens": "^1.48.0",
61
61
  "@atlaskit/tooltip": "^18.3.0",
62
62
  "@babel/runtime": "^7.0.0",
63
63
  "@emotion/react": "^11.7.1",