@atlaskit/side-navigation 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/CHANGELOG.md +517 -0
  2. package/LICENSE +13 -0
  3. package/README.md +16 -0
  4. package/build/tsconfig.json +17 -0
  5. package/codemods/0.8.0-change-css-fn-prop.ts +184 -0
  6. package/codemods/__tests__/0.8.0-change-css-fn-prop.ts +360 -0
  7. package/codemods/helpers/generic.ts +674 -0
  8. package/dist/cjs/common/constants.js +10 -0
  9. package/dist/cjs/common/styles.js +104 -0
  10. package/dist/cjs/components/Footer/index.js +67 -0
  11. package/dist/cjs/components/Header/index.js +73 -0
  12. package/dist/cjs/components/Item/button-item.js +47 -0
  13. package/dist/cjs/components/Item/custom-item.js +52 -0
  14. package/dist/cjs/components/Item/go-back-item.js +65 -0
  15. package/dist/cjs/components/Item/index.js +47 -0
  16. package/dist/cjs/components/Item/link-item.js +47 -0
  17. package/dist/cjs/components/Item/skeleton-item.js +43 -0
  18. package/dist/cjs/components/LoadingItems/index.js +51 -0
  19. package/dist/cjs/components/NavigationContent/index.js +52 -0
  20. package/dist/cjs/components/NavigationContent/styles.js +152 -0
  21. package/dist/cjs/components/NavigationFooter/index.js +27 -0
  22. package/dist/cjs/components/NavigationHeader/index.js +27 -0
  23. package/dist/cjs/components/NestableNavigationContent/context.js +51 -0
  24. package/dist/cjs/components/NestableNavigationContent/index.js +182 -0
  25. package/dist/cjs/components/NestableNavigationContent/nesting-motion.js +40 -0
  26. package/dist/cjs/components/NestingItem/hack-for-ert.js +8 -0
  27. package/dist/cjs/components/NestingItem/index.js +173 -0
  28. package/dist/cjs/components/NestingItem/styles.js +47 -0
  29. package/dist/cjs/components/Section/heading-item.js +35 -0
  30. package/dist/cjs/components/Section/index.js +31 -0
  31. package/dist/cjs/components/Section/section.js +45 -0
  32. package/dist/cjs/components/Section/skeleton-heading-item.js +39 -0
  33. package/dist/cjs/components/SideNavigation/index.js +41 -0
  34. package/dist/cjs/components/index.js +131 -0
  35. package/dist/cjs/index.js +131 -0
  36. package/dist/cjs/version.json +5 -0
  37. package/dist/es2019/common/constants.js +2 -0
  38. package/dist/es2019/common/styles.js +78 -0
  39. package/dist/es2019/components/Footer/index.js +52 -0
  40. package/dist/es2019/components/Header/index.js +46 -0
  41. package/dist/es2019/components/Item/button-item.js +25 -0
  42. package/dist/es2019/components/Item/custom-item.js +31 -0
  43. package/dist/es2019/components/Item/go-back-item.js +34 -0
  44. package/dist/es2019/components/Item/index.js +5 -0
  45. package/dist/es2019/components/Item/link-item.js +25 -0
  46. package/dist/es2019/components/Item/skeleton-item.js +28 -0
  47. package/dist/es2019/components/LoadingItems/index.js +38 -0
  48. package/dist/es2019/components/NavigationContent/index.js +38 -0
  49. package/dist/es2019/components/NavigationContent/styles.js +120 -0
  50. package/dist/es2019/components/NavigationFooter/index.js +18 -0
  51. package/dist/es2019/components/NavigationHeader/index.js +20 -0
  52. package/dist/es2019/components/NestableNavigationContent/context.js +41 -0
  53. package/dist/es2019/components/NestableNavigationContent/index.js +148 -0
  54. package/dist/es2019/components/NestableNavigationContent/nesting-motion.js +21 -0
  55. package/dist/es2019/components/NestingItem/hack-for-ert.js +1 -0
  56. package/dist/es2019/components/NestingItem/index.js +128 -0
  57. package/dist/es2019/components/NestingItem/styles.js +39 -0
  58. package/dist/es2019/components/Section/heading-item.js +22 -0
  59. package/dist/es2019/components/Section/index.js +3 -0
  60. package/dist/es2019/components/Section/section.js +25 -0
  61. package/dist/es2019/components/Section/skeleton-heading-item.js +24 -0
  62. package/dist/es2019/components/SideNavigation/index.js +30 -0
  63. package/dist/es2019/components/index.js +11 -0
  64. package/dist/es2019/index.js +3 -0
  65. package/dist/es2019/version.json +5 -0
  66. package/dist/esm/common/constants.js +2 -0
  67. package/dist/esm/common/styles.js +82 -0
  68. package/dist/esm/components/Footer/index.js +51 -0
  69. package/dist/esm/components/Header/index.js +50 -0
  70. package/dist/esm/components/Item/button-item.js +25 -0
  71. package/dist/esm/components/Item/custom-item.js +31 -0
  72. package/dist/esm/components/Item/go-back-item.js +41 -0
  73. package/dist/esm/components/Item/index.js +5 -0
  74. package/dist/esm/components/Item/link-item.js +25 -0
  75. package/dist/esm/components/Item/skeleton-item.js +29 -0
  76. package/dist/esm/components/LoadingItems/index.js +39 -0
  77. package/dist/esm/components/NavigationContent/index.js +37 -0
  78. package/dist/esm/components/NavigationContent/styles.js +130 -0
  79. package/dist/esm/components/NavigationFooter/index.js +17 -0
  80. package/dist/esm/components/NavigationHeader/index.js +18 -0
  81. package/dist/esm/components/NestableNavigationContent/context.js +36 -0
  82. package/dist/esm/components/NestableNavigationContent/index.js +163 -0
  83. package/dist/esm/components/NestableNavigationContent/nesting-motion.js +28 -0
  84. package/dist/esm/components/NestingItem/hack-for-ert.js +1 -0
  85. package/dist/esm/components/NestingItem/index.js +144 -0
  86. package/dist/esm/components/NestingItem/styles.js +34 -0
  87. package/dist/esm/components/Section/heading-item.js +21 -0
  88. package/dist/esm/components/Section/index.js +3 -0
  89. package/dist/esm/components/Section/section.js +24 -0
  90. package/dist/esm/components/Section/skeleton-heading-item.js +25 -0
  91. package/dist/esm/components/SideNavigation/index.js +28 -0
  92. package/dist/esm/components/index.js +11 -0
  93. package/dist/esm/index.js +3 -0
  94. package/dist/esm/version.json +5 -0
  95. package/dist/types/common/constants.d.ts +2 -0
  96. package/dist/types/common/styles.d.ts +10 -0
  97. package/dist/types/components/Footer/index.d.ts +4 -0
  98. package/dist/types/components/Header/index.d.ts +43 -0
  99. package/dist/types/components/Item/button-item.d.ts +5 -0
  100. package/dist/types/components/Item/custom-item.d.ts +13 -0
  101. package/dist/types/components/Item/go-back-item.d.ts +5 -0
  102. package/dist/types/components/Item/index.d.ts +10 -0
  103. package/dist/types/components/Item/link-item.d.ts +5 -0
  104. package/dist/types/components/Item/skeleton-item.d.ts +4 -0
  105. package/dist/types/components/LoadingItems/index.d.ts +30 -0
  106. package/dist/types/components/NavigationContent/index.d.ts +17 -0
  107. package/dist/types/components/NavigationContent/styles.d.ts +91 -0
  108. package/dist/types/components/NavigationFooter/index.d.ts +7 -0
  109. package/dist/types/components/NavigationHeader/index.d.ts +5 -0
  110. package/dist/types/components/NestableNavigationContent/context.d.ts +20 -0
  111. package/dist/types/components/NestableNavigationContent/index.d.ts +58 -0
  112. package/dist/types/components/NestableNavigationContent/nesting-motion.d.ts +18 -0
  113. package/dist/types/components/NestingItem/hack-for-ert.d.ts +2 -0
  114. package/dist/types/components/NestingItem/index.d.ts +91 -0
  115. package/dist/types/components/NestingItem/styles.d.ts +28 -0
  116. package/dist/types/components/Section/heading-item.d.ts +4 -0
  117. package/dist/types/components/Section/index.d.ts +6 -0
  118. package/dist/types/components/Section/section.d.ts +25 -0
  119. package/dist/types/components/Section/skeleton-heading-item.d.ts +4 -0
  120. package/dist/types/components/SideNavigation/index.d.ts +23 -0
  121. package/dist/types/components/index.d.ts +22 -0
  122. package/dist/types/index.d.ts +4 -0
  123. package/docs/00-intro.tsx +70 -0
  124. package/docs/01-side-navigation.tsx +33 -0
  125. package/docs/02-navigation-header.tsx +39 -0
  126. package/docs/03-navigation-content.tsx +40 -0
  127. package/docs/04-nestable-navigation-content.tsx +95 -0
  128. package/docs/05-navigation-footer.tsx +38 -0
  129. package/docs/99-loading-states.tsx +95 -0
  130. package/docs/button-item.tsx +38 -0
  131. package/docs/custom-item.tsx +45 -0
  132. package/docs/go-back-item.tsx +31 -0
  133. package/docs/heading-item.tsx +30 -0
  134. package/docs/link-item.tsx +39 -0
  135. package/docs/nesting-item.tsx +52 -0
  136. package/docs/section.tsx +40 -0
  137. package/docs/skeleton-heading-item.tsx +30 -0
  138. package/docs/skeleton-item.tsx +30 -0
  139. package/package.json +71 -0
  140. package/tsconfig.json +15 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,517 @@
1
+ # @atlaskit/side-navigation
2
+
3
+ ## 1.1.2
4
+
5
+ ### Patch Changes
6
+
7
+ - Updated dependencies
8
+
9
+ ## 1.1.1
10
+
11
+ ### Patch Changes
12
+
13
+ - Updated dependencies
14
+
15
+ ## 1.1.0
16
+
17
+ ### Minor Changes
18
+
19
+ - [`0e1894c8eb0`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0e1894c8eb0) - Instrumented side navigation with the new theming package, `@atlaskit/tokens`.
20
+
21
+ New tokens will be visible only in applications configured to use the new Tokens API (currently in alpha).
22
+ These changes are intended to be interoperable with the legacy theme implementation. Legacy dark mode users should expect no visual or breaking changes.
23
+
24
+ ### Patch Changes
25
+
26
+ - Updated dependencies
27
+
28
+ ## 1.0.1
29
+
30
+ ### Patch Changes
31
+
32
+ - [`7c843858398`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7c843858398) - [ux] LinkItem and CustomItem now have correct blue text color when selected and the href has visited
33
+
34
+ ## 1.0.0
35
+
36
+ ### Major Changes
37
+
38
+ - [`7727f723965`](https://bitbucket.org/atlassian/atlassian-frontend/commits/7727f723965) - Internal change to the release model from continous to scheduled release. There are **NO API CHANGES** in this release.
39
+
40
+ ### Patch Changes
41
+
42
+ - Updated dependencies
43
+
44
+ ## 0.8.5
45
+
46
+ ### Patch Changes
47
+
48
+ - [`4e72825fa89`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4e72825fa89) - JET-1156:
49
+
50
+ - Export `VAR_SEPARATOR_COLOR` to override separator color when using custom backrounds in side navigation.
51
+ - Export `VAR_SCROLL_INDICATOR_COLOR` to override menu scroll indicator color when using custom backrounds in side navigation.
52
+
53
+ ## 0.8.4
54
+
55
+ ### Patch Changes
56
+
57
+ - [`240c4120435`](https://bitbucket.org/atlassian/atlassian-frontend/commits/240c4120435) - Side navigation now uses the new common utility to calculate scrollbar width for offsetting keylines.
58
+ - Updated dependencies
59
+
60
+ ## 0.8.3
61
+
62
+ ### Patch Changes
63
+
64
+ - [`e6f96e8d782`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e6f96e8d782) - Fix styling for hover and active states for disabled items
65
+
66
+ ## 0.8.2
67
+
68
+ ### Patch Changes
69
+
70
+ - [`101b102ed33`](https://bitbucket.org/atlassian/atlassian-frontend/commits/101b102ed33) - Fix disabled state; menu items with icons after the text should have height of 40px
71
+
72
+ ## 0.8.1
73
+
74
+ ### Patch Changes
75
+
76
+ - [`0b2f7e76803`](https://bitbucket.org/atlassian/atlassian-frontend/commits/0b2f7e76803) - Codemods will only format a file if it is mutated.
77
+
78
+ ## 0.8.0
79
+
80
+ ### Minor Changes
81
+
82
+ - [`79a40dec30`](https://bitbucket.org/atlassian/atlassian-frontend/commits/79a40dec30) - **Breaking** Adjusts the API of the cssFn prop used in both menu and side-navigation. The prop now no longer exposes the currentStyles to the user in the callback and instead only provides the current state. Users no longer need to spread the currentStyles into their components when overriding. This change also resolves a bug where cssFn overrides did not always take precedence correctly over the default component styles.
83
+
84
+ ### Patch Changes
85
+
86
+ - Updated dependencies
87
+
88
+ ## 0.7.10
89
+
90
+ ### Patch Changes
91
+
92
+ - [`d3265f19be`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d3265f19be) - Transpile packages using babel rather than tsc
93
+
94
+ ## 0.7.9
95
+
96
+ ### Patch Changes
97
+
98
+ - [`5f58283e1f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5f58283e1f) - Export types using Typescript's new "export type" syntax to satisfy Typescript's --isolatedModules compiler option.
99
+ This requires version 3.8 of Typescript, read more about how we handle Typescript versions here: https://atlaskit.atlassian.com/get-started
100
+ Also add `typescript` to `devDependencies` to denote version that the package was built with.
101
+
102
+ ## 0.7.8
103
+
104
+ ### Patch Changes
105
+
106
+ - [`e55c4eb5a8`](https://bitbucket.org/atlassian/atlassian-frontend/commits/e55c4eb5a8) - [ux] Earlier left sidebar was getting focus while clicking on it. We have removed focus ring to fix this issue.
107
+
108
+ ## 0.7.7
109
+
110
+ ### Patch Changes
111
+
112
+ - Updated dependencies
113
+
114
+ ## 0.7.6
115
+
116
+ ### Patch Changes
117
+
118
+ - [`6c525a8229`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6c525a8229) - Upgraded to TypeScript 3.9.6 and tslib to 2.0.0
119
+
120
+ Since tslib is a dependency for all our packages we recommend that products also follow this tslib upgrade
121
+ to prevent duplicates of tslib being bundled.
122
+
123
+ ## 0.7.5
124
+
125
+ ### Patch Changes
126
+
127
+ - [`a3c91f82f6`](https://bitbucket.org/atlassian/atlassian-frontend/commits/a3c91f82f6) - Add tabindex=0 to nested container which makes it focusable when interacting with keyboard.
128
+
129
+ ## 0.7.4
130
+
131
+ ### Patch Changes
132
+
133
+ - [`308ad47024`](https://bitbucket.org/atlassian/atlassian-frontend/commits/308ad47024) - Passes `cssFn` throught to NestingItem so that its styles can be customised
134
+
135
+ ## 0.7.3
136
+
137
+ ### Patch Changes
138
+
139
+ - Updated dependencies
140
+
141
+ ## 0.7.2
142
+
143
+ ### Patch Changes
144
+
145
+ - [`159e0808a5`](https://bitbucket.org/atlassian/atlassian-frontend/commits/159e0808a5) - Updates the background color of NestingItem, ButtonItem and LinkItem so that it can work with the Onboarding component.
146
+ Hover and selected states will appear darker and they provide better contrast against normal items.
147
+
148
+ ## 0.7.1
149
+
150
+ ### Patch Changes
151
+
152
+ - [`5b3383fe67`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5b3383fe67) - Nesting transitions will no longer occur if a modifier key such as Shift or Control is detected while clicking on a nesting item in the side-navigation.
153
+
154
+ ## 0.7.0
155
+
156
+ ### Minor Changes
157
+
158
+ - [`c7e637753f`](https://bitbucket.org/atlassian/atlassian-frontend/commits/c7e637753f) - Removed unused export of SIDEBAR_DEFAULT_WIDTH. It was added when page-layout wasn’t complete. Now page-layout is fairly mature, that’s why this export isn’t required anymore.
159
+
160
+ ## 0.6.1
161
+
162
+ ### Patch Changes
163
+
164
+ - [`01e279bdcd`](https://bitbucket.org/atlassian/atlassian-frontend/commits/01e279bdcd) - Restyled footer - align with new design
165
+
166
+ ## 0.6.0
167
+
168
+ ### Minor Changes
169
+
170
+ - [`87f4720f27`](https://bitbucket.org/atlassian/atlassian-frontend/commits/87f4720f27) - Officially dropping IE11 support, from this version onwards there are no warranties of the package working in IE11.
171
+ For more information see: https://community.developer.atlassian.com/t/atlaskit-to-drop-support-for-internet-explorer-11-from-1st-july-2020/39534
172
+
173
+ ### Patch Changes
174
+
175
+ - Updated dependencies
176
+
177
+ ## 0.5.7
178
+
179
+ ### Patch Changes
180
+
181
+ - Updated dependencies
182
+
183
+ ## 0.5.6
184
+
185
+ ### Patch Changes
186
+
187
+ - [`cc14956821`](https://bitbucket.org/atlassian/atlassian-frontend/commits/cc14956821) - Update all the theme imports to a path thats tree shakable
188
+
189
+ ## 0.5.5
190
+
191
+ ### Patch Changes
192
+
193
+ - [`5217dcfa4d`](https://bitbucket.org/atlassian/atlassian-frontend/commits/5217dcfa4d) - Remove opacity from side-navigation seperators that appear when the container scrolls. The color is the same, just without the alpha channel.
194
+
195
+ ## 0.5.4
196
+
197
+ ### Patch Changes
198
+
199
+ - [`d674e203b3`](https://bitbucket.org/atlassian/atlassian-frontend/commits/d674e203b3) - Previously Menu items controlled their own margin spacing which caused issues when trying to use them outside of Menu.
200
+ Now we have moved Menu item margin styles into the Section component so now the Section dictates the spacing around child items.
201
+ We had to update Side Navigation to control its child item margins as well.
202
+
203
+ ## 0.5.3
204
+
205
+ ### Patch Changes
206
+
207
+ - [`649f69b6d7`](https://bitbucket.org/atlassian/atlassian-frontend/commits/649f69b6d7) - Patch all packages that are used by confluence that have a broken es2019 dist
208
+
209
+ ## 0.5.2
210
+
211
+ ### Patch Changes
212
+
213
+ - [`131cee6d7a`](https://bitbucket.org/atlassian/atlassian-frontend/commits/131cee6d7a) - Add missing tslib dependency
214
+
215
+ ## 0.5.1
216
+
217
+ ### Patch Changes
218
+
219
+ - [`6ef13297b2`](https://bitbucket.org/atlassian/atlassian-frontend/commits/6ef13297b2) - Fixes scroll indicator not being the correct width when lazy loading large amounts of nav items.
220
+
221
+ ## 0.5.0
222
+
223
+ ### Minor Changes
224
+
225
+ - [`07b2d8c491`](https://bitbucket.org/atlassian/atlassian-frontend/commits/07b2d8c491) - FIX: NestedItem `iconAfter` will now display always and right arrow will show up and replace it on hover
226
+
227
+ ## 0.4.0
228
+
229
+ ### Minor Changes
230
+
231
+ - [minor][7e408e4037](https://bitbucket.org/atlassian/atlassian-frontend/commits/7e408e4037):
232
+
233
+ **BREAKING** - renames `elemBefore` and `elemAfter` props to `iconBefore` and `iconAfter` on all item components.- [minor][d1ef176211](https://bitbucket.org/atlassian/atlassian-frontend/commits/d1ef176211):
234
+
235
+ **BREAKING** - renames section heading to heading item- [minor][41760ea4a6](https://bitbucket.org/atlassian/atlassian-frontend/commits/41760ea4a6):
236
+
237
+ **BREAKING**: modifies custom item component to take only valid HTML attributes. This means `wrapperClass` is now known as `className`.- [minor][b3441cd210](https://bitbucket.org/atlassian/atlassian-frontend/commits/b3441cd210):
238
+
239
+ **BREAKING** - removes render go back item component from nesting item and nestable navigation content. Replaces with overrides equivalent.- [minor][e67a87dbf2](https://bitbucket.org/atlassian/atlassian-frontend/commits/e67a87dbf2):
240
+
241
+ **BREAKING** - renames `customItemComponent` prop on nesting item to `component`.
242
+
243
+ ### Patch Changes
244
+
245
+ - [patch][724935beab](https://bitbucket.org/atlassian/atlassian-frontend/commits/724935beab):
246
+
247
+ Adds loading section component to use when wanting lazy load menu items.- [patch][6453c8de48](https://bitbucket.org/atlassian/atlassian-frontend/commits/6453c8de48):
248
+
249
+ Exposes typescript types alongside components.- [patch][3bfb526c22](https://bitbucket.org/atlassian/atlassian-frontend/commits/3bfb526c22):
250
+
251
+ Corrects disabled nesting item to not show the after element on hover.- [patch][7a9bf45e58](https://bitbucket.org/atlassian/atlassian-frontend/commits/7a9bf45e58):
252
+
253
+ Fixes section heading to correctly compose passed in css function.- [patch][d8dc3813c1](https://bitbucket.org/atlassian/atlassian-frontend/commits/d8dc3813c1):
254
+
255
+ Fixes section heading spacing.- [patch][684ee794d6](https://bitbucket.org/atlassian/atlassian-frontend/commits/684ee794d6):
256
+
257
+ Improves type safety with custom item by using TypeScript generics to pass on the custom component types to the parent.- Updated dependencies [7e408e4037](https://bitbucket.org/atlassian/atlassian-frontend/commits/7e408e4037):
258
+
259
+ - Updated dependencies [5633f516a4](https://bitbucket.org/atlassian/atlassian-frontend/commits/5633f516a4):
260
+ - Updated dependencies [6453c8de48](https://bitbucket.org/atlassian/atlassian-frontend/commits/6453c8de48):
261
+ - Updated dependencies [168b5f90e5](https://bitbucket.org/atlassian/atlassian-frontend/commits/168b5f90e5):
262
+ - Updated dependencies [e4dde0ad13](https://bitbucket.org/atlassian/atlassian-frontend/commits/e4dde0ad13):
263
+ - Updated dependencies [41760ea4a6](https://bitbucket.org/atlassian/atlassian-frontend/commits/41760ea4a6):
264
+ - Updated dependencies [0c270847cb](https://bitbucket.org/atlassian/atlassian-frontend/commits/0c270847cb):
265
+ - Updated dependencies [971e294b1e](https://bitbucket.org/atlassian/atlassian-frontend/commits/971e294b1e):
266
+ - Updated dependencies [684ee794d6](https://bitbucket.org/atlassian/atlassian-frontend/commits/684ee794d6):
267
+ - Updated dependencies [109004a98e](https://bitbucket.org/atlassian/atlassian-frontend/commits/109004a98e):
268
+ - Updated dependencies [b9903e773a](https://bitbucket.org/atlassian/atlassian-frontend/commits/b9903e773a):
269
+ - Updated dependencies [286770886d](https://bitbucket.org/atlassian/atlassian-frontend/commits/286770886d):
270
+ - Updated dependencies [2c1b78027c](https://bitbucket.org/atlassian/atlassian-frontend/commits/2c1b78027c):
271
+ - Updated dependencies [fb3ca3a3b2](https://bitbucket.org/atlassian/atlassian-frontend/commits/fb3ca3a3b2):
272
+ - @atlaskit/menu@0.4.0
273
+ - @atlaskit/motion@0.2.3
274
+ - @atlaskit/docs@8.5.1
275
+ - @atlaskit/theme@9.5.3
276
+ - @atlaskit/button@13.3.10
277
+
278
+ ## 0.3.1
279
+
280
+ ### Patch Changes
281
+
282
+ - [patch][ab133d934f](https://bitbucket.org/atlassian/atlassian-frontend/commits/ab133d934f):
283
+
284
+ Change imports to comply with Atlassian conventions
285
+
286
+ ## 0.3.0
287
+
288
+ ### Minor Changes
289
+
290
+ - [minor][7ecbf8d0bd](https://bitbucket.org/atlassian/atlassian-frontend/commits/7ecbf8d0bd):
291
+
292
+ **Breaking:**
293
+
294
+ - SideNavigation now has a required `label` prop.
295
+
296
+ **Accessibility Changes**
297
+
298
+ - SideNavigation now has a `navigation` landmark for use with screen readers;
299
+ this landmark is further described by the `label` prop to differentiate it from
300
+ AtlassianNavigation- [minor][1fea6757c4](https://bitbucket.org/atlassian/atlassian-frontend/commits/1fea6757c4):
301
+
302
+ **BREAKING** - NavigationFooter component has been renamed to Footer.
303
+
304
+ ### Patch Changes
305
+
306
+ - [patch][7b230682c2](https://bitbucket.org/atlassian/atlassian-frontend/commits/7b230682c2):
307
+
308
+ Adds controlled component support.
309
+ It is now possible to use the `stack` and `onChange` props on the `NestableNavigationContent` component to dictate which view is active.
310
+ This is useful for use cases where nested views need to be changed programmatically.
311
+
312
+ ```
313
+ const [stack, setStack] = useState([]);
314
+
315
+ <SideNavigation>
316
+ <NestableNavigationContent
317
+ onChange={setStack}
318
+ stack={stack}
319
+ >
320
+ ...
321
+ </NestableNavigationContent>
322
+ </SideNavigation>
323
+ ```
324
+
325
+ This is supported by a new hook called `useShouldNestedElementRender()`.
326
+ All components that can be composed with `NestableNavigationContent` use it out of the box,
327
+ but if you want to compose your own components you may have to opt into it else you will see your component rendering on every view (which may or may not be what you want).
328
+
329
+ ```
330
+ import { useShouldNestedElementRender } from '@atlaskit/side-navigation';
331
+
332
+ const MyCustomComponent = () => {
333
+ const { shouldRender } = useShouldNestedElementRender();
334
+
335
+ if (shouldRender) {
336
+ return <div>hello world!</div>;
337
+ }
338
+
339
+ // If your component takes children you'll probably want to return children here instead.
340
+ return null;
341
+ };
342
+ ```
343
+
344
+ ```
345
+ <SideNavigation>
346
+ <NestableNavigationContent>
347
+ <MyCustomComponent />
348
+ </NestableNavigationContent>
349
+ </SideNavigation>
350
+ ```
351
+
352
+ - [patch][5c0bb69f7b](https://bitbucket.org/atlassian/atlassian-frontend/commits/5c0bb69f7b):
353
+
354
+ Fixes horizontal alignment for item icons in relation to the app switcher in the horizontal navigation bar.- [patch][1a3192c1c1](https://bitbucket.org/atlassian/atlassian-frontend/commits/1a3192c1c1):
355
+
356
+ Introduces skeletons for heading and item components.- [patch][43353900f7](https://bitbucket.org/atlassian/atlassian-frontend/commits/43353900f7):
357
+
358
+ Corrects and consolidates colors for item and side navigation components.- [patch][c60324c748](https://bitbucket.org/atlassian/atlassian-frontend/commits/c60324c748):
359
+
360
+ Adds new Footer component. Ensures this and the Header component come with baked in styles for you to use out of the box.- [patch][c56d86d95c](https://bitbucket.org/atlassian/atlassian-frontend/commits/c56d86d95c):
361
+
362
+ Adds scrolling indicators to the scrollable container component.
363
+
364
+ - Updated dependencies [ed8d8dea65](https://bitbucket.org/atlassian/atlassian-frontend/commits/ed8d8dea65):
365
+ - Updated dependencies [db2f869556](https://bitbucket.org/atlassian/atlassian-frontend/commits/db2f869556):
366
+ - Updated dependencies [81ea791176](https://bitbucket.org/atlassian/atlassian-frontend/commits/81ea791176):
367
+ - Updated dependencies [6e2dda87f4](https://bitbucket.org/atlassian/atlassian-frontend/commits/6e2dda87f4):
368
+ - Updated dependencies [e57c4aa96d](https://bitbucket.org/atlassian/atlassian-frontend/commits/e57c4aa96d):
369
+ - Updated dependencies [8c9e4f1ec6](https://bitbucket.org/atlassian/atlassian-frontend/commits/8c9e4f1ec6):
370
+ - Updated dependencies [89d35b919a](https://bitbucket.org/atlassian/atlassian-frontend/commits/89d35b919a):
371
+ - Updated dependencies [083cfbaeb4](https://bitbucket.org/atlassian/atlassian-frontend/commits/083cfbaeb4):
372
+ - Updated dependencies [46d95777ef](https://bitbucket.org/atlassian/atlassian-frontend/commits/46d95777ef):
373
+ - Updated dependencies [9b264df34d](https://bitbucket.org/atlassian/atlassian-frontend/commits/9b264df34d):
374
+ - @atlaskit/menu@0.3.1
375
+ - @atlaskit/atlassian-navigation@0.10.0
376
+ - @atlaskit/docs@8.5.0
377
+
378
+ ## 0.2.0
379
+
380
+ ### Minor Changes
381
+
382
+ - [minor][dce5efb012](https://bitbucket.org/atlassian/atlassian-frontend/commits/dce5efb012):
383
+
384
+ Support forward ref on side-navigation primitives
385
+
386
+ ### Patch Changes
387
+
388
+ - [patch][4da717940e](https://bitbucket.org/atlassian/atlassian-frontend/commits/4da717940e):
389
+
390
+ Refactor side-navigation nesting logic to support async components- [patch][93709ca7eb](https://bitbucket.org/atlassian/atlassian-frontend/commits/93709ca7eb):
391
+
392
+ Adds `testId` to `NestingItem`- Updated dependencies [66dcced7a0](https://bitbucket.org/atlassian/atlassian-frontend/commits/66dcced7a0):
393
+
394
+ - Updated dependencies [fd5292fd5a](https://bitbucket.org/atlassian/atlassian-frontend/commits/fd5292fd5a):
395
+ - Updated dependencies [fd5292fd5a](https://bitbucket.org/atlassian/atlassian-frontend/commits/fd5292fd5a):
396
+ - Updated dependencies [eea5e9bd8c](https://bitbucket.org/atlassian/atlassian-frontend/commits/eea5e9bd8c):
397
+ - Updated dependencies [7a6e5f6e3d](https://bitbucket.org/atlassian/atlassian-frontend/commits/7a6e5f6e3d):
398
+ - Updated dependencies [fd5292fd5a](https://bitbucket.org/atlassian/atlassian-frontend/commits/fd5292fd5a):
399
+ - @atlaskit/docs@8.4.0
400
+ - @atlaskit/icon@20.1.0
401
+ - @atlaskit/logo@12.3.3
402
+ - @atlaskit/menu@0.3.0
403
+ - @atlaskit/button@13.3.9
404
+
405
+ ## 0.1.0
406
+
407
+ ### Minor Changes
408
+
409
+ - [minor][e1416630ed](https://bitbucket.org/atlassian/atlassian-frontend/commits/e1416630ed):
410
+
411
+ **BREAKING**: Renamed exported components
412
+
413
+ - Renamed `MainSection` to `NavigationContent`
414
+ - Renamed `NestingTransitionProvider` to `NestableNavigationContent`
415
+ - `NestableNavigationContent` does not need to be wrapped by a `MainSection`
416
+ - Renamed `HeaderSection` to `NavigationHeader`
417
+ - Renamed `Footer` to `NavigationFooter`
418
+
419
+ Improve behaviour of scrollabe sections:
420
+
421
+ - Fixes a bug where different views shared the same scrollable section causing unexpected jumps on some unnesting interactions
422
+ - `ScrollableSection` now shows an overflow indicator when items are scrolled off the top border
423
+ - Fixes a bug where the Go Back component could scroll off the top in some cases- [minor][d752f27427](https://bitbucket.org/atlassian/atlassian-frontend/commits/d752f27427):
424
+
425
+ API changes and design changes for side-navigation
426
+
427
+ - **BREAKING**: `SectionHeader` has been renamed to `SectionHeading`
428
+ - `SIDEBAR_DEFAULT_WIDTH` has been exported
429
+ - `Item` has been removed and replaced with `CustomItem`, `ButtonItem`, `LinkItem` which are thin wrappers around their `@atlaskit/menu` counterparts
430
+ - All exported components now have sensible default styles applied
431
+ - A `GoBackItem` has been exported
432
+ - `testId` props have been added to more components with `side-navigation`
433
+ - `CustomItem`, `ButtonItem` and `LinkItem` themselves have a `cssFn` prop exposed which will allow custom styles to be applied and combined with side-navigation defaults
434
+ - `Heading` and `Footer` have been updated to allow consumers to pass in their own custom components
435
+ - Rich examples have been updated for composing your own navigations with RBD etc.- [minor][08fa439ec7](https://bitbucket.org/atlassian/atlassian-frontend/commits/08fa439ec7):
436
+
437
+ **BREAKING**: `id` prop is now required on NestingItems
438
+
439
+ The back button in nested views can now be customised
440
+
441
+ - By default an English `Go Back` button will be shown
442
+ - Use `renderDefaultBackButton` on the `NestableNavigationContent` to set a new default
443
+ - Use `renderBackButton` on each `NestingItem` to specifically set a back trigger for exiting the view it controls
444
+
445
+ The link form of nested views can now be customised
446
+
447
+ - Use `customItemComponent` to pass in a functional/class component that adds extra behaviour around the link (see @atlaskit/menu for examples on how to configure CustomItems)
448
+
449
+ ### Patch Changes
450
+
451
+ - [patch][babae63a7b](https://bitbucket.org/atlassian/atlassian-frontend/commits/babae63a7b):
452
+
453
+ - Refactors nested navigation implementation
454
+ - Now selects `NestingItem` & `GoBackItem` when it is exiting
455
+ - Fixes double clicking a `NestingItem` and `GoBackItem` resulting in an unwanted double navigation
456
+ - Fixes `NestingItem` not calling back on click
457
+ - Adds optional `id` prop to `NestingItem`- Updated dependencies [1f9c4f974a](https://bitbucket.org/atlassian/atlassian-frontend/commits/1f9c4f974a):
458
+
459
+ - Updated dependencies [b80c88fd26](https://bitbucket.org/atlassian/atlassian-frontend/commits/b80c88fd26):
460
+ - Updated dependencies [9ec1606d00](https://bitbucket.org/atlassian/atlassian-frontend/commits/9ec1606d00):
461
+ - Updated dependencies [0603860c07](https://bitbucket.org/atlassian/atlassian-frontend/commits/0603860c07):
462
+ - Updated dependencies [1b3069e06b](https://bitbucket.org/atlassian/atlassian-frontend/commits/1b3069e06b):
463
+ - @atlaskit/menu@0.2.7
464
+ - @atlaskit/atlassian-navigation@0.9.6
465
+ - @atlaskit/icon@20.0.2
466
+
467
+ ## 0.0.4
468
+
469
+ ### Patch Changes
470
+
471
+ - [patch][6548261c9a](https://bitbucket.org/atlassian/atlassian-frontend/commits/6548261c9a):
472
+
473
+ Remove namespace imports from React, ReactDom, and PropTypes- Updated dependencies [6548261c9a](https://bitbucket.org/atlassian/atlassian-frontend/commits/6548261c9a):
474
+
475
+ - @atlaskit/docs@8.3.2
476
+ - @atlaskit/icon@20.0.1
477
+ - @atlaskit/menu@0.2.6
478
+ - @atlaskit/theme@9.5.1
479
+ - @atlaskit/motion@0.2.2
480
+
481
+ ## 0.0.3
482
+
483
+ ### Patch Changes
484
+
485
+ - [patch][f3433f2096](https://bitbucket.org/atlassian/atlassian-frontend/commits/f3433f2096):
486
+
487
+ `NestingItem` now has an extra prop `isInitiallyOpen` that allows the side-navigation to initially render a particular nested view
488
+
489
+ - To select a particular sidebar view to be rendered initially the `isInitiallyOpen` prop must be set on all parent `NestingItem`s in the navigation tree- [patch][a806cde423](https://bitbucket.org/atlassian/atlassian-frontend/commits/a806cde423):
490
+
491
+ Iterative updates to side-navigation:
492
+
493
+ - Go Back link in nested views now sticks to the top of the scrollable area
494
+ - Removed broken css styles
495
+ - Implemented sliding transitions rather than fades- Updated dependencies [4ed951b8d8](https://bitbucket.org/atlassian/atlassian-frontend/commits/4ed951b8d8):
496
+
497
+ - Updated dependencies [e0e91e02a6](https://bitbucket.org/atlassian/atlassian-frontend/commits/e0e91e02a6):
498
+ - Updated dependencies [c0102a3ea2](https://bitbucket.org/atlassian/atlassian-frontend/commits/c0102a3ea2):
499
+ - Updated dependencies [166d7b1626](https://bitbucket.org/atlassian/atlassian-frontend/commits/166d7b1626):
500
+ - @atlaskit/menu@0.2.4
501
+ - @atlaskit/icon@20.0.0
502
+ - @atlaskit/motion@0.2.1
503
+ - @atlaskit/docs@8.3.1
504
+
505
+ ## 0.0.2
506
+
507
+ ### Patch Changes
508
+
509
+ - [patch][0e6929fbb9](https://bitbucket.org/atlassian/atlassian-frontend/commits/0e6929fbb9):
510
+
511
+ Fixes a broken internal omport- [patch][146ca7139a](https://bitbucket.org/atlassian/atlassian-frontend/commits/146ca7139a):
512
+
513
+ Bump package to enable branch deploys- Updated dependencies [d2b8166208](https://bitbucket.org/atlassian/atlassian-frontend/commits/d2b8166208):
514
+
515
+ - Updated dependencies [1d72045e6b](https://bitbucket.org/atlassian/atlassian-frontend/commits/1d72045e6b):
516
+ - @atlaskit/docs@8.3.0
517
+ - @atlaskit/motion@0.2.0