@atlaskit/help-layout 6.0.2 → 6.2.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.
- package/CHANGELOG.md +24 -0
- package/afm-cc/tsconfig.json +9 -0
- package/afm-jira/tsconfig.json +9 -0
- package/dist/cjs/analytics.js +1 -1
- package/dist/cjs/components/DynamicHeader/NewChatButton.js +36 -0
- package/dist/cjs/components/DynamicHeader/index.compiled.css +4 -0
- package/dist/cjs/components/DynamicHeader/index.js +44 -0
- package/dist/cjs/components/Header/BackButton.js +1 -1
- package/dist/cjs/components/Header/CloseButton.js +6 -15
- package/dist/cjs/components/Header/index.js +2 -4
- package/dist/cjs/components/Header/styled.compiled.css +0 -6
- package/dist/cjs/components/Header/styled.js +18 -30
- package/dist/cjs/components/HelpLayoutContent.js +18 -3
- package/dist/cjs/components/SideNav/index.compiled.css +28 -0
- package/dist/cjs/components/SideNav/index.js +72 -0
- package/dist/cjs/messages.js +5 -0
- package/dist/es2019/analytics.js +1 -1
- package/dist/es2019/components/DynamicHeader/NewChatButton.js +28 -0
- package/dist/es2019/components/DynamicHeader/index.compiled.css +4 -0
- package/dist/es2019/components/DynamicHeader/index.js +35 -0
- package/dist/es2019/components/Header/BackButton.js +1 -1
- package/dist/es2019/components/Header/CloseButton.js +6 -16
- package/dist/es2019/components/Header/index.js +3 -5
- package/dist/es2019/components/Header/styled.compiled.css +0 -6
- package/dist/es2019/components/Header/styled.js +9 -15
- package/dist/es2019/components/HelpLayoutContent.js +13 -2
- package/dist/es2019/components/SideNav/index.compiled.css +28 -0
- package/dist/es2019/components/SideNav/index.js +57 -0
- package/dist/es2019/messages.js +5 -0
- package/dist/esm/analytics.js +1 -1
- package/dist/esm/components/DynamicHeader/NewChatButton.js +26 -0
- package/dist/esm/components/DynamicHeader/index.compiled.css +4 -0
- package/dist/esm/components/DynamicHeader/index.js +34 -0
- package/dist/esm/components/Header/BackButton.js +1 -1
- package/dist/esm/components/Header/CloseButton.js +7 -16
- package/dist/esm/components/Header/index.js +3 -5
- package/dist/esm/components/Header/styled.compiled.css +0 -6
- package/dist/esm/components/Header/styled.js +17 -29
- package/dist/esm/components/HelpLayoutContent.js +15 -3
- package/dist/esm/components/SideNav/index.compiled.css +28 -0
- package/dist/esm/components/SideNav/index.js +62 -0
- package/dist/esm/messages.js +5 -0
- package/dist/types/components/DynamicHeader/NewChatButton.d.ts +12 -0
- package/dist/types/components/DynamicHeader/index.d.ts +7 -0
- package/dist/types/components/Header/CloseButton.d.ts +1 -1
- package/dist/types/components/Header/styled.d.ts +2 -7
- package/dist/types/components/SideNav/index.d.ts +11 -0
- package/dist/types/messages.d.ts +5 -0
- package/dist/types/model/HelpLayout.d.ts +15 -1
- package/dist/types-ts4.5/components/DynamicHeader/NewChatButton.d.ts +12 -0
- package/dist/types-ts4.5/components/DynamicHeader/index.d.ts +7 -0
- package/dist/types-ts4.5/components/Header/CloseButton.d.ts +1 -1
- package/dist/types-ts4.5/components/Header/styled.d.ts +2 -7
- package/dist/types-ts4.5/components/SideNav/index.d.ts +11 -0
- package/dist/types-ts4.5/messages.d.ts +5 -0
- package/dist/types-ts4.5/model/HelpLayout.d.ts +15 -1
- package/package.json +4 -1
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
/* index.tsx generated by @compiled/babel-plugin v0.36.1 */
|
|
2
|
+
import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
|
|
3
|
+
import "./index.compiled.css";
|
|
4
|
+
import * as React from 'react';
|
|
5
|
+
import { ax, ix } from "@compiled/react/runtime";
|
|
6
|
+
import { useState } from 'react';
|
|
7
|
+
import { cx } from '@atlaskit/css';
|
|
8
|
+
import { Box, Flex, Pressable, Stack, Text } from '@atlaskit/primitives/compiled';
|
|
9
|
+
import Tooltip from '@atlaskit/tooltip';
|
|
10
|
+
import { DynamicHeader } from '../DynamicHeader';
|
|
11
|
+
var styles = {
|
|
12
|
+
mainContent: "_1reo1wug _18m91wug _4t3i1osq _1bsb1osq",
|
|
13
|
+
navBarWrapper: "_1reo1wug _18m91wug _4t3i1osq _1bsb1osq",
|
|
14
|
+
navButton: "_2rkoiti9 _zulpu2gc _19it145i _1rjcu2gc _1e0c1txw _bfhk1j28 _2lx21bp4 _4cvr1h6o _80omtlke _vchhusvi _o5721q9c _1bsb1osq _irr3166n _30l31fxt",
|
|
15
|
+
navButtonSelected: "_1h6d15qp _bfhkfg4m _syaz14q2 _irr3i1yw _30l314q2",
|
|
16
|
+
wrapper: "_1reo1wug _18m91wug _4t3i1osq _1ul91wqb _bfhk1d5g",
|
|
17
|
+
navItemWrapper: "_19pk1b66 _2hwx1b66 _otyr1b66 _18u01b66"
|
|
18
|
+
};
|
|
19
|
+
export var SideNav = function SideNav(_ref) {
|
|
20
|
+
var sideNavTabs = _ref.sideNavTabs;
|
|
21
|
+
var _useState = useState(0),
|
|
22
|
+
_useState2 = _slicedToArray(_useState, 2),
|
|
23
|
+
activeIndex = _useState2[0],
|
|
24
|
+
setActiveIndex = _useState2[1];
|
|
25
|
+
return /*#__PURE__*/React.createElement(Flex, {
|
|
26
|
+
xcss: styles.navBarWrapper
|
|
27
|
+
}, /*#__PURE__*/React.createElement(Flex, {
|
|
28
|
+
justifyContent: "space-between",
|
|
29
|
+
xcss: styles.wrapper,
|
|
30
|
+
direction: "column"
|
|
31
|
+
}, /*#__PURE__*/React.createElement(Stack, {
|
|
32
|
+
testId: "side-nav-tabs"
|
|
33
|
+
}, sideNavTabs.map(function (tab, index) {
|
|
34
|
+
return /*#__PURE__*/React.createElement(Box, {
|
|
35
|
+
xcss: styles.navItemWrapper,
|
|
36
|
+
key: tab.label,
|
|
37
|
+
testId: "side-nav-".concat(tab.label)
|
|
38
|
+
}, /*#__PURE__*/React.createElement(Tooltip, {
|
|
39
|
+
ignoreTooltipPointerEvents: true,
|
|
40
|
+
position: "left",
|
|
41
|
+
content: tab.label
|
|
42
|
+
}, /*#__PURE__*/React.createElement(Pressable, {
|
|
43
|
+
xcss: cx(styles.navButton, index === activeIndex && styles.navButtonSelected),
|
|
44
|
+
onClick: function onClick(event) {
|
|
45
|
+
setActiveIndex(index);
|
|
46
|
+
tab.onClick && (tab === null || tab === void 0 ? void 0 : tab.onClick(event));
|
|
47
|
+
},
|
|
48
|
+
testId: "side-nav-button-".concat(tab.label)
|
|
49
|
+
}, tab.icon, /*#__PURE__*/React.createElement(Text, {
|
|
50
|
+
size: "small",
|
|
51
|
+
color: index === activeIndex ? 'color.link' : 'color.text.subtle'
|
|
52
|
+
}, tab.label))));
|
|
53
|
+
}))), /*#__PURE__*/React.createElement(Flex, {
|
|
54
|
+
direction: "column",
|
|
55
|
+
xcss: styles.mainContent
|
|
56
|
+
}, /*#__PURE__*/React.createElement(DynamicHeader, {
|
|
57
|
+
title: sideNavTabs[activeIndex].header.title,
|
|
58
|
+
onCloseButtonClick: sideNavTabs[activeIndex].header.onCloseButtonClick,
|
|
59
|
+
onNewChatButtonClick: sideNavTabs[activeIndex].header.onNewChatButtonClick,
|
|
60
|
+
newChatButtonDisabled: sideNavTabs[activeIndex].header.newChatButtonDisabled
|
|
61
|
+
}), sideNavTabs[activeIndex].content));
|
|
62
|
+
};
|
package/dist/esm/messages.js
CHANGED
|
@@ -24,5 +24,10 @@ export var messages = defineMessages({
|
|
|
24
24
|
id: 'helpPanel.header.close.button',
|
|
25
25
|
defaultMessage: 'Close Help Panel',
|
|
26
26
|
description: ''
|
|
27
|
+
},
|
|
28
|
+
help_panel_new_chat_button: {
|
|
29
|
+
id: 'helpPanel.header.new.chat.button',
|
|
30
|
+
defaultMessage: 'New',
|
|
31
|
+
description: 'Start a new chat with CSM agent'
|
|
27
32
|
}
|
|
28
33
|
});
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
/// <reference types="react" />
|
|
6
|
+
import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
7
|
+
interface Props {
|
|
8
|
+
onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
9
|
+
isDisabled?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export declare const NewChatButton: ({ onClick, isDisabled }: Props) => JSX.Element;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
/// <reference types="react" />
|
|
6
|
+
import { type HeaderContent } from '../../model/HelpLayout';
|
|
7
|
+
export declare const DynamicHeader: ({ title, onCloseButtonClick, onNewChatButtonClick, newChatButtonDisabled, }: HeaderContent) => JSX.Element;
|
|
@@ -3,7 +3,7 @@ import { type WrappedComponentProps } from 'react-intl-next';
|
|
|
3
3
|
import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
4
4
|
interface Props {
|
|
5
5
|
onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
|
|
6
|
-
|
|
6
|
+
inDynamicHeader?: boolean;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* This function will return a CloseButton component only if the function
|
|
@@ -7,10 +7,8 @@ import { TransitionStatus } from '../constants';
|
|
|
7
7
|
export declare const HeaderContainer: ({ children }: {
|
|
8
8
|
children: React.ReactNode;
|
|
9
9
|
}) => JSX.Element;
|
|
10
|
-
export declare const CloseButtonContainer: ({ children }: {
|
|
11
|
-
|
|
12
|
-
}) => JSX.Element;
|
|
13
|
-
export declare const CloseButtonContainerAi: ({ children }: {
|
|
10
|
+
export declare const CloseButtonContainer: ({ inDynamicHeader, children, }: {
|
|
11
|
+
inDynamicHeader: boolean;
|
|
14
12
|
children: React.ReactNode;
|
|
15
13
|
}) => JSX.Element;
|
|
16
14
|
export declare const TRANSITION_DURATION_MS = 220;
|
|
@@ -21,9 +19,6 @@ export declare const BackButtonContainer: ({ transitionState, children, }: {
|
|
|
21
19
|
export declare const HeaderTitle: ({ children }: {
|
|
22
20
|
children: React.ReactNode;
|
|
23
21
|
}) => JSX.Element;
|
|
24
|
-
export declare const HeaderTitleAi: ({ children }: {
|
|
25
|
-
children: React.ReactNode;
|
|
26
|
-
}) => JSX.Element;
|
|
27
22
|
export declare const HeaderContent: ({ children }: {
|
|
28
23
|
children: React.ReactNode;
|
|
29
24
|
}) => JSX.Element;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @jsxRuntime classic
|
|
3
|
+
* @jsx jsx
|
|
4
|
+
*/
|
|
5
|
+
/// <reference types="react" />
|
|
6
|
+
import { type SideNavTab } from '../../model/HelpLayout';
|
|
7
|
+
interface SideNavProps {
|
|
8
|
+
sideNavTabs: SideNavTab[];
|
|
9
|
+
}
|
|
10
|
+
export declare const SideNav: ({ sideNavTabs }: SideNavProps) => JSX.Element;
|
|
11
|
+
export {};
|
package/dist/types/messages.d.ts
CHANGED
|
@@ -8,9 +8,23 @@ export interface HelpPanelHeader {
|
|
|
8
8
|
isBackbuttonVisible?: boolean;
|
|
9
9
|
isAiEnabled?: boolean;
|
|
10
10
|
}
|
|
11
|
+
export interface HeaderContent {
|
|
12
|
+
title: string;
|
|
13
|
+
onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
14
|
+
onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
15
|
+
newChatButtonDisabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
export interface SideNavTab {
|
|
18
|
+
icon: React.ReactNode;
|
|
19
|
+
label: string;
|
|
20
|
+
content: React.ReactNode;
|
|
21
|
+
onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
22
|
+
header: HeaderContent;
|
|
23
|
+
}
|
|
11
24
|
export interface HelpLayout extends HelpPanelHeader {
|
|
12
25
|
isLoading?: boolean;
|
|
13
26
|
footer?: React.ReactNode;
|
|
14
27
|
children?: React.ReactNode;
|
|
15
|
-
|
|
28
|
+
sideNavTabs?: SideNavTab[];
|
|
29
|
+
onLoad?: () => void;
|
|
16
30
|
}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
/**
|
|
3
|
+
* @jsxRuntime classic
|
|
4
|
+
* @jsx jsx
|
|
5
|
+
*/
|
|
6
|
+
import { UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
7
|
+
interface Props {
|
|
8
|
+
onClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
9
|
+
isDisabled?: boolean;
|
|
10
|
+
}
|
|
11
|
+
export declare const NewChatButton: ({ onClick, isDisabled }: Props) => JSX.Element;
|
|
12
|
+
export {};
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
/**
|
|
3
|
+
* @jsxRuntime classic
|
|
4
|
+
* @jsx jsx
|
|
5
|
+
*/
|
|
6
|
+
import { type HeaderContent } from '../../model/HelpLayout';
|
|
7
|
+
export declare const DynamicHeader: ({ title, onCloseButtonClick, onNewChatButtonClick, newChatButtonDisabled, }: HeaderContent) => JSX.Element;
|
|
@@ -3,7 +3,7 @@ import { type WrappedComponentProps } from 'react-intl-next';
|
|
|
3
3
|
import { type UIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
4
4
|
interface Props {
|
|
5
5
|
onClick(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent?: UIAnalyticsEvent): void;
|
|
6
|
-
|
|
6
|
+
inDynamicHeader?: boolean;
|
|
7
7
|
}
|
|
8
8
|
/**
|
|
9
9
|
* This function will return a CloseButton component only if the function
|
|
@@ -7,10 +7,8 @@ import { TransitionStatus } from '../constants';
|
|
|
7
7
|
export declare const HeaderContainer: ({ children }: {
|
|
8
8
|
children: React.ReactNode;
|
|
9
9
|
}) => JSX.Element;
|
|
10
|
-
export declare const CloseButtonContainer: ({ children }: {
|
|
11
|
-
|
|
12
|
-
}) => JSX.Element;
|
|
13
|
-
export declare const CloseButtonContainerAi: ({ children }: {
|
|
10
|
+
export declare const CloseButtonContainer: ({ inDynamicHeader, children, }: {
|
|
11
|
+
inDynamicHeader: boolean;
|
|
14
12
|
children: React.ReactNode;
|
|
15
13
|
}) => JSX.Element;
|
|
16
14
|
export declare const TRANSITION_DURATION_MS = 220;
|
|
@@ -21,9 +19,6 @@ export declare const BackButtonContainer: ({ transitionState, children, }: {
|
|
|
21
19
|
export declare const HeaderTitle: ({ children }: {
|
|
22
20
|
children: React.ReactNode;
|
|
23
21
|
}) => JSX.Element;
|
|
24
|
-
export declare const HeaderTitleAi: ({ children }: {
|
|
25
|
-
children: React.ReactNode;
|
|
26
|
-
}) => JSX.Element;
|
|
27
22
|
export declare const HeaderContent: ({ children }: {
|
|
28
23
|
children: React.ReactNode;
|
|
29
24
|
}) => JSX.Element;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
2
|
+
/**
|
|
3
|
+
* @jsxRuntime classic
|
|
4
|
+
* @jsx jsx
|
|
5
|
+
*/
|
|
6
|
+
import { type SideNavTab } from '../../model/HelpLayout';
|
|
7
|
+
interface SideNavProps {
|
|
8
|
+
sideNavTabs: SideNavTab[];
|
|
9
|
+
}
|
|
10
|
+
export declare const SideNav: ({ sideNavTabs }: SideNavProps) => JSX.Element;
|
|
11
|
+
export {};
|
|
@@ -8,9 +8,23 @@ export interface HelpPanelHeader {
|
|
|
8
8
|
isBackbuttonVisible?: boolean;
|
|
9
9
|
isAiEnabled?: boolean;
|
|
10
10
|
}
|
|
11
|
+
export interface HeaderContent {
|
|
12
|
+
title: string;
|
|
13
|
+
onNewChatButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
14
|
+
onCloseButtonClick?(event: React.MouseEvent<HTMLElement, MouseEvent>, analyticsEvent: UIAnalyticsEvent): void;
|
|
15
|
+
newChatButtonDisabled?: boolean;
|
|
16
|
+
}
|
|
17
|
+
export interface SideNavTab {
|
|
18
|
+
icon: React.ReactNode;
|
|
19
|
+
label: string;
|
|
20
|
+
content: React.ReactNode;
|
|
21
|
+
onClick?: (event: React.MouseEvent<HTMLElement, MouseEvent>) => void;
|
|
22
|
+
header: HeaderContent;
|
|
23
|
+
}
|
|
11
24
|
export interface HelpLayout extends HelpPanelHeader {
|
|
12
25
|
isLoading?: boolean;
|
|
13
26
|
footer?: React.ReactNode;
|
|
14
27
|
children?: React.ReactNode;
|
|
15
|
-
|
|
28
|
+
sideNavTabs?: SideNavTab[];
|
|
29
|
+
onLoad?: () => void;
|
|
16
30
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/help-layout",
|
|
3
|
-
"version": "6.0
|
|
3
|
+
"version": "6.2.0",
|
|
4
4
|
"description": "Layout for the atlaskit/help component.",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -34,7 +34,10 @@
|
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@atlaskit/analytics-next": "^11.0.0",
|
|
36
36
|
"@atlaskit/button": "^23.0.0",
|
|
37
|
+
"@atlaskit/css": "^0.10.0",
|
|
38
|
+
"@atlaskit/heading": "^5.2.0",
|
|
37
39
|
"@atlaskit/icon": "^25.6.0",
|
|
40
|
+
"@atlaskit/primitives": "^14.7.0",
|
|
38
41
|
"@atlaskit/theme": "^18.0.0",
|
|
39
42
|
"@atlaskit/tokens": "^4.8.0",
|
|
40
43
|
"@atlaskit/tooltip": "^20.0.0",
|