@atlaskit/atlassian-navigation 2.6.14 → 2.6.16

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 (63) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/cjs/components/AtlassianNavigation/index.js +3 -3
  3. package/dist/cjs/components/AtlassianNavigation/skeleton.js +3 -3
  4. package/dist/cjs/components/Create/index.js +3 -3
  5. package/dist/cjs/components/PrimaryButton/index.js +1 -1
  6. package/dist/cjs/components/PrimaryDropdownButton/index.js +5 -5
  7. package/dist/cjs/components/PrimaryItemsContainer/index.js +1 -1
  8. package/dist/cjs/components/PrimaryItemsContainerV2/index.js +83 -43
  9. package/dist/cjs/components/ProductHome/custom-product-home.js +1 -1
  10. package/dist/cjs/components/ProductHome/product-home.js +14 -6
  11. package/dist/cjs/components/ProductHome/skeleton.js +3 -3
  12. package/dist/cjs/components/SkeletonCreateButton/index.js +1 -1
  13. package/dist/cjs/components/SkeletonIconButton/index.js +2 -2
  14. package/dist/cjs/version.json +1 -1
  15. package/dist/es2019/components/AtlassianNavigation/index.js +3 -3
  16. package/dist/es2019/components/AtlassianNavigation/skeleton.js +3 -3
  17. package/dist/es2019/components/Create/index.js +5 -5
  18. package/dist/es2019/components/Create/skeleton.js +1 -1
  19. package/dist/es2019/components/PrimaryButton/index.js +1 -1
  20. package/dist/es2019/components/PrimaryDropdownButton/index.js +6 -6
  21. package/dist/es2019/components/PrimaryItemsContainer/index.js +1 -1
  22. package/dist/es2019/components/PrimaryItemsContainerV2/index.js +68 -44
  23. package/dist/es2019/components/ProductHome/custom-product-home.js +6 -6
  24. package/dist/es2019/components/ProductHome/product-home.js +18 -11
  25. package/dist/es2019/components/ProductHome/skeleton.js +7 -7
  26. package/dist/es2019/components/Search/index.js +2 -2
  27. package/dist/es2019/components/Search/skeleton.js +2 -2
  28. package/dist/es2019/components/SkeletonCreateButton/index.js +1 -1
  29. package/dist/es2019/components/SkeletonIconButton/index.js +2 -2
  30. package/dist/es2019/version.json +1 -1
  31. package/dist/esm/components/AtlassianNavigation/index.js +3 -3
  32. package/dist/esm/components/AtlassianNavigation/skeleton.js +3 -3
  33. package/dist/esm/components/Create/index.js +3 -3
  34. package/dist/esm/components/PrimaryButton/index.js +1 -1
  35. package/dist/esm/components/PrimaryDropdownButton/index.js +6 -6
  36. package/dist/esm/components/PrimaryItemsContainer/index.js +1 -1
  37. package/dist/esm/components/PrimaryItemsContainerV2/index.js +85 -45
  38. package/dist/esm/components/ProductHome/custom-product-home.js +1 -1
  39. package/dist/esm/components/ProductHome/product-home.js +14 -6
  40. package/dist/esm/components/ProductHome/skeleton.js +3 -3
  41. package/dist/esm/components/SkeletonCreateButton/index.js +1 -1
  42. package/dist/esm/components/SkeletonIconButton/index.js +2 -2
  43. package/dist/esm/version.json +1 -1
  44. package/dist/types/components/PrimaryItemsContainerV2/index.d.ts +1 -3
  45. package/dist/types-ts4.5/components/PrimaryItemsContainerV2/index.d.ts +1 -3
  46. package/package.json +3 -3
  47. package/tmp/api-report-tmp.d.ts +325 -0
  48. package/__perf__/default.tsx +0 -14
  49. package/docs/01-intro.tsx +0 -46
  50. package/docs/02-atlassian-navigation.tsx +0 -38
  51. package/docs/03-product-home.tsx +0 -73
  52. package/docs/04-app-switcher.tsx +0 -29
  53. package/docs/05-create.tsx +0 -37
  54. package/docs/06-primary-actions.tsx +0 -64
  55. package/docs/07-secondary-actions.tsx +0 -206
  56. package/docs/96-skeleton-buttons.tsx +0 -88
  57. package/docs/97-theming.tsx +0 -45
  58. package/docs/98-overflow-menu.tsx +0 -49
  59. package/docs/99-migrating-from-navigation-next.tsx +0 -52
  60. package/docs/ert/skeleton-create-button.tsx +0 -3
  61. package/docs/ert/skeleton-icon-button.tsx +0 -3
  62. package/docs/ert/skeleton-primary-button.tsx +0 -3
  63. package/docs/ert/skeleton-switcher-button.tsx +0 -3
@@ -1,206 +0,0 @@
1
- import React from 'react';
2
-
3
- import { code, Example, md, Props } from '@atlaskit/docs';
4
-
5
- export default md`
6
- These components should be used for the right actions in [Atlassian-navigation](atlassian-navigation).
7
- They each have a specific prop to slot the component in.
8
- It is up to you to implement the behaviour behind the buttons.
9
-
10
- ## Help
11
-
12
- Used for showing help in your application.
13
- Generally you'll want to compose this with [Popup](/packages/design-system/popup) and [Menu](/packages/design-system/menu).
14
-
15
- ${code`
16
- import { Help } from '@atlaskit/atlassian-navigation';
17
-
18
- <Help onClick={console.log} tooltip="Get help" />;
19
- `}
20
-
21
- ${(
22
- <Example
23
- title="Help button"
24
- Component={require('../examples/help-button').default}
25
- source={require('!!raw-loader!../examples/help-button')}
26
- />
27
- )}
28
-
29
- ### Props
30
-
31
- ${(
32
- <Props
33
- heading=""
34
- props={require('!!extract-react-types-loader!../src/components/Help')}
35
- />
36
- )}
37
-
38
- ## Profile
39
-
40
- Used for showing an authenticated user.
41
- Generally you'll want to compose this with [Popup](/packages/design-system/popup) and [Menu](/packages/design-system/menu).
42
-
43
- You are required to correctly style the avatar image.
44
- You will want to use the \`SignIn\` component if they are not logged in.
45
-
46
- ${code`
47
- import { Profile } from '@atlaskit/atlassian-navigation';
48
-
49
- <Profile
50
- tooltip="Your profile and settings"
51
- onClick={onClick}
52
- icon={
53
- <img
54
- style={{ borderRadius: '50%', width: 24, height: 24 }}
55
- src={avatarUrl}
56
- />
57
- }
58
- />
59
- `}
60
-
61
- ${(
62
- <Example
63
- title="Profile button"
64
- Component={require('../examples/profile').default}
65
- source={require('!!raw-loader!../examples/profile')}
66
- />
67
- )}
68
-
69
- ### Props
70
-
71
- ${(
72
- <Props
73
- heading=""
74
- props={require('!!extract-react-types-loader!../src/components/Profile')}
75
- />
76
- )}
77
-
78
- ## Search
79
-
80
- Used for showing a search textbox,
81
- will display a textbox at large viewports and an icon at small viewports.
82
- You will need to handle hooking up events accordingly.
83
- Search includes its own \`search\` landmark internally for users navigating with screen readers.
84
-
85
- This is made to be composed with [Global search](/packages/search/global-search) or [Quick search](/packages/search/quick-search)
86
-
87
- ### Prop information
88
- Search has three similar required props: \`placeholder\` \`tooltip\` and \`label\`. Each has a different purpose and use cases
89
- and so must be provided separately:
90
- - \`placeholder\` text displays inside the search box before the user has input text
91
- - \`tooltip\` can contain not just text, but any React node – such as a badge for a keyboard shortcut
92
- - \`label\` text is read to users who visit the search field with a screen reader
93
-
94
- ${code`
95
- import { Search } from '@atlaskit/atlassian-navigation';
96
-
97
- <Search onClick={onClick} placeholder="Search..." tooltip="Search" label="Search" />
98
- `}
99
-
100
- ${(
101
- <Example
102
- title="Search"
103
- Component={require('../examples/search').default}
104
- source={require('!!raw-loader!../examples/search')}
105
- />
106
- )}
107
-
108
- ### Props
109
-
110
- ${(
111
- <Props
112
- heading=""
113
- props={require('!!extract-react-types-loader!../src/components/Search')}
114
- />
115
- )}
116
-
117
- ## Settings
118
-
119
- Used for showing a settings button,
120
- Generally you'll want to compose this with [Popup](/packages/design-system/popup) and [Menu](/packages/design-system/menu).
121
-
122
- ${code`
123
- import { Settings } from '@atlaskit/atlassian-navigation';
124
-
125
- <Settings onClick={console.log} tooltip="Product settings" />
126
- `}
127
-
128
- ${(
129
- <Example
130
- title="Settings"
131
- Component={require('../examples/settings').default}
132
- source={require('!!raw-loader!../examples/settings')}
133
- />
134
- )}
135
-
136
- ### Props
137
-
138
- ${(
139
- <Props
140
- heading=""
141
- props={require('!!extract-react-types-loader!../src/components/Settings')}
142
- />
143
- )}
144
-
145
- ## Sign in
146
-
147
- Used for showing a sign in button.
148
- You will want to link to the Atlassian account log in page.
149
- Make sure to only show this when the user is not logged in,
150
- otherwise use the \`Profile\` component.
151
-
152
- ${code`
153
- import { Settings } from '@atlaskit/atlassian-navigation';
154
-
155
- <SignIn href="#" tooltip="Sign in" />
156
- `}
157
-
158
- ${(
159
- <Example
160
- title="Settings"
161
- Component={require('../examples/sign-in').default}
162
- source={require('!!raw-loader!../examples/sign-in')}
163
- />
164
- )}
165
-
166
- ### Props
167
-
168
- ${(
169
- <Props
170
- heading=""
171
- props={require('!!extract-react-types-loader!../src/components/SignIn')}
172
- />
173
- )}
174
-
175
- ## Notifications
176
-
177
- Used for showing Atlassian notifications.
178
- You'll want to compose this with [notification indicator](/packages/notifications/notification-indicator),
179
- [notification log client](/packages/notifications/notification-log-client),
180
- and [Atlassian notifications](/packages/navigation/atlassian-notifications).
181
-
182
- See the examples for patterns regarding clearing the notification badge count.
183
-
184
- ${code`
185
- import { Notifications } from '@atlaskit/atlassian-navigation';
186
-
187
- <Notifications badge={null} tooltip="Notifications" />
188
- `}
189
-
190
- ${(
191
- <Example
192
- title="Notifications"
193
- Component={require('../examples/notifications').default}
194
- source={require('!!raw-loader!../examples/notifications')}
195
- />
196
- )}
197
-
198
- ### Props
199
-
200
- ${(
201
- <Props
202
- heading=""
203
- props={require('!!extract-react-types-loader!../src/components/Notifications')}
204
- />
205
- )}
206
- `;
@@ -1,88 +0,0 @@
1
- import React from 'react';
2
-
3
- import { code, Example, md } from '@atlaskit/docs';
4
-
5
- export default md`
6
- Atlassian navigation exports \`SkeletonCreateButton\`, \`SkeletonPrimaryButton\` and all the skeleton icon buttons is separate entrypoint files. These are **non-interactive** alternates which can be used to speed up the time to render and HTML generation of atlassian navigation in SSR mode. The reason they are fast is because they use a flat HTML structure and a small CSS and they bring in no additional dependencies.
7
-
8
- The skeleton buttons take up the same height and width as the original buttons in order to avoid jank when they are swapped out. They skeletons respect the theme that is passed into atlassian-navigation as the theme prop. They follow the same props API as the original counterparts, so there is no need to wranggle any props when swapping them.
9
-
10
- These components can be used on the server if hydration isn't a concern on the client. Or, they can be used on the client itself if rendering the navigation components take too long to render due for whatever reason.
11
-
12
- ${code`
13
- import React from 'react';
14
- import { JiraIcon, JiraLogo } from '@atlaskit/logo';
15
-
16
- import { AtlassianNavigation, ProductHome } from '../src';
17
- import {
18
- SkeletonCreateButton,
19
- SkeletonIconButton,
20
- SkeletonPrimaryButton,
21
- } from '../src/skeleton';
22
- import { SkeletonSettingsButton } from '../src/skeleton-settings-button';
23
- import { SkeletonNotificationButton } from '../src/skeleton-notification-button';
24
- import { SkeletonHelpButton } from '../src/skeleton-help-button';
25
- import { SkeletonSwitcherButton } from '../src/skeleton-switcher-button';
26
- import { avatarUrl } from './shared/ProfilePopup';
27
-
28
- const SkeletonCreate = () => (
29
- <SkeletonCreateButton text="Create"></SkeletonCreateButton>
30
- );
31
- const SkeletonProfileButton = () => (
32
- <SkeletonIconButton>
33
- <img src={avatarUrl} alt="Your profile and settings" />
34
- </SkeletonIconButton>
35
- );
36
- const skeletonPrimaryItems = [
37
- <SkeletonPrimaryButton>Home</SkeletonPrimaryButton>,
38
- <SkeletonPrimaryButton isDropdownButton text="Projects" />,
39
- <SkeletonPrimaryButton
40
- isDropdownButton
41
- isHighlighted
42
- text="Filters &amp; issues"
43
- />,
44
- <SkeletonPrimaryButton isDropdownButton text="Dashboards" />,
45
- <SkeletonPrimaryButton isDropdownButton text="Apps" />,
46
- ];
47
-
48
- export const AtlassianNaviagtion = () => (
49
- <AtlassianNavigation
50
- label="site"
51
- moreLabel="More"
52
- primaryItems={skeletonPrimaryItems}
53
- renderAppSwitcher={() => <SkeletonSwitcherButton label="switcher button" />}
54
- renderCreate={SkeletonCreate}
55
- renderProductHome={() => (
56
- // Not passing an onClick or href to the product home renders it in a
57
- // non-interactive span with little react overhead.
58
- <ProductHome icon={JiraIcon} logo={JiraLogo} siteTitle="Hello" />
59
- )}
60
- renderProfile={SkeletonProfileButton}
61
- renderSettings={() => <SkeletonSettingsButton label="settings button" />}
62
- renderHelp={() => <SkeletonHelpButton label="help button" />}
63
- renderNotifications={() => (
64
- <SkeletonNotificationButton label="notifications button" />
65
- )}
66
- />
67
- );
68
- `}
69
-
70
- ${(
71
- <Example
72
- title="Skeleton create and icon buttons"
73
- Component={require('../examples/skeleton-primary-buttons').default}
74
- source={require('!!raw-loader!../examples/skeleton-primary-buttons')}
75
- />
76
- )}
77
-
78
-
79
- ${(
80
- <Example
81
- title="Skeleton primary items buttons"
82
- Component={
83
- require('../examples/skeleton-create-and-icon-buttons').default
84
- }
85
- source={require('!!raw-loader!../examples/skeleton-create-and-icon-buttons')}
86
- />
87
- )}
88
- `;
@@ -1,45 +0,0 @@
1
- import React from 'react';
2
-
3
- import { code, Example, md, Props } from '@atlaskit/docs';
4
-
5
- export default md`
6
- Theming is enabled via the \`theme\` prop in the parent [Atlassian navigation](atlassian-navigation) component.
7
-
8
- ${code`
9
- import {
10
- generateTheme,
11
- AtlassianNavigation
12
- } from '@atlaskit/atlassian-navigation';
13
-
14
- const theme = generateTheme({
15
- name: 'high-contrast',
16
- backgroundColor: '#272727',
17
- highlightColor: '#E94E34',
18
- });
19
-
20
- <AtlassianNavigation
21
- theme={theme}
22
- ...
23
- />
24
- `}
25
-
26
- ${(
27
- <Example
28
- title="Themed navigation"
29
- Component={require('../examples/themed-navigation').default}
30
- source={require('!!raw-loader!../examples/themed-navigation')}
31
- />
32
- )}
33
-
34
- ## \`generateTheme({})\`
35
-
36
- Will return a theme function for you to pass into the Atlassian navigation component.
37
- Ensures all colors including text have an accessible contrast.
38
-
39
- ${(
40
- <Props
41
- heading=""
42
- props={require('!!extract-react-types-loader!../src/theme/theme-generator')}
43
- />
44
- )}
45
- `;
@@ -1,49 +0,0 @@
1
- import React from 'react';
2
-
3
- import { code, Example, md, Props } from '@atlaskit/docs';
4
-
5
- export default md`
6
- To support viewports of various sizes the primary navigation items supports being moved into an overflow menu.
7
- Make sure to interact with the overflow menu button in the example below,
8
- notice the items change appearance when they're inside the overflow menu.
9
-
10
- The overflow menu uses [Menu](/packages/design-system/menu) so make sure to use items from that package else you will get undefined behaviour.
11
-
12
- ${code`
13
- import {
14
- PrimaryButton,
15
- PrimaryButtonProps,
16
- useOverflowStatus
17
- } from '@atlaskit/atlassian-navigation';
18
- import { ButtonItem } from '@atlaskit/menu';
19
-
20
- (props: PrimaryButtonProps) => {
21
- const overflowStatus = useOverflowStatus();
22
-
23
- return overflowStatus.isVisible ? (
24
- <PrimaryButton {...props} />
25
- ) : (
26
- <ButtonItem>{props.children}</ButtonItem>
27
- );
28
- };
29
- `}
30
-
31
- ${(
32
- <Example
33
- title="Overflow menu"
34
- Component={require('../examples/overflow-menu').default}
35
- source={require('!!raw-loader!../examples/overflow-menu')}
36
- />
37
- )}
38
-
39
- ## \`useOverflowStatus()\`
40
-
41
- Used to get the current visibility of the navigation item.
42
-
43
- ${(
44
- <Props
45
- heading=""
46
- props={require('!!extract-react-types-loader!../src/controllers/overflow')}
47
- />
48
- )}
49
- `;
@@ -1,52 +0,0 @@
1
- import { code, md } from '@atlaskit/docs';
2
-
3
- export default md`
4
- \`@atlaskit/navigation-next\` was deprecated due to:
5
-
6
- - Large bundle size
7
- - Poor runtime performance
8
- - Lack of flexibility with layout
9
- - Lack of consumer control of how and where to render the page content
10
-
11
- It has been superseded by a composed navigation experience consisting of \`@atlaskit/page-layout\` to layout your application, \`@atlaskit/atlassian-navigation\` for the horizontal nav bar at the top of the screen, and \`@atlaskit/side-navigation\` for the side nav. **All Atlassian products should be using these packages instead — support is no longer provided for** \`@atlaskit/navigation-next\`.
12
-
13
- This page intends to serve as a high level conceptual introduction to these packages. Detailed documentation for each can be found below:
14
-
15
- - [Page layout](https://atlaskit.atlassian.com/packages/design-system/page-layout)
16
- - [Atlassian navigation](https://atlaskit.atlassian.com/packages/navigation/atlassian-navigation)
17
- - [Side navigation](https://atlaskit.atlassian.com/packages/navigation/side-navigation)
18
- - [Worked example of all packages used together](https://atlaskit.atlassian.com/examples/design-system/page-layout/integration-example)
19
-
20
- ## Laying out your application
21
-
22
- Where \`@atlaskit/navigation-next\` used to rely on the rigid and unperformant \`LayoutManager\`, we now have a light-weight and flexible solution in \`@atlaskit/page-layout\` ([docs](https://atlaskit.atlassian.com/packages/design-system/page-layout)). \`@atlaskit/page-layout\` can be used to wrap your entire app and help split the viewport into sections where you can render components in slots such as \`Banner\`, \`TopNavigation\`, \`Main\`, \`LeftSidebar\`, and more. It also provides valuable accessibility improvements to your application with support for [skip links](https://atlaskit.atlassian.com/packages/design-system/page-layout/docs/skip-links).
23
-
24
- ## Standardised top navigation
25
-
26
- The role that used to be played by the deprecated \`@atlaskit/global-navigation\` is now played by \`@atlaskit/atlassian-navigation\` ([docs](https://atlaskit.atlassian.com/packages/navigation/atlassian-navigation)). This provides a well-structured, cohesive and performant navigation experience that is used across all Atlassian products.
27
-
28
- \`@atlaskit/atlassian-navigation\` slots into the \`TopNavigation\` section in \`PageLayout\`.
29
-
30
- If you're still using \`@atlaskit/navigation-next\`, it is also possible to incrementally adopt \`@atlaskit/atlassian-navigation\` by using the \`experimental_horizontalGlobalNav\` prop.
31
-
32
- ${code`
33
- import { LayoutManagerWithViewController } from '@atlaskit/navigation-next';
34
- import { AtlassianNavigation } from '@atlaskit/atlassian-navigation';
35
-
36
- <LayoutManagerWithViewController
37
- - globalNavigation={DefaultGlobalNavigation}
38
- + globalNavigation={AtlassianNavigation}
39
- + experimental_horizontalGlobalNav
40
- />
41
- `}
42
-
43
- However, it is **strongly recommended** that you adopt the full suite of navigation components together as ongoing support for \`@atlaskit/navigation-next\` will not be provided.
44
-
45
- ## Contextual, product-specific navigation
46
-
47
- Previously contextual navigation was handled by passing in content to the \`productNavigation\` prop in \`@atlaskit/navigation-next\`'s \`LayoutManager\`. Now, it belongs in the dedicated \`@atlaskit/side-navigation\` package ([docs](https://atlaskit.atlassian.com/packages/navigation/side-navigation)).
48
-
49
- ## Need help?
50
-
51
- Reach out to !disturbed in #help-design-system.
52
- `;
@@ -1,3 +0,0 @@
1
- import { SkeletonCreateButtonProps } from '../../src/components/SkeletonCreateButton/types';
2
-
3
- export default (props: SkeletonCreateButtonProps) => null;
@@ -1,3 +0,0 @@
1
- import { SkeletonIconButtonProps } from '../../src/components/SkeletonIconButton/types';
2
-
3
- export default (props: SkeletonIconButtonProps) => null;
@@ -1,3 +0,0 @@
1
- import { SkeletonPrimaryButtonProps } from '../../src/components/SkeletonPrimaryButton/types';
2
-
3
- export default (props: SkeletonPrimaryButtonProps) => null;
@@ -1,3 +0,0 @@
1
- import { SkeletonSwitcherButtonProps } from '../../src/skeleton-switcher-button';
2
-
3
- export default (props: SkeletonSwitcherButtonProps) => null;