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