@atlaskit/navigation-system 5.29.0 → 5.29.1

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @atlassian/navigation-system
 
+## 5.29.1
+
+### Patch Changes
+
+- [`88290f9d44829`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/88290f9d44829) -
+  Update the `Aside` component's description to indicate our intention to deprecate it in the
+  future.
+
 ## 5.29.0
 
 ### Minor Changes

package/constellation/layout/code.mdx

@@ -1,6 +1,6 @@
 ---
 title: Layout
-description: Layout components define a page’s structure and the areas for navigation and content.
+description: Layout components define a page's structure and the areas for navigation and content.
 order: 3
 props:
   packageName: '@atlaskit/navigation-system'
@@ -23,6 +23,8 @@ props:
     - SideNavToggleButton
 ---
 
+import SectionMessage from '@atlaskit/section-message';
+
 ## Props
 
 ### Root
@@ -103,6 +105,10 @@ The sticky header of the main layout area.
 
 ### Aside
 
+<SectionMessage appearance="warning" title="Caution">
+	We are planning on deprecating the Aside component. Please use Panel instead.
+</SectionMessage>
+
 The Aside layout area is rendered to the right (inline end) of the Main area.
 
 <TSMorphProps exportName="Aside" packageName="@atlaskit/navigation-system" />

package/constellation/layout/examples.mdx

@@ -159,7 +159,11 @@ fill available space.
 
 ### Aside
 
-`Aside` is rendered to the right of the `Main` area.
+<SectionMessage appearance="warning" title="Caution">
+	We are planning on deprecating the Aside component. Please use Panel instead.
+</SectionMessage>
+
+`Aside` is rendered to the right of the `Main` area.
 
 - The default width of the Aside is 330px, and it is
   [resizable](/components/navigation-system/layout/examples#aside-resizing) and

package/constellation/layout/usage.mdx

@@ -7,6 +7,8 @@ order: 4
 import layoutDo from './images/layout-do.png';
 import layoutDont from './images/layout-dont.png';
 
+import SectionMessage from '@atlaskit/section-message';
+
 ## Usage
 
 Use layout to compose the structure of your application. It also defines the page behavior and
@@ -58,7 +60,7 @@ When applying components to the navigational areas,
 	</li>
 	<li>
 		<strong>Aside:</strong> Optional. Use to display supporting or supplementary content. Is
-		resizable.
+		resizable. <em>We plan to deprecate this component, please use Panel instead.</em>
 	</li>
 	<li>
 		<strong>Panel:</strong> Optional. Use to display supporting or supplementary content. Is
@@ -68,6 +70,10 @@ When applying components to the navigational areas,
 
 ### The difference between Aside, Panel and Modal dialog
 
+<SectionMessage appearance="warning" title="Caution">
+	We are planning on deprecating the Aside component. Please use Panel instead.
+</SectionMessage>
+
 The main difference between Aside, Panel and Modal dialog is their behaviours:
 
 - **Aside** is not collapsible, while **Panel** can be collapsible.

package/dist/cjs/ui/page-layout/aside.js

@@ -61,6 +61,8 @@ var fallbackDefaultWidth = 330;
  * The Aside is rendered to the right (inline end) of the Main area.
  *
  * You can optionally render a `PanelSplitter` as a child to make the aside area resizable.
+ *
+ * Note: We plan to deprecate the Aside component. Please use Panel instead.
  */
 function Aside(_ref) {
   var children = _ref.children,

package/dist/es2019/ui/page-layout/aside.js

@@ -50,6 +50,8 @@ const fallbackDefaultWidth = 330;
  * The Aside is rendered to the right (inline end) of the Main area.
  *
  * You can optionally render a `PanelSplitter` as a child to make the aside area resizable.
+ *
+ * Note: We plan to deprecate the Aside component. Please use Panel instead.
  */
 export function Aside({
   children,

package/dist/esm/ui/page-layout/aside.js

@@ -52,6 +52,8 @@ var fallbackDefaultWidth = 330;
  * The Aside is rendered to the right (inline end) of the Main area.
  *
  * You can optionally render a `PanelSplitter` as a child to make the aside area resizable.
+ *
+ * Note: We plan to deprecate the Aside component. Please use Panel instead.
  */
 export function Aside(_ref) {
   var children = _ref.children,

package/dist/types/ui/page-layout/aside.d.ts

@@ -4,6 +4,8 @@ import type { CommonSlotProps } from './types';
  * The Aside is rendered to the right (inline end) of the Main area.
  *
  * You can optionally render a `PanelSplitter` as a child to make the aside area resizable.
+ *
+ * Note: We plan to deprecate the Aside component. Please use Panel instead.
  */
 export declare function Aside({ children, xcss, defaultWidth: defaultWidthProp, label, skipLinkLabel, testId, id: providedId, }: CommonSlotProps & {
     /**

package/dist/types-ts4.5/ui/page-layout/aside.d.ts

@@ -4,6 +4,8 @@ import type { CommonSlotProps } from './types';
  * The Aside is rendered to the right (inline end) of the Main area.
  *
  * You can optionally render a `PanelSplitter` as a child to make the aside area resizable.
+ *
+ * Note: We plan to deprecate the Aside component. Please use Panel instead.
  */
 export declare function Aside({ children, xcss, defaultWidth: defaultWidthProp, label, skipLinkLabel, testId, id: providedId, }: CommonSlotProps & {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/navigation-system",
-	"version": "5.29.0",
+	"version": "5.29.1",
 	"description": "The latest navigation system for Atlassian apps.",
 	"repository": "https://bitbucket.org/atlassian/atlassian-frontend-mirror",
 	"author": "Atlassian Pty Ltd",