@atlaskit/atlassian-navigation 2.2.10 → 2.3.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.
Files changed (104) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/dist/cjs/common/styles.js +2 -16
  3. package/dist/cjs/components/AtlassianNavigation/index.js +11 -11
  4. package/dist/cjs/components/AtlassianNavigation/skeleton.js +14 -14
  5. package/dist/cjs/components/BadgeContainer/index.js +6 -6
  6. package/dist/cjs/components/Create/index.js +9 -9
  7. package/dist/cjs/components/Create/skeleton.js +5 -5
  8. package/dist/cjs/components/IconButton/skeleton.js +3 -3
  9. package/dist/cjs/components/PrimaryButton/index.js +6 -6
  10. package/dist/cjs/components/PrimaryButton/skeleton.js +3 -3
  11. package/dist/cjs/components/PrimaryDropdownButton/index.js +5 -5
  12. package/dist/cjs/components/PrimaryItemsContainer/index.js +10 -10
  13. package/dist/cjs/components/PrimaryItemsContainer/skeleton.js +4 -4
  14. package/dist/cjs/components/ProductHome/custom-product-home.js +10 -10
  15. package/dist/cjs/components/ProductHome/product-home.js +12 -12
  16. package/dist/cjs/components/ProductHome/skeleton.js +9 -9
  17. package/dist/cjs/components/Search/index.js +13 -12
  18. package/dist/cjs/components/Search/skeleton.js +7 -7
  19. package/dist/cjs/components/SkeletonCreateButton/index.js +3 -3
  20. package/dist/cjs/components/SkeletonIconButton/index.js +3 -3
  21. package/dist/cjs/components/SkeletonPrimaryButton/index.js +7 -7
  22. package/dist/cjs/version.json +1 -1
  23. package/dist/es2019/common/styles.js +1 -10
  24. package/dist/es2019/components/AtlassianNavigation/index.js +1 -1
  25. package/dist/es2019/components/AtlassianNavigation/skeleton.js +1 -1
  26. package/dist/es2019/components/BadgeContainer/index.js +1 -1
  27. package/dist/es2019/components/Create/index.js +1 -1
  28. package/dist/es2019/components/Create/skeleton.js +1 -1
  29. package/dist/es2019/components/IconButton/skeleton.js +1 -1
  30. package/dist/es2019/components/PrimaryButton/index.js +1 -1
  31. package/dist/es2019/components/PrimaryButton/skeleton.js +1 -1
  32. package/dist/es2019/components/PrimaryDropdownButton/index.js +1 -1
  33. package/dist/es2019/components/PrimaryItemsContainer/index.js +1 -1
  34. package/dist/es2019/components/PrimaryItemsContainer/skeleton.js +1 -1
  35. package/dist/es2019/components/ProductHome/custom-product-home.js +1 -1
  36. package/dist/es2019/components/ProductHome/product-home.js +1 -1
  37. package/dist/es2019/components/ProductHome/skeleton.js +1 -1
  38. package/dist/es2019/components/Search/index.js +3 -2
  39. package/dist/es2019/components/Search/skeleton.js +1 -1
  40. package/dist/es2019/components/SkeletonCreateButton/index.js +1 -1
  41. package/dist/es2019/components/SkeletonIconButton/index.js +1 -1
  42. package/dist/es2019/components/SkeletonPrimaryButton/index.js +1 -1
  43. package/dist/es2019/version.json +1 -1
  44. package/dist/esm/common/styles.js +1 -13
  45. package/dist/esm/components/AtlassianNavigation/index.js +1 -1
  46. package/dist/esm/components/AtlassianNavigation/skeleton.js +1 -1
  47. package/dist/esm/components/BadgeContainer/index.js +1 -1
  48. package/dist/esm/components/Create/index.js +1 -1
  49. package/dist/esm/components/Create/skeleton.js +1 -1
  50. package/dist/esm/components/IconButton/skeleton.js +1 -1
  51. package/dist/esm/components/PrimaryButton/index.js +1 -1
  52. package/dist/esm/components/PrimaryButton/skeleton.js +1 -1
  53. package/dist/esm/components/PrimaryDropdownButton/index.js +1 -1
  54. package/dist/esm/components/PrimaryItemsContainer/index.js +1 -1
  55. package/dist/esm/components/PrimaryItemsContainer/skeleton.js +1 -1
  56. package/dist/esm/components/ProductHome/custom-product-home.js +1 -1
  57. package/dist/esm/components/ProductHome/product-home.js +1 -1
  58. package/dist/esm/components/ProductHome/skeleton.js +1 -1
  59. package/dist/esm/components/Search/index.js +3 -2
  60. package/dist/esm/components/Search/skeleton.js +1 -1
  61. package/dist/esm/components/SkeletonCreateButton/index.js +1 -1
  62. package/dist/esm/components/SkeletonIconButton/index.js +1 -1
  63. package/dist/esm/components/SkeletonPrimaryButton/index.js +1 -1
  64. package/dist/esm/version.json +1 -1
  65. package/dist/types/common/styles.d.ts +0 -914
  66. package/dist/types/components/AtlassianNavigation/index.d.ts +3 -2
  67. package/dist/types/components/AtlassianNavigation/skeleton.d.ts +3 -2
  68. package/dist/types/components/BadgeContainer/index.d.ts +3 -2
  69. package/dist/types/components/Create/index.d.ts +2 -2
  70. package/dist/types/components/Create/skeleton.d.ts +2 -2
  71. package/dist/types/components/IconButton/skeleton.d.ts +3 -2
  72. package/dist/types/components/PrimaryButton/skeleton.d.ts +2 -2
  73. package/dist/types/components/PrimaryItemsContainer/index.d.ts +2 -2
  74. package/dist/types/components/PrimaryItemsContainer/skeleton.d.ts +2 -2
  75. package/dist/types/components/ProductHome/custom-product-home.d.ts +2 -2
  76. package/dist/types/components/ProductHome/product-home.d.ts +2 -2
  77. package/dist/types/components/ProductHome/skeleton.d.ts +2 -2
  78. package/dist/types/components/Search/index.d.ts +2 -2
  79. package/dist/types/components/Search/skeleton.d.ts +2 -2
  80. package/dist/types/components/SkeletonCreateButton/index.d.ts +3 -2
  81. package/dist/types/components/SkeletonIconButton/index.d.ts +3 -2
  82. package/dist/types/components/SkeletonPrimaryButton/index.d.ts +3 -2
  83. package/dist/types/theme/types.d.ts +1 -1
  84. package/dist/types-ts4.0/common/styles.d.ts +0 -914
  85. package/dist/types-ts4.0/components/AtlassianNavigation/index.d.ts +3 -2
  86. package/dist/types-ts4.0/components/AtlassianNavigation/skeleton.d.ts +3 -2
  87. package/dist/types-ts4.0/components/BadgeContainer/index.d.ts +3 -2
  88. package/dist/types-ts4.0/components/Create/index.d.ts +2 -2
  89. package/dist/types-ts4.0/components/Create/skeleton.d.ts +2 -2
  90. package/dist/types-ts4.0/components/IconButton/skeleton.d.ts +3 -2
  91. package/dist/types-ts4.0/components/PrimaryButton/skeleton.d.ts +2 -2
  92. package/dist/types-ts4.0/components/PrimaryItemsContainer/index.d.ts +2 -2
  93. package/dist/types-ts4.0/components/PrimaryItemsContainer/skeleton.d.ts +2 -2
  94. package/dist/types-ts4.0/components/ProductHome/custom-product-home.d.ts +2 -2
  95. package/dist/types-ts4.0/components/ProductHome/product-home.d.ts +2 -2
  96. package/dist/types-ts4.0/components/ProductHome/skeleton.d.ts +2 -2
  97. package/dist/types-ts4.0/components/Search/index.d.ts +2 -2
  98. package/dist/types-ts4.0/components/Search/skeleton.d.ts +2 -2
  99. package/dist/types-ts4.0/components/SkeletonCreateButton/index.d.ts +3 -2
  100. package/dist/types-ts4.0/components/SkeletonIconButton/index.d.ts +3 -2
  101. package/dist/types-ts4.0/components/SkeletonPrimaryButton/index.d.ts +3 -2
  102. package/dist/types-ts4.0/theme/types.d.ts +1 -1
  103. package/package.json +3 -3
  104. package/report.api.md +136 -513
package/report.api.md CHANGED
@@ -1,20 +1,25 @@
1
- ## API Report File for "@atlaskit/atlassian-navigation".
1
+ ## API Report File for "@atlaskit/atlassian-navigation"
2
2
 
3
- > Do not edit this file. This report is auto-generated by [API Extractor](https://api-extractor.com/).
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ <!--
6
+ Generated API Report version: 2.0
7
+ -->
4
8
 
5
9
  [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
6
10
 
7
- ````ts
11
+ ```ts
8
12
  /// <reference types="lodash" />
9
13
  /// <reference types="react" />
10
14
 
11
15
  import { AllHTMLAttributes } from 'react';
12
16
  import { ComponentType } from 'react';
13
- import { CSSObject } from '@emotion/core';
17
+ import { CSSObject } from '@emotion/react';
14
18
  import { CustomThemeButtonProps } from '@atlaskit/button/types';
15
19
  import { CustomThemeButtonProps as CustomThemeButtonProps_2 } from '@atlaskit/button/custom-theme-button';
16
20
  import { ElementType } from 'react';
17
21
  import { ForwardRefExoticComponent } from 'react';
22
+ import { jsx } from '@emotion/react';
18
23
  import { LogoProps } from '@atlaskit/logo';
19
24
  import { MouseEvent as MouseEvent_2 } from 'react';
20
25
  import noop from '@atlaskit/ds-lib/noop';
@@ -29,391 +34,162 @@ import { ThemeProps as ThemeProps_2 } from '@atlaskit/button';
29
34
  import { ThemeTokens } from '@atlaskit/button/custom-theme-button';
30
35
  import { ThemeTokens as ThemeTokens_2 } from '@atlaskit/button';
31
36
 
32
- /**
33
- * _App switcher__
34
- *
35
- * An AppSwitcher button that can be passed into `AtlassianNavigation`'s
36
- * `renderAppSwitcher` prop.
37
- *
38
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#app-switcher)
39
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
40
- */
41
- export declare const AppSwitcher: React_2.ForwardRefExoticComponent<
37
+ // @public
38
+ export const AppSwitcher: React_2.ForwardRefExoticComponent<
42
39
  BaseIconButtonProps & React_2.RefAttributes<any>
43
40
  >;
44
41
 
45
- export declare type AppSwitcherProps = BaseIconButtonProps;
46
-
47
- /**
48
- * __Atlassian navigation__
49
- *
50
- * The horizontal navigation component for Atlassian products.
51
- *
52
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples)
53
- * - [Code](https://atlassian.design/components/atlassian-navigation/examples)
54
- */
55
- export declare const AtlassianNavigation: (
42
+ // @public (undocumented)
43
+ export type AppSwitcherProps = BaseIconButtonProps;
44
+
45
+ // @public
46
+ export const AtlassianNavigation: (
56
47
  props: AtlassianNavigationProps,
57
- ) => JSX.Element;
48
+ ) => jsx.JSX.Element;
58
49
 
59
- export declare interface AtlassianNavigationProps {
60
- /**
61
- * Describes the specific role of this navigation component for users viewing the page with a screen
62
- * reader. Differentiates from other navigation components on a page.
63
- */
50
+ // @public (undocumented)
51
+ export interface AtlassianNavigationProps {
64
52
  label: string;
65
- /**
66
- * Slot for the primary actions.
67
- */
53
+ moreLabel?: ReactNode;
68
54
  primaryItems: ReactNodeArray;
69
- /**
70
- * Slot for the app switcher.
71
- */
72
55
  renderAppSwitcher?: React_2.ComponentType<{}>;
73
- /**
74
- * Slot for the create call to action button.
75
- */
76
56
  renderCreate?: React_2.ComponentType<{}>;
77
- /**
78
- * Slot for the help button.
79
- */
80
57
  renderHelp?: React_2.ComponentType<{}>;
81
- /**
82
- * Slot for the notification button.
83
- */
84
58
  renderNotifications?: React_2.ComponentType<{}>;
85
- /**
86
- * Slot for the product home logo which renders a product's brand.
87
- */
88
59
  renderProductHome: React_2.ComponentType<{}>;
89
- /**
90
- * Slot for the profile button.
91
- */
92
60
  renderProfile?: React_2.ComponentType<{}>;
93
- /**
94
- * Slot for the search textbox.
95
- */
96
61
  renderSearch?: React_2.ComponentType<{}>;
97
- /**
98
- * Slot for the sign in button.
99
- */
100
- renderSignIn?: React_2.ComponentType<{}>;
101
- /**
102
- * Slot for the settings button.
103
- */
104
62
  renderSettings?: React_2.ComponentType<{}>;
105
- /**
106
- * Label used for the overflow menu button tooltip.
107
- */
108
- moreLabel?: ReactNode;
109
- /**
110
- * __Slow and discouraged custom theme API.__
111
- */
112
- theme?: NavigationTheme;
113
- /**
114
- A `testId` prop is provided for specified elements,
115
- which is a unique string that appears as a data attribute `data-testid` in the rendered code,
116
- serving as a hook for automated tests.
117
-
118
- Will set these elements when defined:
119
-
120
- - Header element - `{testId}-header`
121
- - Primary actions container - `{testId}-primary-actions`
122
- - Secondary actions container - `{testId}-secondary-actions`
123
- - Overflow menu popup - `{testId}-overflow-menu-popup`
124
- - Overflow menu button - `{testId}-overflow-menu-trigger`
125
- */
63
+ renderSignIn?: React_2.ComponentType<{}>;
126
64
  testId?: string;
65
+ theme?: NavigationTheme;
127
66
  }
128
67
 
129
- export declare const atlassianTheme: NavigationTheme;
68
+ // @public (undocumented)
69
+ export const atlassianTheme: NavigationTheme;
130
70
 
131
- /**
132
- * We aren't inheriting the types from button here because it blows up ERT.
133
- */
134
- declare interface BaseIconButtonProps {
135
- /**
136
- * Unique id for the button.
137
- */
71
+ // @public
72
+ interface BaseIconButtonProps {
73
+ component?: CustomThemeButtonProps['component'];
74
+ href?: string;
138
75
  id?: string;
139
- /**
140
- * On click handler.
141
- * Second argument is the instrumented analytics event.
142
- * See @atlaskit/analytics-next for analyticsEvent type information
143
- */
76
+ isDisabled?: boolean;
77
+ isSelected?: boolean;
78
+ onBlur?: React.FocusEventHandler<HTMLElement>;
144
79
  onClick?: (event: React.MouseEvent<HTMLElement>, analyticsEvent: any) => void;
145
- /**
146
- * A `testId` prop is provided for specified elements,
147
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
148
- * serving as a hook for automated tests
149
- */
150
- testId?: string;
151
- /**
152
- * Text that will be displayed in the tooltip when hovered or focused on the button.
153
- */
154
- tooltip: React.ReactNode;
155
- /**
156
- * Called when the mouse is initially clicked on the element.
157
- */
80
+ onFocus?: React.FocusEventHandler<HTMLElement>;
158
81
  onMouseDown?: React.MouseEventHandler<HTMLElement>;
159
- /**
160
- * Called when the mouse enters the element container.
161
- */
162
82
  onMouseEnter?: React.MouseEventHandler<HTMLElement>;
163
- /**
164
- * Called when the mouse leaves the element container.
165
- */
166
83
  onMouseLeave?: React.MouseEventHandler<HTMLElement>;
167
- /**
168
- * Causes the button to be disabled.
169
- */
170
- isDisabled?: boolean;
171
- /**
172
- * If wanting to link to another page you can define the href.
173
- */
174
- href?: string;
175
- /**
176
- * If defining `href` you may want to define `target` as well.
177
- */
178
- target?: string;
179
- /**
180
- * Allows for overriding the component used to render the button.
181
- *
182
- * This is primarily intended for compatibility with custom
183
- * routing libraries when using the `href` prop.
184
- *
185
- * For further usage information, refer to the [documentation for button](https://atlassian.design/components/button/code).
186
- *
187
- * @example
188
- * ```tsx
189
- * <Settings
190
- * component={CustomRouterLink}
191
- * href="/path/to/url"
192
- * />
193
- * ```
194
- */
195
- component?: CustomThemeButtonProps['component'];
196
- /**
197
- * Handler for the mouse up event.
198
- */
199
84
  onMouseUp?: React.MouseEventHandler<HTMLElement>;
200
- /**
201
- * Handler called when the button gains focus.
202
- */
203
- onFocus?: React.FocusEventHandler<HTMLElement>;
204
- /**
205
- * Handler called when the button loses focus.
206
- */
207
- onBlur?: React.FocusEventHandler<HTMLElement>;
208
- /**
209
- * Makes the element appear selected.
210
- */
211
- isSelected?: boolean;
85
+ target?: string;
86
+ testId?: string;
87
+ tooltip: React.ReactNode;
212
88
  }
213
89
 
214
- declare type ButtonCSSContext = {
90
+ // @public (undocumented)
91
+ type ButtonCSSContext = {
215
92
  default: ButtonCSSProperties;
216
93
  hover: ButtonCSSProperties;
217
94
  focus: ButtonFocusCSSProperties;
218
95
  active: ButtonCSSProperties;
219
96
  selected: ButtonCSSProperties;
97
+ selectedHover?: ButtonCSSProperties;
220
98
  };
221
99
 
222
- declare type ButtonCSSProperties = CSSProperties & {
100
+ // @public (undocumented)
101
+ type ButtonCSSProperties = CSSProperties & {
223
102
  boxShadow: string;
224
103
  };
225
104
 
226
- declare type ButtonFocusCSSProperties = {
105
+ // @public (undocumented)
106
+ type ButtonFocusCSSProperties = {
227
107
  boxShadow: string;
228
108
  color: string;
229
109
  backgroundColor: string;
230
110
  };
231
111
 
232
- export declare type Colors = {
112
+ // @public (undocumented)
113
+ export type Colors = {
233
114
  backgroundColor: string;
234
115
  color: string;
235
116
  };
236
117
 
237
- /**
238
- * _Create__
239
- *
240
- * A call to action button that can be passed into `AtlassianNavigation`'s
241
- * `renderCreate` prop. It is shown after all other primary buttons.
242
- *
243
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#create)
244
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
245
- */
246
- export declare const Create: ({
118
+ // @public
119
+ export const Create: ({
247
120
  onClick,
248
121
  href,
249
122
  text,
250
123
  buttonTooltip,
251
124
  iconButtonTooltip,
252
125
  testId,
253
- }: CreateProps) => JSX.Element;
126
+ }: CreateProps) => jsx.JSX.Element;
254
127
 
255
- export declare type CreateCSS = ButtonCSSContext;
128
+ // @public (undocumented)
129
+ export type CreateCSS = ButtonCSSContext;
256
130
 
257
- export declare interface CreateProps {
258
- /**
259
- * Primary text for the call to action.
260
- */
261
- text: string;
262
- /**
263
- * Text for the button tooltip when seen on large viewports.
264
- */
131
+ // @public (undocumented)
132
+ export interface CreateProps {
265
133
  buttonTooltip?: React_2.ReactNode;
266
- /**
267
- * Text for the icon button tooltip when seen on small viewports.
268
- */
134
+ href?: string;
269
135
  iconButtonTooltip?: React_2.ReactNode;
270
- /**
271
- * Click handler.
272
- * See @atlaskit/analytics-next for analyticsEvent type information
273
- */
274
136
  onClick?: (e: React_2.MouseEvent<HTMLElement>, analyticsEvent: any) => void;
275
- /**
276
- * Causes the Create action to be rendered as a link. This is suitable for when the Create action is handled as a full page rather than in a modal-dialog.
277
- */
278
- href?: string;
279
- /**
280
- * A `testId` prop is provided for specified elements,
281
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
282
- * serving as a hook for automated tests.
283
- *
284
- * Will set these elements when defined:
285
- *
286
- * - Create button shown on large screen sizes - `{testId}-button`
287
- * - Create icon button shown on small screen sizes - `{testId}-icon-button`
288
- */
289
137
  testId?: string;
138
+ text: string;
290
139
  }
291
140
 
292
- declare type CSSProperties = CSSObject & {
141
+ // @public (undocumented)
142
+ type CSSProperties = CSSObject & {
293
143
  backgroundColor: string;
294
144
  color: string;
295
145
  };
296
146
 
297
- /**
298
- * __Custom product home__
299
- *
300
- * Use `CustomProductHome` to provide a custom logo and icon with URLs.
301
- *
302
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#custom-product-home)
303
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
304
- */
305
- export declare const CustomProductHome: (
147
+ // @public
148
+ export const CustomProductHome: (
306
149
  props: CustomProductHomeProps,
307
- ) => JSX.Element;
150
+ ) => jsx.JSX.Element;
308
151
 
309
- export declare interface CustomProductHomeProps {
310
- /**
311
- * Alt text for the icon that is displayed on small viewports.
312
- */
152
+ // @public (undocumented)
153
+ export interface CustomProductHomeProps {
154
+ href?: string;
313
155
  iconAlt: string;
314
- /**
315
- * Url for the icon that is displayed on small viewports.
316
- */
317
156
  iconUrl: string;
318
- /**
319
- * Alt text for the icon that is displayed on large viewports.
320
- */
321
157
  logoAlt: string;
322
- /**
323
- * Url for the icon that is displayed on large viewports.
324
- */
325
- logoUrl: string;
326
- /**
327
- * Maximum width of the logo, in pixels. Defaults to 260px.
328
- */
329
158
  logoMaxWidth?: number;
330
- /**
331
- * Optional onClick handler.
332
- */
159
+ logoUrl: string;
333
160
  onClick?: (event: MouseEvent_2<HTMLElement>) => void;
334
- /**
335
- * Optional mouseDown handler.
336
- */
337
161
  onMouseDown?: (event: MouseEvent_2<HTMLElement>) => void;
338
- /**
339
- * Href to be passed to product home.
340
- * Will add an interactive look and feel when defined.
341
- */
342
- href?: string;
343
- /**
344
- * Name of the site that appears next to the logo
345
- */
346
162
  siteTitle?: string;
347
- /**
348
- A `testId` prop is provided for specified elements,
349
- which is a unique string that appears as a data attribute `data-testid` in the rendered code,
350
- serving as a hook for automated tests.
351
-
352
- Will set these elements when defined:
353
-
354
- - Root element of the component - `{testId}-container`
355
- - Product logo shown at large screen sizes - `{testId}-logo`
356
- - Product icon shown at small screen sizes - `{testId}-icon`
357
- - Site title - `{testId}-site-title`
358
- */
359
163
  testId?: string;
360
164
  }
361
165
 
362
- export declare const generateTheme: (
363
- themeColors: GenerateThemeArgs,
364
- ) => NavigationTheme;
166
+ // @public (undocumented)
167
+ export const generateTheme: (themeColors: GenerateThemeArgs) => NavigationTheme;
365
168
 
366
- export declare type GenerateThemeArgs = {
367
- /**
368
- * Name of the theme.
369
- * If you pass in "atlassian" will return the default atlassian theme and not
370
- * use any of the colors you pass in.
371
- */
169
+ // @public (undocumented)
170
+ export type GenerateThemeArgs = {
372
171
  name?: string;
373
- /**
374
- * Main background color of the horizontal navigation bar.
375
- */
376
172
  backgroundColor: string;
377
- /**
378
- * Highlight color for the navigation actions.
379
- */
380
173
  highlightColor: string;
381
174
  };
382
175
 
383
- /**
384
- * __Help__
385
- *
386
- * A help button that can be passed into `AtlassianNavigation`'s `renderHelp` prop.
387
- *
388
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#help)
389
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
390
- */
391
- export declare const Help: React_2.ForwardRefExoticComponent<
176
+ // @public
177
+ export const Help: React_2.ForwardRefExoticComponent<
392
178
  BaseIconButtonProps & {
393
179
  badge?: React_2.ComponentType<{}> | undefined;
394
180
  } & React_2.RefAttributes<any>
395
181
  >;
396
182
 
397
- export declare type HelpProps = BaseIconButtonProps & {
398
- /**
399
- * Component to be used for the badge.
400
- * Generally you'll want to use `NotificationIndicator` from [`@atlaskit/notification-indicator`](/packages/notifications/notification-indicator).
401
- */
183
+ // @public (undocumented)
184
+ export type HelpProps = BaseIconButtonProps & {
402
185
  badge?: ComponentType<{}>;
403
186
  };
404
187
 
405
- export declare const HORIZONTAL_GLOBAL_NAV_HEIGHT = 56;
406
-
407
- /**
408
- * __Icon button__
409
- *
410
- * An icon button is used to create navigation items such as Help, Settings
411
- * and Notifications. You can use this component to create your own items to
412
- * pass into `AtlassianNavigation`'s render props, but where possible you should
413
- * rely on the defaults.
414
- *
415
- */
416
- export declare const IconButton: React_2.ForwardRefExoticComponent<
188
+ // @public (undocumented)
189
+ export const HORIZONTAL_GLOBAL_NAV_HEIGHT = 56;
190
+
191
+ // @public
192
+ export const IconButton: React_2.ForwardRefExoticComponent<
417
193
  BaseIconButtonProps & {
418
194
  icon: React_2.ReactChild | undefined;
419
195
  theme?:
@@ -425,27 +201,25 @@ export declare const IconButton: React_2.ForwardRefExoticComponent<
425
201
  } & React_2.RefAttributes<HTMLElement>
426
202
  >;
427
203
 
428
- export declare type IconButtonCSS = ButtonCSSContext;
204
+ // @public (undocumented)
205
+ export type IconButtonCSS = ButtonCSSContext;
429
206
 
430
- export declare type IconButtonProps = BaseIconButtonProps & {
431
- /**
432
- * Icon for the button.
433
- */
207
+ // @public (undocumented)
208
+ export type IconButtonProps = BaseIconButtonProps & {
434
209
  icon: CustomThemeButtonProps['iconBefore'];
435
- /**
436
- * Theme for the icon button.
437
- */
438
210
  theme?: CustomThemeButtonProps['theme'];
439
211
  };
440
212
 
441
- declare type LogoStyleProps = {
213
+ // @public (undocumented)
214
+ type LogoStyleProps = {
442
215
  iconGradientStart?: string;
443
216
  iconGradientStop?: string;
444
217
  iconColor?: string;
445
218
  textColor?: string;
446
219
  };
447
220
 
448
- export declare type Mode = {
221
+ // @public (undocumented)
222
+ export type Mode = {
449
223
  create: CreateCSS;
450
224
  iconButton: IconButtonCSS;
451
225
  navigation: NavigationCSS;
@@ -455,45 +229,28 @@ export declare type Mode = {
455
229
  skeleton: SkeletonCSS;
456
230
  };
457
231
 
458
- export declare type NavigationCSS = CSSProperties;
232
+ // @public (undocumented)
233
+ export type NavigationCSS = CSSProperties;
459
234
 
460
- export declare type NavigationTheme = {
235
+ // @public (undocumented)
236
+ export type NavigationTheme = {
461
237
  mode: Mode;
462
238
  };
463
239
 
464
- /**
465
- * __Notifications__
466
- *
467
- * A notifications button that can be passed into `AtlassianNavigation`'s
468
- * `renderNotifications` prop.
469
- *
470
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#notifications)
471
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
472
- */
473
- export declare const Notifications: React_2.ForwardRefExoticComponent<
240
+ // @public
241
+ export const Notifications: React_2.ForwardRefExoticComponent<
474
242
  BaseIconButtonProps & {
475
243
  badge: React_2.ComponentType<{}>;
476
244
  } & React_2.RefAttributes<any>
477
245
  >;
478
246
 
479
- export declare type NotificationsProps = BaseIconButtonProps & {
480
- /**
481
- * Component to be used for the badge.
482
- * Generally you'll want to use `NotificationIndicator` from [`@atlaskit/notification-indicator`](/packages/notifications/notification-indicator).
483
- */
247
+ // @public (undocumented)
248
+ export type NotificationsProps = BaseIconButtonProps & {
484
249
  badge: ComponentType<{}>;
485
250
  };
486
251
 
487
- /**
488
- * __Primary button__
489
- *
490
- * A primary button allows you to add top-level navigation items.
491
- * Should be passed into `AtlassianNavigation`'s `primaryItems` prop.
492
- *
493
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#dropdown-menu)
494
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
495
- */
496
- export declare const PrimaryButton: ForwardRefExoticComponent<
252
+ // @public
253
+ export const PrimaryButton: ForwardRefExoticComponent<
497
254
  Omit<CustomThemeButtonProps_2, 'appearance' | 'onClick'> & {
498
255
  component?:
499
256
  | ComponentType<AllHTMLAttributes<HTMLElement>>
@@ -511,60 +268,23 @@ export declare const PrimaryButton: ForwardRefExoticComponent<
511
268
  } & RefAttributes<HTMLElement>
512
269
  >;
513
270
 
514
- export declare type PrimaryButtonCSS = ButtonCSSContext;
271
+ // @public (undocumented)
272
+ export type PrimaryButtonCSS = ButtonCSSContext;
515
273
 
516
- export declare type PrimaryButtonProps = Omit<
274
+ // @public (undocumented)
275
+ export type PrimaryButtonProps = Omit<
517
276
  CustomThemeButtonProps,
518
277
  'appearance' | 'onClick'
519
278
  > & {
520
- /**
521
- * Allows for overriding the component used to render the button.
522
- *
523
- * This is primarily intended for compatibility with custom
524
- * routing libraries when using the `href` prop.
525
- *
526
- * For further usage information, refer to the [documentation for button](https://atlassian.design/components/button/code).
527
- *
528
- * @example
529
- * ```tsx
530
- * <Settings
531
- * component={CustomRouterLink}
532
- * href="/path/to/url"
533
- * />
534
- *```
535
- */
536
279
  component?: ComponentType<AllHTMLAttributes<HTMLElement>> | ElementType<any>;
537
- /**
538
- * Will set the appearance of the button to look highlighted.
539
- */
540
280
  isHighlighted?: boolean;
541
- /**
542
- * A `testId` prop is provided for specified elements,
543
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
544
- * serving as a hook for automated tests
545
- */
546
281
  testId?: string;
547
- /**
548
- * Optional text to show when the button is focused or hovered.
549
- */
550
282
  tooltip?: React.ReactNode;
551
- /**
552
- * On click handler.
553
- * See @atlaskit/analytics-next for analyticsEvent type information
554
- */
555
283
  onClick?: (event: React.MouseEvent<HTMLElement>, analyticsEvent: any) => void;
556
284
  };
557
285
 
558
- /**
559
- * __Primary dropdown button__
560
- *
561
- * A primary dropdown button allows you to add dropdown menus to the navigation.
562
- * Should be passed into `AtlassianNavigation`'s `primaryItems` prop.
563
- *
564
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#button)
565
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
566
- */
567
- export declare const PrimaryDropdownButton: ForwardRefExoticComponent<
286
+ // @public
287
+ export const PrimaryDropdownButton: ForwardRefExoticComponent<
568
288
  Omit<PrimaryButtonProps, 'iconAfter'> & {
569
289
  isHighlighted?: boolean | undefined;
570
290
  testId?: string | undefined;
@@ -572,38 +292,18 @@ export declare const PrimaryDropdownButton: ForwardRefExoticComponent<
572
292
  } & RefAttributes<HTMLElement>
573
293
  >;
574
294
 
575
- export declare type PrimaryDropdownButtonProps = Omit<
295
+ // @public (undocumented)
296
+ export type PrimaryDropdownButtonProps = Omit<
576
297
  PrimaryButtonProps,
577
298
  'iconAfter'
578
299
  > & {
579
- /**
580
- * Will set the appearance of the button to look highlighted.
581
- */
582
300
  isHighlighted?: boolean;
583
- /**
584
- * A `testId` prop is provided for specified elements,
585
- * which is a unique string that appears as a data attribute `data-testid` in the rendered code,
586
- * serving as a hook for automated tests
587
- */
588
301
  testId?: string;
589
- /**
590
- * Optional text to show when the button is focused or hovered.
591
- */
592
302
  tooltip?: React.ReactNode;
593
303
  };
594
304
 
595
- /**
596
- * __Product home__
597
- *
598
- * The ProductHome component displays the product visual identity composed of:
599
- * logo, icon, and optional text. Values for logo and icon are never displayed
600
- * at the same time, where icon is used only when space is restricted. Should be
601
- * passed into `AtlassianNavigation`'s `renderProductHome` prop.
602
- *
603
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#product-home)
604
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
605
- */
606
- export declare const ProductHome: ({
305
+ // @public
306
+ export const ProductHome: ({
607
307
  icon: Icon,
608
308
  logo: Logo,
609
309
  siteTitle,
@@ -613,67 +313,25 @@ export declare const ProductHome: ({
613
313
  testId,
614
314
  logoMaxWidth,
615
315
  ...rest
616
- }: ProductHomeProps) => JSX.Element;
316
+ }: ProductHomeProps) => jsx.JSX.Element;
617
317
 
618
- declare type ProductHomeCSS = CSSProperties & LogoStyleProps;
318
+ // @public (undocumented)
319
+ type ProductHomeCSS = CSSProperties & LogoStyleProps;
619
320
 
620
- export declare interface ProductHomeProps {
621
- /**
622
- * The product icon.
623
- * Expected to be an Icon from the Atlaskit Logo package. Visible on smaller screen sizes
624
- */
321
+ // @public (undocumented)
322
+ export interface ProductHomeProps {
323
+ href?: string;
625
324
  icon: ComponentType<Partial<LogoProps>>;
626
- /**
627
- * The product logo,
628
- * visible on larger screen sizes
629
- */
630
325
  logo: ComponentType<Partial<LogoProps>>;
631
- /**
632
- * Maximum width in pixel, that logo can acquire. Defaults to 260px.
633
- */
634
326
  logoMaxWidth?: number;
635
- /**
636
- * Optional onClick handler.
637
- */
638
327
  onClick?: (event: MouseEvent_2<HTMLElement>) => void;
639
- /**
640
- * Optional mouseDown handler.
641
- */
642
328
  onMouseDown?: (event: MouseEvent_2<HTMLElement>) => void;
643
- /**
644
- * Href to be passed to product home.
645
- * Will add an interactive look and feel when defined.
646
- */
647
- href?: string;
648
- /**
649
- * Name of the site that appears next to the logo.
650
- */
651
329
  siteTitle?: string;
652
- /**
653
- A `testId` prop is provided for specified elements,
654
- which is a unique string that appears as a data attribute `data-testid` in the rendered code,
655
- serving as a hook for automated tests.
656
-
657
- Will set these elements when defined:
658
-
659
- - Root element of the component - `{testId}-container`
660
- - Product logo shown at large screen sizes - `{testId}-logo`
661
- - Product icon shown at small screen sizes - `{testId}-icon`
662
- - Site title - `{testId}-site-title`
663
- */
664
330
  testId?: string;
665
331
  }
666
332
 
667
- /**
668
- * __Profile__
669
- *
670
- * A profile button which takes an icon/avatar component can be that can be
671
- * passed into `AtlassianNavigation`'s `renderProfile` prop.
672
- *
673
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#profile)
674
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
675
- */
676
- export declare const Profile: ForwardRefExoticComponent<
333
+ // @public
334
+ export const Profile: ForwardRefExoticComponent<
677
335
  BaseIconButtonProps & {
678
336
  icon: ReactChild | undefined;
679
337
  theme?:
@@ -685,90 +343,55 @@ export declare const Profile: ForwardRefExoticComponent<
685
343
  } & RefAttributes<HTMLElement>
686
344
  >;
687
345
 
688
- export declare type ProfileProps = IconButtonProps;
346
+ // @public (undocumented)
347
+ export type ProfileProps = IconButtonProps;
689
348
 
690
- /**
691
- * __Search__
692
- *
693
- * A search input that can be passed into `AtlassianNavigation`'s `renderSearch` prop.
694
- *
695
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#search)
696
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
697
- */
698
- export declare const Search: (props: SearchProps) => JSX.Element;
349
+ // @public
350
+ export const Search: (props: SearchProps) => jsx.JSX.Element;
699
351
 
700
- export declare type SearchCSS = {
352
+ // @public (undocumented)
353
+ export type SearchCSS = {
701
354
  default: CSSProperties;
702
355
  focus: CSSObject;
703
356
  hover: CSSObject;
704
357
  };
705
358
 
706
- export declare type SearchProps = BaseIconButtonProps & {
707
- /**
708
- * Placeholder text for the search textbox.
709
- */
359
+ // @public (undocumented)
360
+ export type SearchProps = BaseIconButtonProps & {
710
361
  placeholder: string;
711
- /**
712
- * Used to describe the search icon and text field for users viewing the
713
- * page with a screen reader
714
- */
715
362
  label: string;
716
- /**
717
- * Value of search field.
718
- */
719
363
  value?: string;
720
364
  };
721
365
 
722
- /**
723
- * __Settings__
724
- *
725
- * A settings button that can be passed into `AtlassianNavigation`'s `renderSettings` prop.
726
- *
727
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#settings)
728
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
729
- */
730
- export declare const Settings: React_2.ForwardRefExoticComponent<
366
+ // @public
367
+ export const Settings: React_2.ForwardRefExoticComponent<
731
368
  BaseIconButtonProps & React_2.RefAttributes<any>
732
369
  >;
733
370
 
734
- export declare type SettingsProps = BaseIconButtonProps;
371
+ // @public (undocumented)
372
+ export type SettingsProps = BaseIconButtonProps;
735
373
 
736
- /**
737
- * __Sign in__
738
- *
739
- * A sign-in button that can be passed into `AtlassianNavigation`'s `renderSignIn` prop.
740
- *
741
- * - [Examples](https://atlassian.design/components/atlassian-navigation/examples#sign-in)
742
- * - [Code](https://atlassian.design/components/atlassian-navigation/code)
743
- */
744
- export declare const SignIn: (props: SignInProps) => JSX.Element;
374
+ // @public
375
+ export const SignIn: (props: SignInProps) => JSX.Element;
745
376
 
746
- export declare type SignInProps = BaseIconButtonProps;
377
+ // @public (undocumented)
378
+ export type SignInProps = BaseIconButtonProps;
747
379
 
748
- export declare type SkeletonCSS = CSSObject & {
380
+ // @public (undocumented)
381
+ export type SkeletonCSS = CSSObject & {
749
382
  backgroundColor: string;
750
383
  opacity: number;
751
384
  };
752
385
 
753
- /**
754
- * __Theme provider__
755
- *
756
- * A provider for the theme context used by all navigation components.
757
- */
758
- export declare const ThemeProvider: Provider<NavigationTheme>;
759
-
760
- /**
761
- * __useOverFlowStatus__
762
- *
763
- * Returns the current context value for the nearest OverflowProvider.
764
- *
765
- * - [Example](https://atlassian.design/components/atlassian-navigation/examples#responsive)
766
- */
767
- export declare const useOverflowStatus: () => {
386
+ // @public
387
+ export const ThemeProvider: Provider<NavigationTheme>;
388
+
389
+ // @public
390
+ export const useOverflowStatus: () => {
768
391
  isVisible: boolean;
769
392
  openOverflowMenu: typeof noop;
770
393
  closeOverflowMenu: typeof noop;
771
394
  };
772
395
 
773
- export {};
774
- ````
396
+ // (No @packageDocumentation comment for this package)
397
+ ```