@atlaskit/side-navigation 1.2.15 → 1.3.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 (38) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/cjs/components/LoadingItems/index.js +3 -3
  3. package/dist/cjs/components/NavigationContent/index.js +4 -4
  4. package/dist/cjs/components/NavigationFooter/index.js +2 -2
  5. package/dist/cjs/components/NavigationHeader/index.js +2 -2
  6. package/dist/cjs/components/NestableNavigationContent/index.js +7 -7
  7. package/dist/cjs/components/NestableNavigationContent/nesting-motion.js +2 -2
  8. package/dist/cjs/components/NestingItem/index.js +9 -9
  9. package/dist/cjs/components/SideNavigation/index.js +2 -2
  10. package/dist/cjs/version.json +1 -1
  11. package/dist/es2019/components/LoadingItems/index.js +1 -1
  12. package/dist/es2019/components/NavigationContent/index.js +1 -1
  13. package/dist/es2019/components/NavigationFooter/index.js +1 -1
  14. package/dist/es2019/components/NavigationHeader/index.js +1 -1
  15. package/dist/es2019/components/NestableNavigationContent/index.js +1 -1
  16. package/dist/es2019/components/NestableNavigationContent/nesting-motion.js +1 -1
  17. package/dist/es2019/components/NestingItem/index.js +1 -1
  18. package/dist/es2019/components/SideNavigation/index.js +1 -1
  19. package/dist/es2019/version.json +1 -1
  20. package/dist/esm/components/LoadingItems/index.js +1 -1
  21. package/dist/esm/components/NavigationContent/index.js +1 -1
  22. package/dist/esm/components/NavigationFooter/index.js +1 -1
  23. package/dist/esm/components/NavigationHeader/index.js +1 -1
  24. package/dist/esm/components/NestableNavigationContent/index.js +1 -1
  25. package/dist/esm/components/NestableNavigationContent/nesting-motion.js +1 -1
  26. package/dist/esm/components/NestingItem/index.js +1 -1
  27. package/dist/esm/components/SideNavigation/index.js +1 -1
  28. package/dist/esm/version.json +1 -1
  29. package/dist/types/components/NavigationFooter/index.d.ts +2 -1
  30. package/dist/types/components/NavigationHeader/index.d.ts +3 -1
  31. package/dist/types/components/NestableNavigationContent/index.d.ts +2 -1
  32. package/dist/types/components/NestableNavigationContent/nesting-motion.d.ts +2 -1
  33. package/dist/types-ts4.0/components/NavigationFooter/index.d.ts +2 -1
  34. package/dist/types-ts4.0/components/NavigationHeader/index.d.ts +3 -1
  35. package/dist/types-ts4.0/components/NestableNavigationContent/index.d.ts +2 -1
  36. package/dist/types-ts4.0/components/NestableNavigationContent/nesting-motion.d.ts +2 -1
  37. package/package.json +6 -6
  38. package/report.api.md +163 -43
package/CHANGELOG.md CHANGED
@@ -1,5 +1,15 @@
1
1
  # @atlaskit/side-navigation
2
2
 
3
+ ## 1.3.0
4
+
5
+ ### Minor Changes
6
+
7
+ - [`02e2f7aacef`](https://bitbucket.org/atlassian/atlassian-frontend/commits/02e2f7aacef) - Updates `@emotion/core` to `@emotion/react`; v10 to v11. There is no expected behavior change.
8
+
9
+ ### Patch Changes
10
+
11
+ - Updated dependencies
12
+
3
13
  ## 1.2.15
4
14
 
5
15
  ### Patch Changes
@@ -9,7 +9,7 @@ exports.default = void 0;
9
9
 
10
10
  var _extends2 = _interopRequireDefault(require("@babel/runtime/helpers/extends"));
11
11
 
12
- var _core = require("@emotion/core");
12
+ var _react = require("@emotion/react");
13
13
 
14
14
  var _motion = require("@atlaskit/motion");
15
15
 
@@ -35,11 +35,11 @@ var LoadingItems = function LoadingItems(_ref) {
35
35
  return children;
36
36
  }
37
37
 
38
- return (0, _core.jsx)(_motion.ExitingPersistence, null, (0, _core.jsx)(_motion.FadeIn, {
38
+ return (0, _react.jsx)(_motion.ExitingPersistence, null, (0, _react.jsx)(_motion.FadeIn, {
39
39
  key: "loading-section-".concat(isLoading),
40
40
  duration: _motion.mediumDurationMs
41
41
  }, function (motion, state) {
42
- return (0, _core.jsx)("span", (0, _extends2.default)({}, motion, {
42
+ return (0, _react.jsx)("span", (0, _extends2.default)({}, motion, {
43
43
  "data-testid": testId && "".concat(testId, "--").concat(state),
44
44
  css: {
45
45
  // Used to have the exiting section appear above the entering one.
@@ -9,7 +9,7 @@ exports.default = void 0;
9
9
 
10
10
  var _react = require("react");
11
11
 
12
- var _core = require("@emotion/core");
12
+ var _react2 = require("@emotion/react");
13
13
 
14
14
  var _useScrollbarWidth = _interopRequireDefault(require("@atlaskit/ds-lib/use-scrollbar-width"));
15
15
 
@@ -40,18 +40,18 @@ var NavigationContent = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref
40
40
  return children;
41
41
  }
42
42
 
43
- return (0, _core.jsx)("div", {
43
+ return (0, _react2.jsx)("div", {
44
44
  ref: ref,
45
45
  css: (0, _styles.outerContainerCSS)({
46
46
  showTopScrollIndicator: showTopScrollIndicator,
47
47
  scrollbarWidth: scrollbar.width
48
48
  })
49
- }, (0, _core.jsx)("div", {
49
+ }, (0, _react2.jsx)("div", {
50
50
  ref: scrollbar.ref,
51
51
  css: (0, _styles.innerContainerCSS)({
52
52
  showTopScrollIndicator: showTopScrollIndicator
53
53
  })
54
- }, (0, _core.jsx)("div", {
54
+ }, (0, _react2.jsx)("div", {
55
55
  css: (0, _styles.containerCSS)({
56
56
  showTopScrollIndicator: showTopScrollIndicator
57
57
  })
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.default = void 0;
7
7
 
8
- var _core = require("@emotion/core");
8
+ var _react = require("@emotion/react");
9
9
 
10
10
  var _constants = require("@atlaskit/theme/constants");
11
11
 
@@ -26,7 +26,7 @@ var footerCSS = {
26
26
 
27
27
  var NavigationFooter = function NavigationFooter(_ref) {
28
28
  var children = _ref.children;
29
- return (0, _core.jsx)("div", {
29
+ return (0, _react.jsx)("div", {
30
30
  css: footerCSS
31
31
  }, children);
32
32
  };
@@ -5,7 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.default = void 0;
7
7
 
8
- var _core = require("@emotion/core");
8
+ var _react = require("@emotion/react");
9
9
 
10
10
  var _constants = require("@atlaskit/theme/constants");
11
11
 
@@ -21,7 +21,7 @@ var _constants = require("@atlaskit/theme/constants");
21
21
  */
22
22
  var NavigationHeader = function NavigationHeader(props) {
23
23
  var children = props.children;
24
- return (0, _core.jsx)("div", {
24
+ return (0, _react.jsx)("div", {
25
25
  "data-navheader": true,
26
26
  css: {
27
27
  paddingTop: (0, _constants.gridSize)() * 3,
@@ -13,7 +13,7 @@ var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/sli
13
13
 
14
14
  var _react = require("react");
15
15
 
16
- var _core = require("@emotion/core");
16
+ var _react2 = require("@emotion/react");
17
17
 
18
18
  var _motion = require("@atlaskit/motion");
19
19
 
@@ -62,7 +62,7 @@ var NestableNavigationContent = function NestableNavigationContent(props) {
62
62
 
63
63
  var backTestId = testId && "".concat(testId, "--go-back-item");
64
64
  var renderGoBackItem = overrides && overrides.GoBackItem && overrides.GoBackItem.render ? overrides.GoBackItem.render : function (props) {
65
- return (0, _core.jsx)(_Item.GoBackItem, props, "Go back");
65
+ return (0, _react2.jsx)(_Item.GoBackItem, props, "Go back");
66
66
  };
67
67
  var onNestHandler = (0, _react.useCallback)(function (layerId) {
68
68
  onChange && onChange(committedStack.concat(layerId));
@@ -149,7 +149,7 @@ var NestableNavigationContent = function NestableNavigationContent(props) {
149
149
  }
150
150
  };
151
151
 
152
- return (0, _core.jsx)("div", {
152
+ return (0, _react2.jsx)("div", {
153
153
  "data-testid": testId,
154
154
  css: {
155
155
  position: 'relative',
@@ -159,7 +159,7 @@ var NestableNavigationContent = function NestableNavigationContent(props) {
159
159
  ref: containerRef,
160
160
  tabIndex: -1,
161
161
  onClick: manageFocus
162
- }, (0, _core.jsx)(_motion.ExitingPersistence, null, (0, _core.jsx)(_nestingMotion.NestingMotion // Key is needed to have a unique react instance per stack name.
162
+ }, (0, _react2.jsx)(_motion.ExitingPersistence, null, (0, _react2.jsx)(_nestingMotion.NestingMotion // Key is needed to have a unique react instance per stack name.
163
163
  // This enables us to easily animate it in & out with exiting persistence.
164
164
  , {
165
165
  key: currentStackId,
@@ -167,7 +167,7 @@ var NestableNavigationContent = function NestableNavigationContent(props) {
167
167
  exitTo: transition === 'nesting' ? 'left' : 'right',
168
168
  testId: testId && "".concat(testId, "-anim")
169
169
  }, function (motion) {
170
- return (0, _core.jsx)("div", (0, _extends2.default)({
170
+ return (0, _react2.jsx)("div", (0, _extends2.default)({
171
171
  css: {
172
172
  position: 'absolute',
173
173
  width: '100%',
@@ -175,11 +175,11 @@ var NestableNavigationContent = function NestableNavigationContent(props) {
175
175
  display: 'flex',
176
176
  flexDirection: 'column'
177
177
  }
178
- }, motion), (0, _core.jsx)(_context.NestedContext.Provider, {
178
+ }, motion), (0, _react2.jsx)(_context.NestedContext.Provider, {
179
179
  // This provider is inside the NestingMotion to ensure it keeps a stale
180
180
  // reference to the previous value.
181
181
  value: context
182
- }, (0, _core.jsx)(_NestingItem.default, {
182
+ }, (0, _react2.jsx)(_NestingItem.default, {
183
183
  title: "",
184
184
  id: ROOT_ID
185
185
  }, children)));
@@ -9,7 +9,7 @@ exports.NestingMotion = void 0;
9
9
 
10
10
  var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
11
11
 
12
- var _core = require("@emotion/core");
12
+ var _react = require("@emotion/react");
13
13
 
14
14
  var _motion = require("@atlaskit/motion");
15
15
 
@@ -25,7 +25,7 @@ var NestingMotion = function NestingMotion(props) {
25
25
  enterFrom = props.enterFrom,
26
26
  exitTo = props.exitTo,
27
27
  testId = props.testId;
28
- return (0, _core.jsx)(_motion.SlideIn, {
28
+ return (0, _react.jsx)(_motion.SlideIn, {
29
29
  exitTo: exitTo,
30
30
  enterFrom: enterFrom,
31
31
  animationTimingFunction: function animationTimingFunction(_) {
@@ -21,7 +21,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
21
21
 
22
22
  var _react = _interopRequireWildcard(require("react"));
23
23
 
24
- var _core = require("@emotion/core");
24
+ var _react2 = require("@emotion/react");
25
25
 
26
26
  var _arrowRightCircle = _interopRequireDefault(require("@atlaskit/icon/glyph/arrow-right-circle"));
27
27
 
@@ -121,9 +121,9 @@ var NestingItem = function NestingItem(props) {
121
121
  }, [isInteracted, onClick, onNest, id]);
122
122
 
123
123
  if (currentStackId === id) {
124
- return (0, _core.jsx)(_context.NestedContext.Provider, {
124
+ return (0, _react2.jsx)(_context.NestedContext.Provider, {
125
125
  value: context
126
- }, stack.length >= 1 && (0, _core.jsx)("div", {
126
+ }, stack.length >= 1 && (0, _react2.jsx)("div", {
127
127
  css: {
128
128
  marginLeft: (0, _constants.gridSize)(),
129
129
  marginRight: (0, _constants.gridSize)(),
@@ -131,7 +131,7 @@ var NestingItem = function NestingItem(props) {
131
131
  paddingTop: (0, _constants.gridSize)() * 0.75,
132
132
  paddingBottom: (0, _constants.gridSize)() * 0.75
133
133
  }
134
- }, backButton), (0, _core.jsx)(_index.NavigationContent, {
134
+ }, backButton), (0, _react2.jsx)(_index.NavigationContent, {
135
135
  testId: testId,
136
136
  showTopScrollIndicator: stack.length >= 1
137
137
  }, children));
@@ -142,11 +142,11 @@ var NestingItem = function NestingItem(props) {
142
142
  }
143
143
 
144
144
  var componentProps = _objectSpread(_objectSpread({
145
- iconAfter: (0, _core.jsx)(_react.Fragment, null, iconAfter ? (0, _core.jsx)("span", {
145
+ iconAfter: (0, _react2.jsx)(_react.Fragment, null, iconAfter ? (0, _react2.jsx)("span", {
146
146
  "data-custom-icon": true
147
- }, iconAfter) : null, (0, _core.jsx)("span", {
147
+ }, iconAfter) : null, (0, _react2.jsx)("span", {
148
148
  "data-right-arrow": true
149
- }, (0, _core.jsx)(_arrowRightCircle.default, {
149
+ }, (0, _react2.jsx)(_arrowRightCircle.default, {
150
150
  testId: testId && "".concat(testId, "--item--right-arrow"),
151
151
  secondaryColor: "var(--ds-surface, ".concat(_colors.N10, ")"),
152
152
  label: ""
@@ -160,13 +160,13 @@ var NestingItem = function NestingItem(props) {
160
160
  });
161
161
 
162
162
  if (component) {
163
- return (0, _core.jsx)(_index.CustomItem, (0, _extends2.default)({}, componentProps, {
163
+ return (0, _react2.jsx)(_index.CustomItem, (0, _extends2.default)({}, componentProps, {
164
164
  //@ts-expect-error TODO Fix legit TypeScript 3.9.6 improved inference error
165
165
  component: component
166
166
  }));
167
167
  }
168
168
 
169
- return (0, _core.jsx)(_index.ButtonItem, componentProps);
169
+ return (0, _react2.jsx)(_index.ButtonItem, componentProps);
170
170
  };
171
171
 
172
172
  var _default = NestingItem;
@@ -7,7 +7,7 @@ exports.default = void 0;
7
7
 
8
8
  var _react = require("react");
9
9
 
10
- var _core = require("@emotion/core");
10
+ var _react2 = require("@emotion/react");
11
11
 
12
12
  var _colors = require("@atlaskit/theme/colors");
13
13
 
@@ -28,7 +28,7 @@ var SideNavigation = /*#__PURE__*/(0, _react.forwardRef)(function (props, ref) {
28
28
  var children = props.children,
29
29
  testId = props.testId,
30
30
  label = props.label;
31
- return (0, _core.jsx)("nav", {
31
+ return (0, _react2.jsx)("nav", {
32
32
  ref: ref,
33
33
  "data-testid": testId,
34
34
  "aria-label": label,
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/side-navigation",
3
- "version": "1.2.15",
3
+ "version": "1.3.0",
4
4
  "sideEffects": false
5
5
  }
@@ -1,7 +1,7 @@
1
1
  import _extends from "@babel/runtime/helpers/extends";
2
2
 
3
3
  /** @jsx jsx */
4
- import { jsx } from '@emotion/core';
4
+ import { jsx } from '@emotion/react';
5
5
  import { ExitingPersistence, FadeIn, mediumDurationMs } from '@atlaskit/motion';
6
6
  import { useShouldNestedElementRender } from '../NestableNavigationContent/context';
7
7
 
@@ -1,6 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { forwardRef } from 'react';
3
- import { jsx } from '@emotion/core';
3
+ import { jsx } from '@emotion/react';
4
4
  import useScrollbarWidth from '@atlaskit/ds-lib/use-scrollbar-width';
5
5
  import { useShouldNestedElementRender } from '../NestableNavigationContent/context';
6
6
  import { containerCSS, innerContainerCSS, outerContainerCSS } from './styles';
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { jsx } from '@emotion/core';
2
+ import { jsx } from '@emotion/react';
3
3
  import { gridSize } from '@atlaskit/theme/constants';
4
4
  const footerCSS = {
5
5
  position: 'relative',
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { jsx } from '@emotion/core';
2
+ import { jsx } from '@emotion/react';
3
3
  import { gridSize } from '@atlaskit/theme/constants';
4
4
 
5
5
  /**
@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
2
2
 
3
3
  /** @jsx jsx */
4
4
  import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
5
- import { jsx } from '@emotion/core';
5
+ import { jsx } from '@emotion/react';
6
6
  import { ExitingPersistence } from '@atlaskit/motion';
7
7
  import { GoBackItem as GoBackButton } from '../Item';
8
8
  import { default as NestingItem } from '../NestingItem';
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { jsx } from '@emotion/core';
2
+ import { jsx } from '@emotion/react';
3
3
  import { easeOut, SlideIn } from '@atlaskit/motion';
4
4
 
5
5
  /**
@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/extends";
2
2
 
3
3
  /** @jsx jsx */
4
4
  import React, { Fragment, useCallback, useMemo, useState } from 'react';
5
- import { jsx } from '@emotion/core';
5
+ import { jsx } from '@emotion/react';
6
6
  import RightArrow from '@atlaskit/icon/glyph/arrow-right-circle';
7
7
  import { N10 } from '@atlaskit/theme/colors';
8
8
  import { gridSize } from '@atlaskit/theme/constants';
@@ -1,6 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { forwardRef } from 'react';
3
- import { jsx } from '@emotion/core';
3
+ import { jsx } from '@emotion/react';
4
4
  import { N10, N500 } from '@atlaskit/theme/colors';
5
5
  import { gridSize } from '@atlaskit/theme/constants';
6
6
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/side-navigation",
3
- "version": "1.2.15",
3
+ "version": "1.3.0",
4
4
  "sideEffects": false
5
5
  }
@@ -1,7 +1,7 @@
1
1
  import _extends from "@babel/runtime/helpers/extends";
2
2
 
3
3
  /** @jsx jsx */
4
- import { jsx } from '@emotion/core';
4
+ import { jsx } from '@emotion/react';
5
5
  import { ExitingPersistence, FadeIn, mediumDurationMs } from '@atlaskit/motion';
6
6
  import { useShouldNestedElementRender } from '../NestableNavigationContent/context';
7
7
 
@@ -1,6 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { forwardRef } from 'react';
3
- import { jsx } from '@emotion/core';
3
+ import { jsx } from '@emotion/react';
4
4
  import useScrollbarWidth from '@atlaskit/ds-lib/use-scrollbar-width';
5
5
  import { useShouldNestedElementRender } from '../NestableNavigationContent/context';
6
6
  import { containerCSS, innerContainerCSS, outerContainerCSS } from './styles';
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { jsx } from '@emotion/core';
2
+ import { jsx } from '@emotion/react';
3
3
  import { gridSize } from '@atlaskit/theme/constants';
4
4
  var footerCSS = {
5
5
  position: 'relative',
@@ -1,5 +1,5 @@
1
1
  /** @jsx jsx */
2
- import { jsx } from '@emotion/core';
2
+ import { jsx } from '@emotion/react';
3
3
  import { gridSize } from '@atlaskit/theme/constants';
4
4
 
5
5
  /**
@@ -3,7 +3,7 @@ import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
3
3
 
4
4
  /** @jsx jsx */
5
5
  import { useCallback, useEffect, useMemo, useRef, useState } from 'react';
6
- import { jsx } from '@emotion/core';
6
+ import { jsx } from '@emotion/react';
7
7
  import { ExitingPersistence } from '@atlaskit/motion';
8
8
  import { GoBackItem as GoBackButton } from '../Item';
9
9
  import { default as NestingItem } from '../NestingItem';
@@ -5,7 +5,7 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (O
5
5
  function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
6
6
 
7
7
  /** @jsx jsx */
8
- import { jsx } from '@emotion/core';
8
+ import { jsx } from '@emotion/react';
9
9
  import { easeOut, SlideIn } from '@atlaskit/motion';
10
10
 
11
11
  /**
@@ -11,7 +11,7 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
11
11
 
12
12
  /** @jsx jsx */
13
13
  import React, { Fragment, useCallback, useMemo, useState } from 'react';
14
- import { jsx } from '@emotion/core';
14
+ import { jsx } from '@emotion/react';
15
15
  import RightArrow from '@atlaskit/icon/glyph/arrow-right-circle';
16
16
  import { N10 } from '@atlaskit/theme/colors';
17
17
  import { gridSize } from '@atlaskit/theme/constants';
@@ -1,6 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { forwardRef } from 'react';
3
- import { jsx } from '@emotion/core';
3
+ import { jsx } from '@emotion/react';
4
4
  import { N10, N500 } from '@atlaskit/theme/colors';
5
5
  import { gridSize } from '@atlaskit/theme/constants';
6
6
 
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/side-navigation",
3
- "version": "1.2.15",
3
+ "version": "1.3.0",
4
4
  "sideEffects": false
5
5
  }
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  export interface NavigationFooterProps {
4
5
  children: ReactNode;
5
6
  }
@@ -11,5 +12,5 @@ export interface NavigationFooterProps {
11
12
  * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
12
13
  * - [Code](https://atlassian.design/components/side-navigation/code)
13
14
  */
14
- declare const NavigationFooter: ({ children }: NavigationFooterProps) => JSX.Element;
15
+ declare const NavigationFooter: ({ children }: NavigationFooterProps) => jsx.JSX.Element;
15
16
  export default NavigationFooter;
@@ -1,4 +1,6 @@
1
1
  /// <reference types="react" />
2
+ /** @jsx jsx */
3
+ import { jsx } from '@emotion/react';
2
4
  export interface NavigationHeaderProps {
3
5
  children: JSX.Element | JSX.Element[];
4
6
  }
@@ -10,5 +12,5 @@ export interface NavigationHeaderProps {
10
12
  * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
11
13
  * - [Code](https://atlassian.design/components/side-navigation/code)
12
14
  */
13
- declare const NavigationHeader: (props: NavigationHeaderProps) => JSX.Element;
15
+ declare const NavigationHeader: (props: NavigationHeaderProps) => jsx.JSX.Element;
14
16
  export default NavigationHeader;
@@ -1,4 +1,5 @@
1
1
  /// <reference types="react" />
2
+ import { jsx } from '@emotion/react';
2
3
  export declare const ROOT_ID = "ATLASKIT_NESTED_ROOT";
3
4
  export interface NestableNavigationContentProps {
4
5
  /**
@@ -64,5 +65,5 @@ export interface NestableNavigationContentProps {
64
65
  * - [Examples](https://atlassian.design/components/side-navigation/examples#nested-navigation)
65
66
  * - [Code](https://atlassian.design/components/side-navigation/code)
66
67
  */
67
- declare const NestableNavigationContent: (props: NestableNavigationContentProps) => JSX.Element;
68
+ declare const NestableNavigationContent: (props: NestableNavigationContentProps) => jsx.JSX.Element;
68
69
  export default NestableNavigationContent;
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { Ref } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  import { Direction } from '@atlaskit/motion';
4
5
  interface ChildrenAsFunctionProps {
5
6
  'data-enter-from': string;
@@ -17,5 +18,5 @@ interface NestingMotionProps {
17
18
  /**
18
19
  * @internal
19
20
  */
20
- export declare const NestingMotion: (props: NestingMotionProps) => JSX.Element;
21
+ export declare const NestingMotion: (props: NestingMotionProps) => jsx.JSX.Element;
21
22
  export {};
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { ReactNode } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  export interface NavigationFooterProps {
4
5
  children: ReactNode;
5
6
  }
@@ -11,5 +12,5 @@ export interface NavigationFooterProps {
11
12
  * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
12
13
  * - [Code](https://atlassian.design/components/side-navigation/code)
13
14
  */
14
- declare const NavigationFooter: ({ children }: NavigationFooterProps) => JSX.Element;
15
+ declare const NavigationFooter: ({ children }: NavigationFooterProps) => jsx.JSX.Element;
15
16
  export default NavigationFooter;
@@ -1,4 +1,6 @@
1
1
  /// <reference types="react" />
2
+ /** @jsx jsx */
3
+ import { jsx } from '@emotion/react';
2
4
  export interface NavigationHeaderProps {
3
5
  children: JSX.Element | JSX.Element[];
4
6
  }
@@ -10,5 +12,5 @@ export interface NavigationHeaderProps {
10
12
  * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
11
13
  * - [Code](https://atlassian.design/components/side-navigation/code)
12
14
  */
13
- declare const NavigationHeader: (props: NavigationHeaderProps) => JSX.Element;
15
+ declare const NavigationHeader: (props: NavigationHeaderProps) => jsx.JSX.Element;
14
16
  export default NavigationHeader;
@@ -1,4 +1,5 @@
1
1
  /// <reference types="react" />
2
+ import { jsx } from '@emotion/react';
2
3
  export declare const ROOT_ID = "ATLASKIT_NESTED_ROOT";
3
4
  export interface NestableNavigationContentProps {
4
5
  /**
@@ -64,5 +65,5 @@ export interface NestableNavigationContentProps {
64
65
  * - [Examples](https://atlassian.design/components/side-navigation/examples#nested-navigation)
65
66
  * - [Code](https://atlassian.design/components/side-navigation/code)
66
67
  */
67
- declare const NestableNavigationContent: (props: NestableNavigationContentProps) => JSX.Element;
68
+ declare const NestableNavigationContent: (props: NestableNavigationContentProps) => jsx.JSX.Element;
68
69
  export default NestableNavigationContent;
@@ -1,5 +1,6 @@
1
1
  /** @jsx jsx */
2
2
  import { Ref } from 'react';
3
+ import { jsx } from '@emotion/react';
3
4
  import { Direction } from '@atlaskit/motion';
4
5
  interface ChildrenAsFunctionProps {
5
6
  'data-enter-from': string;
@@ -17,5 +18,5 @@ interface NestingMotionProps {
17
18
  /**
18
19
  * @internal
19
20
  */
20
- export declare const NestingMotion: (props: NestingMotionProps) => JSX.Element;
21
+ export declare const NestingMotion: (props: NestingMotionProps) => jsx.JSX.Element;
21
22
  export {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/side-navigation",
3
- "version": "1.2.15",
3
+ "version": "1.3.0",
4
4
  "description": "A highly composable side navigation component that supports nested views.",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -32,13 +32,13 @@
32
32
  },
33
33
  "dependencies": {
34
34
  "@atlaskit/ds-lib": "^2.1.0",
35
- "@atlaskit/icon": "^21.10.0",
35
+ "@atlaskit/icon": "^21.11.0",
36
36
  "@atlaskit/menu": "^1.3.0",
37
37
  "@atlaskit/motion": "^1.2.0",
38
38
  "@atlaskit/theme": "^12.2.0",
39
39
  "@atlaskit/tokens": "^0.10.0",
40
40
  "@babel/runtime": "^7.0.0",
41
- "@emotion/core": "^10.0.9"
41
+ "@emotion/react": "^11.7.1"
42
42
  },
43
43
  "peerDependencies": {
44
44
  "react": "^16.8.0"
@@ -47,9 +47,9 @@
47
47
  "@atlaskit/atlassian-navigation": "^2.2.0",
48
48
  "@atlaskit/button": "^16.3.0",
49
49
  "@atlaskit/docs": "*",
50
- "@atlaskit/logo": "^13.9.0",
51
- "@atlaskit/onboarding": "^10.5.0",
52
- "@atlaskit/section-message": "^6.2.0",
50
+ "@atlaskit/logo": "^13.10.0",
51
+ "@atlaskit/onboarding": "^10.6.0",
52
+ "@atlaskit/section-message": "^6.3.0",
53
53
  "@atlaskit/select": "^15.7.0",
54
54
  "@atlaskit/visual-regression": "*",
55
55
  "@atlaskit/webdriver-runner": "*",
package/report.api.md CHANGED
@@ -1,6 +1,8 @@
1
- ## API Report File for "@atlaskit/side-navigation"
1
+ ## API Report File for "@atlaskit/side-navigation".
2
2
 
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
4
6
 
5
7
  ```ts
6
8
  /// <reference types="react" />
@@ -12,6 +14,7 @@ import { CustomItemProps } from '@atlaskit/menu';
12
14
  import { ForwardRefExoticComponent } from 'react';
13
15
  import { HeadingItemProps } from '@atlaskit/menu';
14
16
  import { HTMLAttributes } from 'react';
17
+ import { jsx } from '@emotion/react';
15
18
  import { LinkItemProps } from '@atlaskit/menu';
16
19
  import { Overrides } from '@atlaskit/menu';
17
20
  import { default as React_2 } from 'react';
@@ -20,6 +23,15 @@ import { RefAttributes } from 'react';
20
23
  import { SkeletonHeadingItemProps } from '@atlaskit/menu';
21
24
  import { SkeletonItemProps } from '@atlaskit/menu';
22
25
 
26
+ /**
27
+ * __Button item__
28
+ *
29
+ * A button item renders an item wrapped in a button tag, used primarily when an
30
+ * action does something other than changing routes.
31
+ *
32
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#button-item)
33
+ * - [Code](https://atlassian.design/components/side-navigation/code)
34
+ */
23
35
  export declare const ButtonItem: React_2.ForwardRefExoticComponent<
24
36
  ButtonItemProps & React_2.RefAttributes<HTMLElement>
25
37
  >;
@@ -31,13 +43,13 @@ export { ButtonItemProps as GoBackItemProps };
31
43
  * Used to support any custom items needed by products alongside the Header and Footer patterns.
32
44
  * Specific implementation of headers and footers are provided in the examples folder.
33
45
  */
34
- export declare const CustomItem: CustomItemType;
46
+ export declare const CustomItem: CustomItemPropsHack;
35
47
 
36
48
  export { CustomItemComponentProps };
37
49
 
38
50
  export { CustomItemProps };
39
51
 
40
- declare interface CustomItemType {
52
+ declare interface CustomItemPropsHack {
41
53
  <TComponentProps extends {}>(
42
54
  props: CustomItemProps<TComponentProps> & {
43
55
  ref?: any;
@@ -45,12 +57,33 @@ declare interface CustomItemType {
45
57
  ): JSX.Element | null;
46
58
  }
47
59
 
60
+ /**
61
+ * __Header__
62
+ *
63
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
64
+ * - [Code](https://atlassian.design/components/side-navigation/code)
65
+ */
48
66
  export declare const Footer: (props: HeaderProps) => JSX.Element;
49
67
 
68
+ /**
69
+ * __Go back item__
70
+ *
71
+ * A go back item is used to provide a customized "go back" button in nested
72
+ * navigations.
73
+ *
74
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#go-back-item)
75
+ * - [Code](https://atlassian.design/components/side-navigation/code)
76
+ */
50
77
  export declare const GoBackItem: React_2.ForwardRefExoticComponent<
51
78
  ButtonItemProps & React_2.RefAttributes<HTMLElement>
52
79
  >;
53
80
 
81
+ /**
82
+ * __Header__
83
+ *
84
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
85
+ * - [Code](https://atlassian.design/components/side-navigation/code)
86
+ */
54
87
  export declare const Header: React_2.ForwardRefExoticComponent<
55
88
  HeaderProps & React_2.RefAttributes<HTMLElement>
56
89
  >;
@@ -87,29 +120,51 @@ declare interface HeaderProps {
87
120
  */
88
121
  testId?: string;
89
122
  /**
90
- * Custom component to render as an item.
91
- * This can be both a functional component or a class component.
92
- * **Will return `null` if no component is defined.**
93
-
94
- * **NOTE:** Make sure the reference for this component does not change between renders else undefined behavior may happen.
95
- */
123
+ * Custom component to render as an item.
124
+ * This can be both a functional component or a class component.
125
+ * __Will return `null` if no component is defined.__
126
+ *
127
+ * __NOTE:__ Make sure the reference for this component does not change between renders else undefined behavior may happen.
128
+ */
96
129
  component?: React_2.ComponentType<CustomItemComponentProps>;
97
130
  }
98
131
  export { HeaderProps as FooterProps };
99
132
  export { HeaderProps };
100
133
 
134
+ /**
135
+ * __Heading item__
136
+ *
137
+ * Available for advanced use cases, for most situations providing a title to Section should be enough.
138
+ *
139
+ */
101
140
  export declare const HeadingItem: (
102
141
  props: HeadingItemProps,
103
142
  ) => JSX.Element | null;
104
143
 
105
144
  export { HeadingItemProps };
106
145
 
146
+ /**
147
+ * __Link item__
148
+ *
149
+ * Renders an item wrapped in an anchor tag, useful when you have an item that
150
+ * should change routes using native browser navigation. For SPA transitions use
151
+ * a [custom item](https://atlassian.design/components/side-navigation/examples#custom-item)
152
+ * with the respective router logic.
153
+ *
154
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#link-item)
155
+ * - [Code](https://atlassian.design/components/side-navigation/code)
156
+ */
107
157
  export declare const LinkItem: React_2.ForwardRefExoticComponent<
108
158
  LinkItemProps & React_2.RefAttributes<HTMLElement>
109
159
  >;
110
160
 
111
161
  export { LinkItemProps };
112
162
 
163
+ /**
164
+ * __Loading items__
165
+ *
166
+ * Loading items conditionally render based on the useShouldNestedElementRender() hook.
167
+ */
113
168
  export declare const LoadingItems: ({
114
169
  children,
115
170
  isLoading,
@@ -134,17 +189,25 @@ export declare interface LoadingItemsProps {
134
189
  */
135
190
  isLoading?: boolean;
136
191
  /**
137
- * A `testId` prop is provided for specified elements,
138
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
139
- * serving as a hook for automated tests.
140
-
141
- * Will set these elements when defined:
142
- * - The entering container - `{testId}--entering`
143
- * - The exiting container - `{testId}--exiting`
144
- */
192
+ * A `testId` prop is provided for specified elements,
193
+ * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
194
+ * serving as a hook for automated tests.
195
+ *
196
+ * Will set these elements when defined:
197
+ * - The entering container - `{testId}--entering`
198
+ * - The exiting container - `{testId}--exiting`
199
+ */
145
200
  testId?: string;
146
201
  }
147
202
 
203
+ /**
204
+ * __Navigation content__
205
+ *
206
+ * A navigation content is used as the container for navigation items.
207
+ *
208
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#content)
209
+ * - [Code](https://atlassian.design/components/side-navigation/code)
210
+ */
148
211
  export declare const NavigationContent: ForwardRefExoticComponent<
149
212
  NavigationContentProps &
150
213
  HTMLAttributes<HTMLElement> &
@@ -165,25 +228,49 @@ export declare interface NavigationContentProps {
165
228
  testId?: string;
166
229
  }
167
230
 
231
+ /**
232
+ * __Navigation footer__
233
+ *
234
+ * Allows for customisation of the footer.
235
+ *
236
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
237
+ * - [Code](https://atlassian.design/components/side-navigation/code)
238
+ */
168
239
  export declare const NavigationFooter: ({
169
240
  children,
170
- }: NavigationFooterProps) => JSX.Element;
241
+ }: NavigationFooterProps) => jsx.JSX.Element;
171
242
 
172
243
  export declare interface NavigationFooterProps {
173
244
  children: ReactNode;
174
245
  }
175
246
 
247
+ /**
248
+ * __Navigation header__
249
+ *
250
+ * Allows for customisation of the header.
251
+ *
252
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#header-and-footer)
253
+ * - [Code](https://atlassian.design/components/side-navigation/code)
254
+ */
176
255
  export declare const NavigationHeader: (
177
256
  props: NavigationHeaderProps,
178
- ) => JSX.Element;
257
+ ) => jsx.JSX.Element;
179
258
 
180
259
  export declare interface NavigationHeaderProps {
181
260
  children: JSX.Element | JSX.Element[];
182
261
  }
183
262
 
263
+ /**
264
+ * __Nestable navigation content__
265
+ *
266
+ * The container for navigation items with nested views
267
+ *
268
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#nested-navigation)
269
+ * - [Code](https://atlassian.design/components/side-navigation/code)
270
+ */
184
271
  export declare const NestableNavigationContent: (
185
272
  props: NestableNavigationContentProps,
186
- ) => JSX.Element;
273
+ ) => jsx.JSX.Element;
187
274
 
188
275
  export declare interface NestableNavigationContentProps {
189
276
  /**
@@ -193,14 +280,14 @@ export declare interface NestableNavigationContentProps {
193
280
  */
194
281
  children: JSX.Element | JSX.Element[];
195
282
  /**
196
- * A `testId` prop is provided for specified elements,
197
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
198
- * serving as a hook for automated tests.
199
-
200
- * Will set these elements when defined:
201
- * - This wrapper - `{testId}`
202
- * - The back item (displayed when inside a nested view) - `{testId}--go-back-item`
203
- */
283
+ * A `testId` prop is provided for specified elements,
284
+ * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
285
+ * serving as a hook for automated tests.
286
+ *
287
+ * Will set these elements when defined:
288
+ * - This wrapper - `{testId}`
289
+ * - The back item (displayed when inside a nested view) - `{testId}--go-back-item`
290
+ */
204
291
  testId?: string;
205
292
  /**
206
293
  * Array of the initial stack you want to show.
@@ -223,10 +310,10 @@ export declare interface NestableNavigationContentProps {
223
310
  */
224
311
  onChange?: (stack: string[]) => void;
225
312
  /**
226
- Custom overrides for the composed components.
227
-
228
- @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2682 for more information.
229
- */
313
+ * Custom overrides for the composed components.
314
+ *
315
+ * @deprecated Please avoid using this prop as we intend to remove the prop completely in a future release. See DSP-2682 for more information.
316
+ */
230
317
  overrides?: {
231
318
  /**
232
319
  * Use this to override the default back button displayed when navigation is nested.
@@ -288,16 +375,16 @@ export declare interface NestingItemProps<
288
375
  */
289
376
  component?: React_2.ComponentType<TCustomComponentProps>;
290
377
  /**
291
- * A `testId` prop is provided for specified elements,
292
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
293
- * serving as a hook for automated tests.
294
-
295
- * Will set these elements when defined:
296
- * - The container - `{testId}--container`
297
- * - The nesting item - `{testId}--item`
298
- * - The go back item - `{testId}--go-back-item` (only used if you pass in a override).
299
- * - The nesting item default right arrow icon - `{testId}--item--right-arrow`
300
- */
378
+ * A `testId` prop is provided for specified elements,
379
+ * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
380
+ * serving as a hook for automated tests.
381
+ *
382
+ * Will set these elements when defined:
383
+ * - The container - `{testId}--container`
384
+ * - The nesting item - `{testId}--item`
385
+ * - The go back item - `{testId}--go-back-item` (only used if you pass in a override).
386
+ * - The nesting item default right arrow icon - `{testId}--item--right-arrow`
387
+ */
301
388
  testId?: string;
302
389
  /**
303
390
  * A function that can be used to override the styles of the component.
@@ -337,6 +424,15 @@ export declare interface NestingItemProps<
337
424
  overrides?: NestingItemOverrides;
338
425
  }
339
426
 
427
+ /**
428
+ * __Section__
429
+ *
430
+ * Used to separate items into sections. Using the title prop makes a section
431
+ * implicitly group the items for screen readers with no additional work required.
432
+ *
433
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#section)
434
+ * - [Code](https://atlassian.design/components/side-navigation/code)
435
+ */
340
436
  export declare const Section: React_2.ForwardRefExoticComponent<
341
437
  SectionProps & React_2.RefAttributes<HTMLElement>
342
438
  >;
@@ -364,6 +460,15 @@ export declare interface SectionProps {
364
460
  testId?: string;
365
461
  }
366
462
 
463
+ /**
464
+ * __Side navigation__
465
+ *
466
+ * A highly composable side navigation component that supports nested views.
467
+ *
468
+ * - [Examples](https://atlassian.design/components/side-navigation/examples)
469
+ * - [Code](https://atlassian.design/components/side-navigation/code)
470
+ * - [Usage](https://atlassian.design/components/side-navigation/usage)
471
+ */
367
472
  export declare const SideNavigation: ForwardRefExoticComponent<
368
473
  SideNavigationProps & RefAttributes<HTMLElement>
369
474
  >;
@@ -389,12 +494,27 @@ export declare interface SideNavigationProps {
389
494
  testId?: string;
390
495
  }
391
496
 
497
+ /**
498
+ * __Skeleton heading item__
499
+ *
500
+ * A skeleton heading item for use in managing loading states.
501
+ *
502
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#loading)
503
+ */
392
504
  export declare const SkeletonHeadingItem: (
393
505
  props: SkeletonHeadingItemProps,
394
506
  ) => JSX.Element | null;
395
507
 
396
508
  export { SkeletonHeadingItemProps };
397
509
 
510
+ /**
511
+ * __Skeleton item__
512
+ *
513
+ * A skeleton item can be used to reduce the perceived laoding time.
514
+ *
515
+ * - [Examples](https://atlassian.design/components/side-navigation/examples#loading)
516
+ * - [Code](https://atlassian.design/components/side-navigation/code)
517
+ */
398
518
  export declare const SkeletonItem: (
399
519
  props: SkeletonItemProps,
400
520
  ) => JSX.Element | null;