@atlaskit/help-layout 6.3.10 → 6.3.11

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/help-layout
 
+## 6.3.11
+
+### Patch Changes
+
+- [`bc7821de4d118`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/bc7821de4d118) -
+  Sorted type and interface props to improve Atlaskit docs
+
 ## 6.3.10
 
 ### Patch Changes

package/dist/cjs/analytics.js

@@ -13,5 +13,5 @@ var createAndFire = exports.createAndFire = x.createAndFireEvent('atlaskit');
 var defaultAnalyticsAttributes = exports.defaultAnalyticsAttributes = {
   componentName: 'helpPanel',
   packageName: "@atlaskit/help-layout",
-  packageVersion: "6.3.9"
+  packageVersion: "6.3.10"
 };

package/dist/cjs/components/Header/BackButton.js

@@ -56,7 +56,7 @@ var BackButtonWithContext = function BackButtonWithContext(props) {
     data: {
       componentName: 'backButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/_react.default.createElement(BackButton, props));
 };

package/dist/cjs/components/Header/CloseButton.js

@@ -55,7 +55,7 @@ var CloseButtonWithContext = function CloseButtonWithContext(props) {
     data: {
       componentName: 'closeButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/_react.default.createElement(CloseButton, props));
 };

package/dist/es2019/analytics.js

@@ -5,5 +5,5 @@ export const createAndFire = x.createAndFireEvent('atlaskit');
 export const defaultAnalyticsAttributes = {
   componentName: 'helpPanel',
   packageName: "@atlaskit/help-layout",
-  packageVersion: "6.3.9"
+  packageVersion: "6.3.10"
 };

package/dist/es2019/components/Header/BackButton.js

@@ -50,7 +50,7 @@ const BackButtonWithContext = props => {
     data: {
       componentName: 'backButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/React.createElement(BackButton, props));
 };

package/dist/es2019/components/Header/CloseButton.js

@@ -51,7 +51,7 @@ const CloseButtonWithContext = props => {
     data: {
       componentName: 'closeButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/React.createElement(CloseButton, props));
 };

package/dist/esm/analytics.js

@@ -5,5 +5,5 @@ export var createAndFire = x.createAndFireEvent('atlaskit');
 export var defaultAnalyticsAttributes = {
   componentName: 'helpPanel',
   packageName: "@atlaskit/help-layout",
-  packageVersion: "6.3.9"
+  packageVersion: "6.3.10"
 };

package/dist/esm/components/Header/BackButton.js

@@ -49,7 +49,7 @@ var BackButtonWithContext = function BackButtonWithContext(props) {
     data: {
       componentName: 'backButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/React.createElement(BackButton, props));
 };

package/dist/esm/components/Header/CloseButton.js

@@ -48,7 +48,7 @@ var CloseButtonWithContext = function CloseButtonWithContext(props) {
     data: {
       componentName: 'closeButton',
       packageName: "@atlaskit/help-layout",
-      packageVersion: "6.3.9"
+      packageVersion: "6.3.10"
     }
   }, /*#__PURE__*/React.createElement(CloseButton, props));
 };

package/dist/types/components/DynamicHeader/NewChatButton.d.ts

@@ -4,8 +4,8 @@
  */
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
     isDisabled?: boolean;
+    onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
 }
 export declare const NewChatButton: ({ onClick, isDisabled }: Props) => JSX.Element;
 export {};

package/dist/types/components/Header/BackButton.d.ts

@@ -2,8 +2,8 @@ import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
     isVisible?: boolean;
+    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
 }
 export declare const BackButton: React.FC<Props & WrappedComponentProps>;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {

package/dist/types/components/Header/CloseButton.d.ts

@@ -2,8 +2,8 @@ import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
     inDynamicHeader?: boolean;
+    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
 }
 /**
  * This function will return a CloseButton component only if the function

package/dist/types/components/Header/styled.d.ts

@@ -8,13 +8,13 @@ export declare const HeaderContainer: ({ children }: {
     children: React.ReactNode;
 }) => JSX.Element;
 export declare const CloseButtonContainer: ({ inDynamicHeader, children, }: {
-    inDynamicHeader: boolean;
     children: React.ReactNode;
+    inDynamicHeader: boolean;
 }) => JSX.Element;
 export declare const TRANSITION_DURATION_MS = 220;
 export declare const BackButtonContainer: ({ transitionState, children, }: {
-    transitionState: TransitionStatus;
     children: React.ReactNode;
+    transitionState: TransitionStatus;
 }) => JSX.Element;
 export declare const HeaderTitle: ({ children }: {
     children: React.ReactNode;

package/dist/types/components/MessagesIntlProvider.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 export interface Props {
-    locale?: string;
     children: React.ReactNode;
+    locale?: string;
 }
 export declare const MessagesIntlProvider: React.FC<Props & WrappedComponentProps>;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {

package/dist/types/components/styled.d.ts

@@ -10,15 +10,15 @@ export declare const Section: ({ children }: {
     children: React.ReactNode;
 }) => JSX.Element;
 export declare const HelpFooter: ({ dataTestId, children, }: {
-    dataTestId: string;
     children: React.ReactNode;
+    dataTestId: string;
 }) => JSX.Element;
 export declare const LoadingContainer: ({ children, ...rest }: {
     children: React.ReactNode;
 } & React.HTMLAttributes<HTMLDivElement>) => JSX.Element;
 type LoadingRectangleProps = {
-    contentWidth?: string;
     contentHeight?: string;
+    contentWidth?: string;
     marginTop?: string;
 };
 export declare const LoadingRectangle: ({ contentWidth, contentHeight, marginTop, }: LoadingRectangleProps) => JSX.Element;

package/dist/types/model/HelpLayout.d.ts

@@ -1,31 +1,31 @@
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 export interface HelpPanelHeader {
-    headerTitle?: string;
     headerContent?: React.ReactNode;
-    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    isBackbuttonVisible?: boolean;
+    headerTitle?: string;
     isAiEnabled?: boolean;
+    isBackbuttonVisible?: boolean;
+    onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
 }
 export interface HeaderContent {
-    title: string;
-    onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    isBackButtonVisible?: boolean;
     newChatButtonDisabled?: boolean;
+    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
     onGoBackToHistoryList?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    isBackButtonVisible?: boolean;
+    onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    title: string;
 }
 export interface SideNavTab {
+    contentRender: () => React.ReactNode;
+    header: HeaderContent;
     icon: React.ReactNode;
     label: string;
-    contentRender: () => React.ReactNode;
     onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
-    header: HeaderContent;
 }
 export interface HelpLayout extends HelpPanelHeader {
-    isLoading?: boolean;
-    footer?: React.ReactNode;
     children?: React.ReactNode;
-    sideNavTabs?: SideNavTab[];
+    footer?: React.ReactNode;
+    isLoading?: boolean;
     onLoad?: () => void;
+    sideNavTabs?: SideNavTab[];
 }

package/dist/types-ts4.5/components/DynamicHeader/NewChatButton.d.ts

@@ -4,8 +4,8 @@
  */
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
     isDisabled?: boolean;
+    onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
 }
 export declare const NewChatButton: ({ onClick, isDisabled }: Props) => JSX.Element;
 export {};

package/dist/types-ts4.5/components/Header/BackButton.d.ts

@@ -2,8 +2,8 @@ import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
     isVisible?: boolean;
+    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
 }
 export declare const BackButton: React.FC<Props & WrappedComponentProps>;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {

package/dist/types-ts4.5/components/Header/CloseButton.d.ts

@@ -2,8 +2,8 @@ import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 interface Props {
-    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
     inDynamicHeader?: boolean;
+    onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
 }
 /**
  * This function will return a CloseButton component only if the function

package/dist/types-ts4.5/components/Header/styled.d.ts

@@ -8,13 +8,13 @@ export declare const HeaderContainer: ({ children }: {
     children: React.ReactNode;
 }) => JSX.Element;
 export declare const CloseButtonContainer: ({ inDynamicHeader, children, }: {
-    inDynamicHeader: boolean;
     children: React.ReactNode;
+    inDynamicHeader: boolean;
 }) => JSX.Element;
 export declare const TRANSITION_DURATION_MS = 220;
 export declare const BackButtonContainer: ({ transitionState, children, }: {
-    transitionState: TransitionStatus;
     children: React.ReactNode;
+    transitionState: TransitionStatus;
 }) => JSX.Element;
 export declare const HeaderTitle: ({ children }: {
     children: React.ReactNode;

package/dist/types-ts4.5/components/MessagesIntlProvider.d.ts

@@ -1,8 +1,8 @@
 import React from 'react';
 import { type WrappedComponentProps } from 'react-intl-next';
 export interface Props {
-    locale?: string;
     children: React.ReactNode;
+    locale?: string;
 }
 export declare const MessagesIntlProvider: React.FC<Props & WrappedComponentProps>;
 declare const _default: React.FC<import("react-intl-next").WithIntlProps<Props & WrappedComponentProps>> & {

package/dist/types-ts4.5/components/styled.d.ts

@@ -10,15 +10,15 @@ export declare const Section: ({ children }: {
     children: React.ReactNode;
 }) => JSX.Element;
 export declare const HelpFooter: ({ dataTestId, children, }: {
-    dataTestId: string;
     children: React.ReactNode;
+    dataTestId: string;
 }) => JSX.Element;
 export declare const LoadingContainer: ({ children, ...rest }: {
     children: React.ReactNode;
 } & React.HTMLAttributes<HTMLDivElement>) => JSX.Element;
 type LoadingRectangleProps = {
-    contentWidth?: string;
     contentHeight?: string;
+    contentWidth?: string;
     marginTop?: string;
 };
 export declare const LoadingRectangle: ({ contentWidth, contentHeight, marginTop, }: LoadingRectangleProps) => JSX.Element;

package/dist/types-ts4.5/model/HelpLayout.d.ts

@@ -1,31 +1,31 @@
 import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
 export interface HelpPanelHeader {
-    headerTitle?: string;
     headerContent?: React.ReactNode;
-    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    isBackbuttonVisible?: boolean;
+    headerTitle?: string;
     isAiEnabled?: boolean;
+    isBackbuttonVisible?: boolean;
+    onBackButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
 }
 export interface HeaderContent {
-    title: string;
-    onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    isBackButtonVisible?: boolean;
     newChatButtonDisabled?: boolean;
+    onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
     onGoBackToHistoryList?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
-    isBackButtonVisible?: boolean;
+    onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
+    title: string;
 }
 export interface SideNavTab {
+    contentRender: () => React.ReactNode;
+    header: HeaderContent;
     icon: React.ReactNode;
     label: string;
-    contentRender: () => React.ReactNode;
     onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
-    header: HeaderContent;
 }
 export interface HelpLayout extends HelpPanelHeader {
-    isLoading?: boolean;
-    footer?: React.ReactNode;
     children?: React.ReactNode;
-    sideNavTabs?: SideNavTab[];
+    footer?: React.ReactNode;
+    isLoading?: boolean;
     onLoad?: () => void;
+    sideNavTabs?: SideNavTab[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/help-layout",
-	"version": "6.3.10",
+	"version": "6.3.11",
 	"description": "Layout for the atlaskit/help component.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"