@atlaskit/smart-card 45.18.14 → 45.19.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 +11 -0
- package/dist/cjs/utils/analytics/analytics.js +1 -1
- package/dist/cjs/view/LinkUrl/index.js +1 -1
- package/dist/es2019/utils/analytics/analytics.js +1 -1
- package/dist/es2019/view/LinkUrl/index.js +1 -1
- package/dist/esm/utils/analytics/analytics.js +1 -1
- package/dist/esm/view/LinkUrl/index.js +1 -1
- package/package.json +59 -59
- package/report.api.md +0 -1352
package/report.api.md
DELETED
|
@@ -1,1352 +0,0 @@
|
|
|
1
|
-
<!-- API Report Version: 2.3 -->
|
|
2
|
-
|
|
3
|
-
## API Report File for "@atlaskit/smart-card"
|
|
4
|
-
|
|
5
|
-
> Do not edit this file. This report is auto-generated using
|
|
6
|
-
> [API Extractor](https://api-extractor.com/).
|
|
7
|
-
> [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
|
|
8
|
-
|
|
9
|
-
### Table of contents
|
|
10
|
-
|
|
11
|
-
- [Main Entry Types](#main-entry-types)
|
|
12
|
-
- [Peer Dependencies](#peer-dependencies)
|
|
13
|
-
|
|
14
|
-
### Main Entry Types
|
|
15
|
-
|
|
16
|
-
<!--SECTION START: Main Entry Types-->
|
|
17
|
-
|
|
18
|
-
```ts
|
|
19
|
-
/// <reference types="react" />
|
|
20
|
-
|
|
21
|
-
import { APIError } from '@atlaskit/linking-common';
|
|
22
|
-
import { Appearance } from '@atlaskit/button/types';
|
|
23
|
-
import { BlockCardAdf } from '@atlaskit/linking-common';
|
|
24
|
-
import { CardAdf } from '@atlaskit/linking-common';
|
|
25
|
-
import { CardAppearance } from '@atlaskit/linking-common';
|
|
26
|
-
import { CardContext } from '@atlaskit/link-provider';
|
|
27
|
-
import { CardPlatform } from '@atlaskit/link-extractors';
|
|
28
|
-
import { CardType } from '@atlaskit/linking-common';
|
|
29
|
-
import { CardClient as Client } from '@atlaskit/link-provider';
|
|
30
|
-
import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
31
|
-
import { DatasourceAdf } from '@atlaskit/linking-common';
|
|
32
|
-
import { DatasourceAdfView } from '@atlaskit/linking-common';
|
|
33
|
-
import { EditorCardProvider } from '@atlaskit/link-provider';
|
|
34
|
-
import { editorCardProvider } from '@atlaskit/link-provider';
|
|
35
|
-
import { EmbedCardAdf } from '@atlaskit/linking-common';
|
|
36
|
-
import { ErrorInfo } from 'react';
|
|
37
|
-
import { GasPayload } from '@atlaskit/analytics-gas-types';
|
|
38
|
-
import { InlineCardAdf } from '@atlaskit/linking-common';
|
|
39
|
-
import { JsonLd } from '@atlaskit/json-ld-types';
|
|
40
|
-
import { MessageDescriptor } from 'react-intl';
|
|
41
|
-
import { SmartCardProvider as Provider } from '@atlaskit/link-provider';
|
|
42
|
-
import { ProviderProps } from '@atlaskit/link-provider';
|
|
43
|
-
import { default as React_2 } from 'react';
|
|
44
|
-
import { ReactChild } from 'react';
|
|
45
|
-
import { Ref } from 'react';
|
|
46
|
-
import { SerializedStyles } from '@emotion/react';
|
|
47
|
-
import { SmartCardContext } from '@atlaskit/link-provider';
|
|
48
|
-
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
49
|
-
import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
|
|
50
|
-
import { WithContextProps } from '@atlaskit/analytics-next';
|
|
51
|
-
import { WithIntlProps } from 'react-intl';
|
|
52
|
-
import { WrappedComponentProps } from 'react-intl';
|
|
53
|
-
|
|
54
|
-
// @public (undocumented)
|
|
55
|
-
export type ActionItem = CustomActionItem | NamedActionItem | NamedDataActionItem;
|
|
56
|
-
|
|
57
|
-
// @public
|
|
58
|
-
export enum ActionName {
|
|
59
|
-
// (undocumented)
|
|
60
|
-
CustomAction = 'CustomAction',
|
|
61
|
-
// (undocumented)
|
|
62
|
-
DeleteAction = 'DeleteAction',
|
|
63
|
-
// (undocumented)
|
|
64
|
-
DownloadAction = 'DownloadAction',
|
|
65
|
-
// (undocumented)
|
|
66
|
-
EditAction = 'EditAction',
|
|
67
|
-
// (undocumented)
|
|
68
|
-
FollowAction = 'FollowAction',
|
|
69
|
-
// (undocumented)
|
|
70
|
-
PreviewAction = 'PreviewAction',
|
|
71
|
-
// (undocumented)
|
|
72
|
-
ViewAction = 'ViewAction',
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
// @public (undocumented)
|
|
76
|
-
type ActionProps = {
|
|
77
|
-
size?: SmartLinkSize;
|
|
78
|
-
content?: React.ReactNode;
|
|
79
|
-
appearance?: Appearance;
|
|
80
|
-
onClick: () => any;
|
|
81
|
-
icon?: ReactChild;
|
|
82
|
-
iconPosition?: 'after' | 'before';
|
|
83
|
-
tooltipMessage?: React.ReactNode;
|
|
84
|
-
asDropDownItem?: boolean;
|
|
85
|
-
overrideCss?: SerializedStyles;
|
|
86
|
-
testId?: string;
|
|
87
|
-
isDisabled?: boolean;
|
|
88
|
-
};
|
|
89
|
-
|
|
90
|
-
// @public (undocumented)
|
|
91
|
-
export type AnalyticsAction =
|
|
92
|
-
| 'authStarted'
|
|
93
|
-
| 'chunkLoadFailed'
|
|
94
|
-
| 'clicked'
|
|
95
|
-
| 'closed'
|
|
96
|
-
| 'connectFailed'
|
|
97
|
-
| 'connectSucceeded'
|
|
98
|
-
| 'connected'
|
|
99
|
-
| 'created'
|
|
100
|
-
| 'dismissed'
|
|
101
|
-
| 'dwelled'
|
|
102
|
-
| 'failed'
|
|
103
|
-
| 'focused'
|
|
104
|
-
| 'inserted'
|
|
105
|
-
| 'loaded'
|
|
106
|
-
| 'renderFailed'
|
|
107
|
-
| 'renderSuccess'
|
|
108
|
-
| 'renderWithStatus'
|
|
109
|
-
| 'resolved'
|
|
110
|
-
| 'started'
|
|
111
|
-
| 'success'
|
|
112
|
-
| 'unresolved'
|
|
113
|
-
| 'updated'
|
|
114
|
-
| 'viewed';
|
|
115
|
-
|
|
116
|
-
// @public (undocumented)
|
|
117
|
-
export type AnalyticsActionSubject =
|
|
118
|
-
| 'applicationAccount'
|
|
119
|
-
| 'button'
|
|
120
|
-
| 'consentModal'
|
|
121
|
-
| 'embedPreviewModal'
|
|
122
|
-
| 'hoverCard'
|
|
123
|
-
| 'link'
|
|
124
|
-
| 'modal'
|
|
125
|
-
| 'relatedLinks'
|
|
126
|
-
| 'smartLink'
|
|
127
|
-
| 'smartLinkAction'
|
|
128
|
-
| 'smartLinkIframe'
|
|
129
|
-
| 'smartLinkQuickAction';
|
|
130
|
-
|
|
131
|
-
// @public (undocumented)
|
|
132
|
-
type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
|
|
133
|
-
|
|
134
|
-
// @public (undocumented)
|
|
135
|
-
export type AnalyticsHandler = (event: AnalyticsPayload) => void;
|
|
136
|
-
|
|
137
|
-
// @public (undocumented)
|
|
138
|
-
type AnalyticsName = 'embedPreviewModal';
|
|
139
|
-
|
|
140
|
-
// @public (undocumented)
|
|
141
|
-
export type AnalyticsPayload = GasPayload & {
|
|
142
|
-
action?: AnalyticsAction;
|
|
143
|
-
actionSubject: AnalyticsActionSubject;
|
|
144
|
-
attributes: GasPayload['attributes'] & {
|
|
145
|
-
display?: CardInnerAppearance;
|
|
146
|
-
};
|
|
147
|
-
};
|
|
148
|
-
|
|
149
|
-
// @public (undocumented)
|
|
150
|
-
type AnchorTarget = '_blank' | '_parent' | '_self' | '_top';
|
|
151
|
-
|
|
152
|
-
export { APIError };
|
|
153
|
-
|
|
154
|
-
// @public
|
|
155
|
-
type AssignedTo = {
|
|
156
|
-
name: ElementName.AssignedTo;
|
|
157
|
-
};
|
|
158
|
-
|
|
159
|
-
// @public
|
|
160
|
-
type AssignedToGroup = {
|
|
161
|
-
name: ElementName.AssignedToGroup;
|
|
162
|
-
showNamePrefix?: boolean;
|
|
163
|
-
showFallbackAvatar?: boolean;
|
|
164
|
-
};
|
|
165
|
-
|
|
166
|
-
// @public
|
|
167
|
-
type AttachmentCount = {
|
|
168
|
-
name: ElementName.AttachmentCount;
|
|
169
|
-
};
|
|
170
|
-
|
|
171
|
-
// @public
|
|
172
|
-
type AuthorGroup = {
|
|
173
|
-
name: ElementName.AuthorGroup;
|
|
174
|
-
showNamePrefix?: boolean;
|
|
175
|
-
};
|
|
176
|
-
|
|
177
|
-
// @public
|
|
178
|
-
type BaseActionItem = {
|
|
179
|
-
hideContent?: boolean;
|
|
180
|
-
hideIcon?: boolean;
|
|
181
|
-
name: ActionName;
|
|
182
|
-
onClick: () => any;
|
|
183
|
-
overrideCss?: SerializedStyles;
|
|
184
|
-
size?: SmartLinkSize;
|
|
185
|
-
testId?: string;
|
|
186
|
-
isDisabled?: boolean;
|
|
187
|
-
};
|
|
188
|
-
|
|
189
|
-
// @public
|
|
190
|
-
type BaseDataActionItem = {
|
|
191
|
-
hideContent?: boolean;
|
|
192
|
-
hideIcon?: boolean;
|
|
193
|
-
name: ActionName;
|
|
194
|
-
onClick?: () => any;
|
|
195
|
-
overrideCss?: SerializedStyles;
|
|
196
|
-
size?: SmartLinkSize;
|
|
197
|
-
testId?: string;
|
|
198
|
-
isDisabled?: boolean;
|
|
199
|
-
};
|
|
200
|
-
|
|
201
|
-
export { BlockCardAdf };
|
|
202
|
-
|
|
203
|
-
// @public (undocumented)
|
|
204
|
-
export const blockCardContentClassName = 'block-card-content';
|
|
205
|
-
|
|
206
|
-
// @public (undocumented)
|
|
207
|
-
export const blockCardContentHeaderClassName = 'block-card-content-header';
|
|
208
|
-
|
|
209
|
-
// @public (undocumented)
|
|
210
|
-
export const blockCardContentHeaderNameClassName = 'block-card-content-header-name';
|
|
211
|
-
|
|
212
|
-
// @public (undocumented)
|
|
213
|
-
export const blockCardErroredViewClassName = 'block-card-errored-view';
|
|
214
|
-
|
|
215
|
-
// @public (undocumented)
|
|
216
|
-
export const blockCardForbiddenViewClassName = 'block-card-forbidden-view';
|
|
217
|
-
|
|
218
|
-
// @public (undocumented)
|
|
219
|
-
export const blockCardForbiddenViewLinkClassName = 'block-card-forbidden-view-link';
|
|
220
|
-
|
|
221
|
-
// @public (undocumented)
|
|
222
|
-
export const blockCardIconImageClassName = 'block-card-icon-image';
|
|
223
|
-
|
|
224
|
-
// @public (undocumented)
|
|
225
|
-
export const blockCardNotFoundViewClassName = 'block-card-not-found-view';
|
|
226
|
-
|
|
227
|
-
// @public (undocumented)
|
|
228
|
-
export const blockCardResolvedViewByClassName = 'block-card-resolved-view-by';
|
|
229
|
-
|
|
230
|
-
// @public (undocumented)
|
|
231
|
-
export const blockCardResolvedViewClassName = 'block-card-resolved-view';
|
|
232
|
-
|
|
233
|
-
// @public (undocumented)
|
|
234
|
-
export const blockCardResolvingViewClassName = 'block-card-resolving-view';
|
|
235
|
-
|
|
236
|
-
// @public (undocumented)
|
|
237
|
-
type BlockProps = {
|
|
238
|
-
direction?: SmartLinkDirection;
|
|
239
|
-
overrideCss?: SerializedStyles;
|
|
240
|
-
size?: SmartLinkSize;
|
|
241
|
-
status?: SmartLinkStatus;
|
|
242
|
-
testId?: string;
|
|
243
|
-
blockRef?: Ref<HTMLDivElement>;
|
|
244
|
-
onRender?: () => void;
|
|
245
|
-
onTransitionEnd?: () => void;
|
|
246
|
-
};
|
|
247
|
-
|
|
248
|
-
// @public (undocumented)
|
|
249
|
-
export const Card: React_2.ForwardRefExoticComponent<
|
|
250
|
-
Pick<
|
|
251
|
-
Omit<
|
|
252
|
-
React_2.PropsWithChildren<WithIntlProps<CardProps & WrappedComponentProps<'intl'>>>,
|
|
253
|
-
keyof WithAnalyticsEventsProps
|
|
254
|
-
> &
|
|
255
|
-
React_2.RefAttributes<any> &
|
|
256
|
-
WithContextProps,
|
|
257
|
-
| 'analyticsContext'
|
|
258
|
-
| 'analyticsEvents'
|
|
259
|
-
| 'appearance'
|
|
260
|
-
| 'children'
|
|
261
|
-
| 'container'
|
|
262
|
-
| 'data'
|
|
263
|
-
| 'embedIframeRef'
|
|
264
|
-
| 'embedIframeUrlType'
|
|
265
|
-
| 'fallbackComponent'
|
|
266
|
-
| 'forwardedRef'
|
|
267
|
-
| 'frameStyle'
|
|
268
|
-
| 'id'
|
|
269
|
-
| 'importer'
|
|
270
|
-
| 'inheritDimensions'
|
|
271
|
-
| 'inlinePreloaderStyle'
|
|
272
|
-
| 'isFrameVisible'
|
|
273
|
-
| 'isSelected'
|
|
274
|
-
| 'key'
|
|
275
|
-
| 'onClick'
|
|
276
|
-
| 'onError'
|
|
277
|
-
| 'onResolve'
|
|
278
|
-
| 'placeholder'
|
|
279
|
-
| 'platform'
|
|
280
|
-
| 'showActions'
|
|
281
|
-
| 'showAuthTooltip'
|
|
282
|
-
| 'showHoverPreview'
|
|
283
|
-
| 'showServerActions'
|
|
284
|
-
| 'testId'
|
|
285
|
-
| 'ui'
|
|
286
|
-
| 'url'
|
|
287
|
-
> &
|
|
288
|
-
React_2.RefAttributes<any>
|
|
289
|
-
>;
|
|
290
|
-
|
|
291
|
-
export { CardAdf };
|
|
292
|
-
|
|
293
|
-
export { CardAppearance };
|
|
294
|
-
|
|
295
|
-
export { CardContext };
|
|
296
|
-
|
|
297
|
-
// @public (undocumented)
|
|
298
|
-
type CardInnerAppearance = 'embedPreview' | 'flexible' | 'hoverCardPreview' | CardAppearance;
|
|
299
|
-
|
|
300
|
-
export { CardPlatform };
|
|
301
|
-
|
|
302
|
-
// @public (undocumented)
|
|
303
|
-
export interface CardProps extends WithAnalyticsEventsProps {
|
|
304
|
-
// @deprecated (undocumented)
|
|
305
|
-
analyticsEvents?: AnalyticsFacade;
|
|
306
|
-
// (undocumented)
|
|
307
|
-
appearance: CardAppearance;
|
|
308
|
-
// (undocumented)
|
|
309
|
-
children?: React.ReactNode;
|
|
310
|
-
// (undocumented)
|
|
311
|
-
container?: HTMLElement;
|
|
312
|
-
// @deprecated (undocumented)
|
|
313
|
-
data?: any;
|
|
314
|
-
// (undocumented)
|
|
315
|
-
embedIframeRef?: React.Ref<HTMLIFrameElement>;
|
|
316
|
-
// (undocumented)
|
|
317
|
-
embedIframeUrlType?: EmbedIframeUrlType;
|
|
318
|
-
fallbackComponent?: React.ComponentType;
|
|
319
|
-
frameStyle?: FrameStyle;
|
|
320
|
-
// (undocumented)
|
|
321
|
-
id?: string;
|
|
322
|
-
// (undocumented)
|
|
323
|
-
importer?: (target: any) => void;
|
|
324
|
-
inheritDimensions?: boolean;
|
|
325
|
-
// (undocumented)
|
|
326
|
-
inlinePreloaderStyle?: InlinePreloaderStyle;
|
|
327
|
-
// @deprecated (undocumented)
|
|
328
|
-
isFrameVisible?: boolean;
|
|
329
|
-
// (undocumented)
|
|
330
|
-
isSelected?: boolean;
|
|
331
|
-
// (undocumented)
|
|
332
|
-
onClick?: React.EventHandler<React.KeyboardEvent | React.MouseEvent>;
|
|
333
|
-
onError?: OnErrorCallback;
|
|
334
|
-
// (undocumented)
|
|
335
|
-
onResolve?: OnResolveCallback;
|
|
336
|
-
// (undocumented)
|
|
337
|
-
placeholder?: string;
|
|
338
|
-
// (undocumented)
|
|
339
|
-
platform?: CardPlatform;
|
|
340
|
-
showActions?: boolean;
|
|
341
|
-
// (undocumented)
|
|
342
|
-
showAuthTooltip?: boolean;
|
|
343
|
-
// (undocumented)
|
|
344
|
-
showHoverPreview?: boolean;
|
|
345
|
-
showServerActions?: boolean;
|
|
346
|
-
// (undocumented)
|
|
347
|
-
testId?: string;
|
|
348
|
-
// (undocumented)
|
|
349
|
-
ui?: FlexibleUiOptions;
|
|
350
|
-
// (undocumented)
|
|
351
|
-
url?: string;
|
|
352
|
-
}
|
|
353
|
-
|
|
354
|
-
export { CardType };
|
|
355
|
-
|
|
356
|
-
// @public
|
|
357
|
-
type ChecklistProgress = {
|
|
358
|
-
name: ElementName.ChecklistProgress;
|
|
359
|
-
};
|
|
360
|
-
|
|
361
|
-
export { Client };
|
|
362
|
-
|
|
363
|
-
// @public
|
|
364
|
-
type CollaboratorGroup = {
|
|
365
|
-
name: ElementName.CollaboratorGroup;
|
|
366
|
-
};
|
|
367
|
-
|
|
368
|
-
// @public
|
|
369
|
-
type CommentCount = {
|
|
370
|
-
name: ElementName.CommentCount;
|
|
371
|
-
};
|
|
372
|
-
|
|
373
|
-
// @public (undocumented)
|
|
374
|
-
interface CommonEventProps {
|
|
375
|
-
// (undocumented)
|
|
376
|
-
definitionId?: string;
|
|
377
|
-
// (undocumented)
|
|
378
|
-
destinatinoObjectType?: string;
|
|
379
|
-
// (undocumented)
|
|
380
|
-
destinationProduct?: DestinationProduct | string;
|
|
381
|
-
// (undocumented)
|
|
382
|
-
destinationSubproduct?: DestinationSubproduct | string;
|
|
383
|
-
// (undocumented)
|
|
384
|
-
extensionKey?: string;
|
|
385
|
-
// (undocumented)
|
|
386
|
-
id?: string;
|
|
387
|
-
// (undocumented)
|
|
388
|
-
location?: string;
|
|
389
|
-
// (undocumented)
|
|
390
|
-
resourceType?: string;
|
|
391
|
-
// (undocumented)
|
|
392
|
-
statusDetails?: string;
|
|
393
|
-
}
|
|
394
|
-
|
|
395
|
-
// @public (undocumented)
|
|
396
|
-
type ConnectFailedEventProps = CommonEventProps & {
|
|
397
|
-
id?: string;
|
|
398
|
-
reason?: string;
|
|
399
|
-
};
|
|
400
|
-
|
|
401
|
-
// @public (undocumented)
|
|
402
|
-
type ConnectSucceededEventProps = CommonEventProps & {
|
|
403
|
-
id?: string;
|
|
404
|
-
};
|
|
405
|
-
|
|
406
|
-
// @public (undocumented)
|
|
407
|
-
export const contentFooterClassName = 'smart-link-content-footer';
|
|
408
|
-
|
|
409
|
-
// @public
|
|
410
|
-
type CreatedBy = {
|
|
411
|
-
name: ElementName.CreatedBy;
|
|
412
|
-
};
|
|
413
|
-
|
|
414
|
-
// @public
|
|
415
|
-
type CreatedOn = {
|
|
416
|
-
name: ElementName.CreatedOn;
|
|
417
|
-
text?: string;
|
|
418
|
-
};
|
|
419
|
-
|
|
420
|
-
// @public
|
|
421
|
-
type CustomActionItem = BaseActionItem & {
|
|
422
|
-
name: ActionName.CustomAction;
|
|
423
|
-
} & (
|
|
424
|
-
| ((Required<Pick<ActionProps, 'content'>> & Pick<ActionProps, 'icon' | 'iconPosition'>) &
|
|
425
|
-
Pick<ActionProps, 'tooltipMessage'>)
|
|
426
|
-
| (Required<Pick<ActionProps, 'icon' | 'iconPosition'>> & Pick<ActionProps, 'content'>)
|
|
427
|
-
);
|
|
428
|
-
|
|
429
|
-
// @internal
|
|
430
|
-
export const CustomBlock: React_2.FC<BlockProps>;
|
|
431
|
-
|
|
432
|
-
export { DatasourceAdf };
|
|
433
|
-
|
|
434
|
-
export { DatasourceAdfView };
|
|
435
|
-
|
|
436
|
-
// @public (undocumented)
|
|
437
|
-
type DestinationProduct = 'bitbucket' | 'confluence' | 'jira' | 'trello';
|
|
438
|
-
|
|
439
|
-
// @public (undocumented)
|
|
440
|
-
type DestinationSubproduct = 'core' | 'servicedesk' | 'software';
|
|
441
|
-
|
|
442
|
-
// @public
|
|
443
|
-
type DueOn = {
|
|
444
|
-
name: ElementName.DueOn;
|
|
445
|
-
};
|
|
446
|
-
|
|
447
|
-
export { EditorCardProvider };
|
|
448
|
-
|
|
449
|
-
export { editorCardProvider };
|
|
450
|
-
|
|
451
|
-
// @public
|
|
452
|
-
export type ElementItem = {
|
|
453
|
-
overrideCss?: SerializedStyles;
|
|
454
|
-
size?: SmartLinkSize;
|
|
455
|
-
testId?: string;
|
|
456
|
-
} & ElementItemProps;
|
|
457
|
-
|
|
458
|
-
// @public
|
|
459
|
-
type ElementItemProps =
|
|
460
|
-
| AssignedTo
|
|
461
|
-
| AssignedToGroup
|
|
462
|
-
| AttachmentCount
|
|
463
|
-
| AuthorGroup
|
|
464
|
-
| ChecklistProgress
|
|
465
|
-
| CollaboratorGroup
|
|
466
|
-
| CommentCount
|
|
467
|
-
| CreatedBy
|
|
468
|
-
| CreatedOn
|
|
469
|
-
| DueOn
|
|
470
|
-
| LatestCommit
|
|
471
|
-
| LinkIcon
|
|
472
|
-
| Location_2
|
|
473
|
-
| ModifiedBy
|
|
474
|
-
| ModifiedOn
|
|
475
|
-
| OwnedBy
|
|
476
|
-
| OwnedByGroup
|
|
477
|
-
| Preview
|
|
478
|
-
| Priority
|
|
479
|
-
| ProgrammingLanguage
|
|
480
|
-
| Provider_2
|
|
481
|
-
| ReactCount
|
|
482
|
-
| ReadTime
|
|
483
|
-
| SentOn
|
|
484
|
-
| Snippet
|
|
485
|
-
| SourceBranch
|
|
486
|
-
| State_2
|
|
487
|
-
| StoryPoints
|
|
488
|
-
| SubTasksProgress
|
|
489
|
-
| SubscriberCount
|
|
490
|
-
| TargetBranch
|
|
491
|
-
| Title
|
|
492
|
-
| ViewCount
|
|
493
|
-
| VoteCount;
|
|
494
|
-
|
|
495
|
-
// @public
|
|
496
|
-
export enum ElementName {
|
|
497
|
-
// (undocumented)
|
|
498
|
-
AssignedTo = 'AssignedTo',
|
|
499
|
-
// (undocumented)
|
|
500
|
-
AssignedToGroup = 'AssignedToGroup',
|
|
501
|
-
// (undocumented)
|
|
502
|
-
AttachmentCount = 'AttachmentCount',
|
|
503
|
-
// (undocumented)
|
|
504
|
-
AuthorGroup = 'AuthorGroup',
|
|
505
|
-
// (undocumented)
|
|
506
|
-
ChecklistProgress = 'ChecklistProgress',
|
|
507
|
-
// (undocumented)
|
|
508
|
-
CollaboratorGroup = 'CollaboratorGroup',
|
|
509
|
-
// (undocumented)
|
|
510
|
-
CommentCount = 'CommentCount',
|
|
511
|
-
// (undocumented)
|
|
512
|
-
CreatedBy = 'CreatedBy',
|
|
513
|
-
// (undocumented)
|
|
514
|
-
CreatedOn = 'CreatedOn',
|
|
515
|
-
// (undocumented)
|
|
516
|
-
DueOn = 'DueOn',
|
|
517
|
-
// (undocumented)
|
|
518
|
-
LatestCommit = 'LatestCommit',
|
|
519
|
-
// (undocumented)
|
|
520
|
-
LinkIcon = 'LinkIcon',
|
|
521
|
-
// (undocumented)
|
|
522
|
-
Location = 'Location',
|
|
523
|
-
// (undocumented)
|
|
524
|
-
ModifiedBy = 'ModifiedBy',
|
|
525
|
-
// (undocumented)
|
|
526
|
-
ModifiedOn = 'ModifiedOn',
|
|
527
|
-
// (undocumented)
|
|
528
|
-
OwnedBy = 'OwnedBy',
|
|
529
|
-
// (undocumented)
|
|
530
|
-
OwnedByGroup = 'OwnedByGroup',
|
|
531
|
-
// (undocumented)
|
|
532
|
-
Preview = 'Preview',
|
|
533
|
-
// (undocumented)
|
|
534
|
-
Priority = 'Priority',
|
|
535
|
-
// (undocumented)
|
|
536
|
-
ProgrammingLanguage = 'ProgrammingLanguage',
|
|
537
|
-
// (undocumented)
|
|
538
|
-
Provider = 'Provider',
|
|
539
|
-
// (undocumented)
|
|
540
|
-
ReactCount = 'ReactCount',
|
|
541
|
-
// (undocumented)
|
|
542
|
-
ReadTime = 'ReadTime',
|
|
543
|
-
// (undocumented)
|
|
544
|
-
SentOn = 'SentOn',
|
|
545
|
-
// (undocumented)
|
|
546
|
-
Snippet = 'Snippet',
|
|
547
|
-
// (undocumented)
|
|
548
|
-
SourceBranch = 'SourceBranch',
|
|
549
|
-
// (undocumented)
|
|
550
|
-
State = 'State',
|
|
551
|
-
// (undocumented)
|
|
552
|
-
StoryPoints = 'StoryPoints',
|
|
553
|
-
// (undocumented)
|
|
554
|
-
SubscriberCount = 'SubscriberCount',
|
|
555
|
-
// (undocumented)
|
|
556
|
-
SubTasksProgress = 'SubTasksProgress',
|
|
557
|
-
// (undocumented)
|
|
558
|
-
TargetBranch = 'TargetBranch',
|
|
559
|
-
// (undocumented)
|
|
560
|
-
Title = 'Title',
|
|
561
|
-
// (undocumented)
|
|
562
|
-
ViewCount = 'ViewCount',
|
|
563
|
-
// (undocumented)
|
|
564
|
-
VoteCount = 'VoteCount',
|
|
565
|
-
}
|
|
566
|
-
|
|
567
|
-
export { EmbedCardAdf };
|
|
568
|
-
|
|
569
|
-
// @public (undocumented)
|
|
570
|
-
export const embedHeaderHeight = 32;
|
|
571
|
-
|
|
572
|
-
// @public (undocumented)
|
|
573
|
-
type EmbedIframeUrlType = 'href' | 'interactiveHref';
|
|
574
|
-
|
|
575
|
-
// @public (undocumented)
|
|
576
|
-
export class EmbedResizeMessageListener extends React_2.Component<Props, State> {
|
|
577
|
-
// (undocumented)
|
|
578
|
-
componentDidMount(): void;
|
|
579
|
-
// (undocumented)
|
|
580
|
-
componentWillUnmount(): void;
|
|
581
|
-
// (undocumented)
|
|
582
|
-
render(): React_2.ReactNode;
|
|
583
|
-
}
|
|
584
|
-
|
|
585
|
-
// @public (undocumented)
|
|
586
|
-
type ErrorCardType = 'errored' | 'fallback' | 'forbidden' | 'not_found' | 'unauthorized';
|
|
587
|
-
|
|
588
|
-
// @public (undocumented)
|
|
589
|
-
type FlexibleUiOptions = {
|
|
590
|
-
clickableContainer?: boolean;
|
|
591
|
-
hideElevation?: boolean;
|
|
592
|
-
hideHoverCardPreviewButton?: boolean;
|
|
593
|
-
hidePadding?: boolean;
|
|
594
|
-
hideBackground?: boolean;
|
|
595
|
-
size?: SmartLinkSize;
|
|
596
|
-
theme?: SmartLinkTheme;
|
|
597
|
-
zIndex?: number;
|
|
598
|
-
};
|
|
599
|
-
|
|
600
|
-
// @public
|
|
601
|
-
export const FooterBlock: React_2.FC<FooterBlockProps>;
|
|
602
|
-
|
|
603
|
-
// @public (undocumented)
|
|
604
|
-
type FooterBlockProps = {
|
|
605
|
-
actions?: ActionItem[];
|
|
606
|
-
onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
|
|
607
|
-
} & BlockProps;
|
|
608
|
-
|
|
609
|
-
// @public (undocumented)
|
|
610
|
-
type FrameStyle = 'hide' | 'show' | 'showOnHover';
|
|
611
|
-
|
|
612
|
-
export { InlineCardAdf };
|
|
613
|
-
|
|
614
|
-
// @public (undocumented)
|
|
615
|
-
type InlinePreloaderStyle = 'on-left-with-skeleton' | 'on-right-without-skeleton';
|
|
616
|
-
|
|
617
|
-
// @public (undocumented)
|
|
618
|
-
type InstrumentEventProps = CommonEventProps & {
|
|
619
|
-
error?: APIError;
|
|
620
|
-
status: CardType;
|
|
621
|
-
id: string;
|
|
622
|
-
};
|
|
623
|
-
|
|
624
|
-
// @public (undocumented)
|
|
625
|
-
type InvokeFailedEventProps = CommonEventProps & {
|
|
626
|
-
id?: string;
|
|
627
|
-
actionType: string;
|
|
628
|
-
display?: CardInnerAppearance;
|
|
629
|
-
reason: string;
|
|
630
|
-
};
|
|
631
|
-
|
|
632
|
-
// @public (undocumented)
|
|
633
|
-
type InvokeSucceededEventProps = CommonEventProps & {
|
|
634
|
-
id?: string;
|
|
635
|
-
actionType: string;
|
|
636
|
-
display?: CardInnerAppearance;
|
|
637
|
-
};
|
|
638
|
-
|
|
639
|
-
// @public (undocumented)
|
|
640
|
-
type InvokeType = 'client' | 'server';
|
|
641
|
-
|
|
642
|
-
// @public
|
|
643
|
-
type LatestCommit = {
|
|
644
|
-
name: ElementName.LatestCommit;
|
|
645
|
-
};
|
|
646
|
-
|
|
647
|
-
// @public
|
|
648
|
-
type LinkIcon = {
|
|
649
|
-
name: ElementName.LinkIcon;
|
|
650
|
-
};
|
|
651
|
-
|
|
652
|
-
// @public (undocumented)
|
|
653
|
-
export const loadingPlaceholderClassName = 'smart-link-loading-placeholder';
|
|
654
|
-
|
|
655
|
-
// @public
|
|
656
|
-
type Location_2 = {
|
|
657
|
-
name: ElementName.Location;
|
|
658
|
-
};
|
|
659
|
-
|
|
660
|
-
// @public (undocumented)
|
|
661
|
-
export enum MediaPlacement {
|
|
662
|
-
// (undocumented)
|
|
663
|
-
Left = 'left',
|
|
664
|
-
// (undocumented)
|
|
665
|
-
Right = 'right',
|
|
666
|
-
}
|
|
667
|
-
|
|
668
|
-
// @public
|
|
669
|
-
export const MetadataBlock: React_2.FC<MetadataBlockProps>;
|
|
670
|
-
|
|
671
|
-
// @public (undocumented)
|
|
672
|
-
type MetadataBlockProps = {
|
|
673
|
-
maxLines?: number;
|
|
674
|
-
primary?: ElementItem[];
|
|
675
|
-
secondary?: ElementItem[];
|
|
676
|
-
} & BlockProps;
|
|
677
|
-
|
|
678
|
-
// @public (undocumented)
|
|
679
|
-
export const metadataListClassName = 'smart-link-metadata-list';
|
|
680
|
-
|
|
681
|
-
// @public
|
|
682
|
-
type ModifiedBy = {
|
|
683
|
-
name: ElementName.ModifiedBy;
|
|
684
|
-
};
|
|
685
|
-
|
|
686
|
-
// @public
|
|
687
|
-
type ModifiedOn = {
|
|
688
|
-
name: ElementName.ModifiedOn;
|
|
689
|
-
text?: string;
|
|
690
|
-
};
|
|
691
|
-
|
|
692
|
-
// @public
|
|
693
|
-
type NamedActionItem = BaseActionItem & {
|
|
694
|
-
name: ActionName.DeleteAction | ActionName.EditAction;
|
|
695
|
-
};
|
|
696
|
-
|
|
697
|
-
// @public
|
|
698
|
-
type NamedDataActionItem = BaseDataActionItem & {
|
|
699
|
-
name:
|
|
700
|
-
| ActionName.DownloadAction
|
|
701
|
-
| ActionName.FollowAction
|
|
702
|
-
| ActionName.PreviewAction
|
|
703
|
-
| ActionName.ViewAction;
|
|
704
|
-
};
|
|
705
|
-
|
|
706
|
-
// @public (undocumented)
|
|
707
|
-
export type OnActionMenuOpenChangeOptions = {
|
|
708
|
-
isOpen: boolean;
|
|
709
|
-
};
|
|
710
|
-
|
|
711
|
-
// @public (undocumented)
|
|
712
|
-
type OnErrorCallback = (data: {
|
|
713
|
-
status: Extract<CardType, ErrorCardType>;
|
|
714
|
-
url: string;
|
|
715
|
-
err?: Error;
|
|
716
|
-
}) => void;
|
|
717
|
-
|
|
718
|
-
// @public (undocumented)
|
|
719
|
-
type OnResolveCallback = (data: { url?: string; title?: string; aspectRatio?: number }) => void;
|
|
720
|
-
|
|
721
|
-
// @public
|
|
722
|
-
type OwnedBy = {
|
|
723
|
-
name: ElementName.OwnedBy;
|
|
724
|
-
};
|
|
725
|
-
|
|
726
|
-
// @public
|
|
727
|
-
type OwnedByGroup = {
|
|
728
|
-
name: ElementName.OwnedByGroup;
|
|
729
|
-
showNamePrefix?: boolean;
|
|
730
|
-
};
|
|
731
|
-
|
|
732
|
-
// @public
|
|
733
|
-
type Preview = {
|
|
734
|
-
name: ElementName.Preview;
|
|
735
|
-
};
|
|
736
|
-
|
|
737
|
-
// @public
|
|
738
|
-
export const PreviewBlock: React_2.FC<PreviewBlockProps>;
|
|
739
|
-
|
|
740
|
-
// @public (undocumented)
|
|
741
|
-
type PreviewBlockProps = {
|
|
742
|
-
ignoreContainerPadding?: boolean;
|
|
743
|
-
onError?: () => void;
|
|
744
|
-
placement?: MediaPlacement;
|
|
745
|
-
overrideUrl?: string;
|
|
746
|
-
} & BlockProps;
|
|
747
|
-
|
|
748
|
-
// @public (undocumented)
|
|
749
|
-
type PreviewDisplay = 'card' | 'embed';
|
|
750
|
-
|
|
751
|
-
// @public (undocumented)
|
|
752
|
-
type PreviewInvokeMethod = 'keyboard' | 'mouse_click' | 'mouse_hover';
|
|
753
|
-
|
|
754
|
-
// @public
|
|
755
|
-
type Priority = {
|
|
756
|
-
name: ElementName.Priority;
|
|
757
|
-
};
|
|
758
|
-
|
|
759
|
-
// @public
|
|
760
|
-
type ProgrammingLanguage = {
|
|
761
|
-
name: ElementName.ProgrammingLanguage;
|
|
762
|
-
};
|
|
763
|
-
|
|
764
|
-
// @public (undocumented)
|
|
765
|
-
interface Props {
|
|
766
|
-
// (undocumented)
|
|
767
|
-
embedIframeRef: React_2.RefObject<HTMLIFrameElement>;
|
|
768
|
-
// (undocumented)
|
|
769
|
-
onHeightUpdate: (height: number) => void;
|
|
770
|
-
}
|
|
771
|
-
|
|
772
|
-
export { Provider };
|
|
773
|
-
|
|
774
|
-
// @public
|
|
775
|
-
type Provider_2 = {
|
|
776
|
-
name: ElementName.Provider;
|
|
777
|
-
};
|
|
778
|
-
|
|
779
|
-
export { ProviderProps };
|
|
780
|
-
|
|
781
|
-
// @public
|
|
782
|
-
type ReactCount = {
|
|
783
|
-
name: ElementName.ReactCount;
|
|
784
|
-
};
|
|
785
|
-
|
|
786
|
-
// @public
|
|
787
|
-
type ReadTime = {
|
|
788
|
-
name: ElementName.ReadTime;
|
|
789
|
-
};
|
|
790
|
-
|
|
791
|
-
// @public (undocumented)
|
|
792
|
-
export type ResolveResponse = JsonLd.Response;
|
|
793
|
-
|
|
794
|
-
// @public
|
|
795
|
-
type RetryOptions = {
|
|
796
|
-
descriptor?: MessageDescriptor;
|
|
797
|
-
onClick?: ((e: React.MouseEvent<HTMLElement>) => void) | undefined;
|
|
798
|
-
values?: Record<string, string>;
|
|
799
|
-
};
|
|
800
|
-
|
|
801
|
-
// @public (undocumented)
|
|
802
|
-
type ScreenAuthPopupEventProps = CommonEventProps;
|
|
803
|
-
|
|
804
|
-
// @public
|
|
805
|
-
type SentOn = {
|
|
806
|
-
name: ElementName.SentOn;
|
|
807
|
-
};
|
|
808
|
-
|
|
809
|
-
export { SmartCardContext as Context };
|
|
810
|
-
export { SmartCardContext };
|
|
811
|
-
|
|
812
|
-
// @public
|
|
813
|
-
export enum SmartLinkDirection {
|
|
814
|
-
// (undocumented)
|
|
815
|
-
Horizontal = 'horizontal',
|
|
816
|
-
// (undocumented)
|
|
817
|
-
Vertical = 'vertical',
|
|
818
|
-
}
|
|
819
|
-
|
|
820
|
-
// @public (undocumented)
|
|
821
|
-
export class SmartLinkEvents {
|
|
822
|
-
// (undocumented)
|
|
823
|
-
insertSmartLink(
|
|
824
|
-
url: string,
|
|
825
|
-
type: CardInnerAppearance,
|
|
826
|
-
createAnalyticsEvent?: CreateUIAnalyticsEvent,
|
|
827
|
-
): void;
|
|
828
|
-
}
|
|
829
|
-
|
|
830
|
-
// @public
|
|
831
|
-
export enum SmartLinkPosition {
|
|
832
|
-
// (undocumented)
|
|
833
|
-
Center = 'center',
|
|
834
|
-
// (undocumented)
|
|
835
|
-
Top = 'top',
|
|
836
|
-
}
|
|
837
|
-
|
|
838
|
-
// @public
|
|
839
|
-
export enum SmartLinkSize {
|
|
840
|
-
// (undocumented)
|
|
841
|
-
Large = 'large',
|
|
842
|
-
// (undocumented)
|
|
843
|
-
Medium = 'medium',
|
|
844
|
-
// (undocumented)
|
|
845
|
-
Small = 'small',
|
|
846
|
-
// (undocumented)
|
|
847
|
-
XLarge = 'xlarge',
|
|
848
|
-
}
|
|
849
|
-
|
|
850
|
-
// @public
|
|
851
|
-
enum SmartLinkStatus {
|
|
852
|
-
// (undocumented)
|
|
853
|
-
Errored = 'errored',
|
|
854
|
-
// (undocumented)
|
|
855
|
-
Fallback = 'fallback',
|
|
856
|
-
// (undocumented)
|
|
857
|
-
Forbidden = 'forbidden',
|
|
858
|
-
// (undocumented)
|
|
859
|
-
NotFound = 'not_found',
|
|
860
|
-
// (undocumented)
|
|
861
|
-
Pending = 'pending',
|
|
862
|
-
// (undocumented)
|
|
863
|
-
Resolved = 'resolved',
|
|
864
|
-
// (undocumented)
|
|
865
|
-
Resolving = 'resolving',
|
|
866
|
-
// (undocumented)
|
|
867
|
-
Unauthorized = 'unauthorized',
|
|
868
|
-
}
|
|
869
|
-
|
|
870
|
-
// @public
|
|
871
|
-
export enum SmartLinkTheme {
|
|
872
|
-
// (undocumented)
|
|
873
|
-
Black = 'black',
|
|
874
|
-
// (undocumented)
|
|
875
|
-
Link = 'link',
|
|
876
|
-
}
|
|
877
|
-
|
|
878
|
-
// @public
|
|
879
|
-
type Snippet = {
|
|
880
|
-
name: ElementName.Snippet;
|
|
881
|
-
};
|
|
882
|
-
|
|
883
|
-
// @public
|
|
884
|
-
export const SnippetBlock: React_2.FC<SnippetBlockProps>;
|
|
885
|
-
|
|
886
|
-
// @public (undocumented)
|
|
887
|
-
type SnippetBlockProps = {
|
|
888
|
-
maxLines?: number;
|
|
889
|
-
text?: string;
|
|
890
|
-
} & BlockProps;
|
|
891
|
-
|
|
892
|
-
// @public
|
|
893
|
-
type SourceBranch = {
|
|
894
|
-
name: ElementName.SourceBranch;
|
|
895
|
-
};
|
|
896
|
-
|
|
897
|
-
// @public (undocumented)
|
|
898
|
-
interface State {}
|
|
899
|
-
|
|
900
|
-
// @public
|
|
901
|
-
type State_2 = {
|
|
902
|
-
name: ElementName.State;
|
|
903
|
-
};
|
|
904
|
-
|
|
905
|
-
// @public
|
|
906
|
-
type StoryPoints = {
|
|
907
|
-
name: ElementName.StoryPoints;
|
|
908
|
-
};
|
|
909
|
-
|
|
910
|
-
// @public
|
|
911
|
-
type SubscriberCount = {
|
|
912
|
-
name: ElementName.SubscriberCount;
|
|
913
|
-
};
|
|
914
|
-
|
|
915
|
-
// @public
|
|
916
|
-
type SubTasksProgress = {
|
|
917
|
-
name: ElementName.SubTasksProgress;
|
|
918
|
-
};
|
|
919
|
-
|
|
920
|
-
// @public
|
|
921
|
-
type TargetBranch = {
|
|
922
|
-
name: ElementName.TargetBranch;
|
|
923
|
-
};
|
|
924
|
-
|
|
925
|
-
// @public
|
|
926
|
-
type Title = {
|
|
927
|
-
name: ElementName.Title;
|
|
928
|
-
};
|
|
929
|
-
|
|
930
|
-
// @public
|
|
931
|
-
export const TitleBlock: React_2.FC<TitleBlockProps>;
|
|
932
|
-
|
|
933
|
-
// @public (undocumented)
|
|
934
|
-
type TitleBlockProps = {
|
|
935
|
-
actions?: ActionItem[];
|
|
936
|
-
anchorTarget?: AnchorTarget;
|
|
937
|
-
hideTitleTooltip?: boolean;
|
|
938
|
-
maxLines?: number;
|
|
939
|
-
metadata?: ElementItem[];
|
|
940
|
-
onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
|
|
941
|
-
position?: SmartLinkPosition;
|
|
942
|
-
onClick?: React_2.EventHandler<React_2.KeyboardEvent | React_2.MouseEvent>;
|
|
943
|
-
retry?: RetryOptions;
|
|
944
|
-
hideRetry?: boolean;
|
|
945
|
-
showActionOnHover?: boolean;
|
|
946
|
-
subtitle?: ElementItem[];
|
|
947
|
-
text?: string;
|
|
948
|
-
theme?: SmartLinkTheme;
|
|
949
|
-
metadataPosition?: SmartLinkPosition;
|
|
950
|
-
hideIcon?: boolean;
|
|
951
|
-
} & BlockProps;
|
|
952
|
-
|
|
953
|
-
// @public (undocumented)
|
|
954
|
-
type TrackAppAccountConnectedProps = CommonEventProps;
|
|
955
|
-
|
|
956
|
-
// @public (undocumented)
|
|
957
|
-
enum TrackQuickActionFailureReason {
|
|
958
|
-
// (undocumented)
|
|
959
|
-
PermissionError = 'PermissionError',
|
|
960
|
-
// (undocumented)
|
|
961
|
-
UnknownError = 'UnknownError',
|
|
962
|
-
// (undocumented)
|
|
963
|
-
ValidationError = 'ValidationError',
|
|
964
|
-
}
|
|
965
|
-
|
|
966
|
-
// @public (undocumented)
|
|
967
|
-
enum TrackQuickActionType {
|
|
968
|
-
// (undocumented)
|
|
969
|
-
StatusUpdate = 'StatusUpdate',
|
|
970
|
-
}
|
|
971
|
-
|
|
972
|
-
// @public (undocumented)
|
|
973
|
-
type UiActionClickedEventProps = CommonEventProps & {
|
|
974
|
-
id?: string;
|
|
975
|
-
display?: CardInnerAppearance;
|
|
976
|
-
actionType: string;
|
|
977
|
-
invokeType?: InvokeType;
|
|
978
|
-
};
|
|
979
|
-
|
|
980
|
-
// @public (undocumented)
|
|
981
|
-
type UiAuthAlternateAccountEventProps = CommonEventProps & {
|
|
982
|
-
display: CardInnerAppearance;
|
|
983
|
-
};
|
|
984
|
-
|
|
985
|
-
// @public (undocumented)
|
|
986
|
-
type UiAuthEventProps = CommonEventProps & {
|
|
987
|
-
display: CardInnerAppearance;
|
|
988
|
-
};
|
|
989
|
-
|
|
990
|
-
// @public (undocumented)
|
|
991
|
-
type UiCardClickedEventProps = CommonEventProps & {
|
|
992
|
-
id: string;
|
|
993
|
-
display: CardInnerAppearance;
|
|
994
|
-
status: CardType;
|
|
995
|
-
isModifierKeyPressed?: boolean;
|
|
996
|
-
actionSubjectId?: string;
|
|
997
|
-
};
|
|
998
|
-
|
|
999
|
-
// @public (undocumented)
|
|
1000
|
-
type UiClosedAuthEventProps = CommonEventProps & {
|
|
1001
|
-
display: CardInnerAppearance;
|
|
1002
|
-
};
|
|
1003
|
-
|
|
1004
|
-
// @public (undocumented)
|
|
1005
|
-
type UiHoverCardDismissedEventProps = CommonEventProps & {
|
|
1006
|
-
previewDisplay: PreviewDisplay;
|
|
1007
|
-
hoverTime: number;
|
|
1008
|
-
previewInvokeMethod?: PreviewInvokeMethod;
|
|
1009
|
-
status: CardType;
|
|
1010
|
-
};
|
|
1011
|
-
|
|
1012
|
-
// @public (undocumented)
|
|
1013
|
-
type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
|
|
1014
|
-
previewDisplay: PreviewDisplay;
|
|
1015
|
-
previewInvokeMethod?: PreviewInvokeMethod;
|
|
1016
|
-
};
|
|
1017
|
-
|
|
1018
|
-
// @public (undocumented)
|
|
1019
|
-
type UiHoverCardViewedEventProps = CommonEventProps & {
|
|
1020
|
-
previewDisplay: PreviewDisplay;
|
|
1021
|
-
previewInvokeMethod?: PreviewInvokeMethod;
|
|
1022
|
-
status: CardType;
|
|
1023
|
-
};
|
|
1024
|
-
|
|
1025
|
-
// @public (undocumented)
|
|
1026
|
-
type UiIframeDwelledEventProps = CommonEventProps & {
|
|
1027
|
-
id: string;
|
|
1028
|
-
display: CardInnerAppearance;
|
|
1029
|
-
status: CardType;
|
|
1030
|
-
dwellTime: number;
|
|
1031
|
-
dwellPercentVisible: number;
|
|
1032
|
-
};
|
|
1033
|
-
|
|
1034
|
-
// @public (undocumented)
|
|
1035
|
-
type UiIframeFocusedEventProps = CommonEventProps & {
|
|
1036
|
-
id: string;
|
|
1037
|
-
display: CardInnerAppearance;
|
|
1038
|
-
status: CardType;
|
|
1039
|
-
};
|
|
1040
|
-
|
|
1041
|
-
// @public (undocumented)
|
|
1042
|
-
type UiRenderFailedEventProps = CommonEventProps & {
|
|
1043
|
-
display: CardInnerAppearance;
|
|
1044
|
-
error: Error;
|
|
1045
|
-
errorInfo: ErrorInfo;
|
|
1046
|
-
};
|
|
1047
|
-
|
|
1048
|
-
// @public (undocumented)
|
|
1049
|
-
type UiRenderSuccessEventProps = CommonEventProps & {
|
|
1050
|
-
display: CardInnerAppearance;
|
|
1051
|
-
status: CardType;
|
|
1052
|
-
canBeDatasource?: boolean;
|
|
1053
|
-
};
|
|
1054
|
-
|
|
1055
|
-
// @public (undocumented)
|
|
1056
|
-
type UiServerActionClickedEventProps = CommonEventProps & {
|
|
1057
|
-
smartLinkActionType: SmartLinkActionType;
|
|
1058
|
-
};
|
|
1059
|
-
|
|
1060
|
-
// @public @deprecated
|
|
1061
|
-
export const useSmartLinkAnalytics: (
|
|
1062
|
-
url: string,
|
|
1063
|
-
_dispatchAnalytics?: AnalyticsHandler,
|
|
1064
|
-
id?: string,
|
|
1065
|
-
defaultLocation?: string,
|
|
1066
|
-
) => {
|
|
1067
|
-
ui: {
|
|
1068
|
-
authEvent: ({
|
|
1069
|
-
display,
|
|
1070
|
-
extensionKey,
|
|
1071
|
-
definitionId,
|
|
1072
|
-
resourceType,
|
|
1073
|
-
destinationProduct,
|
|
1074
|
-
destinationSubproduct,
|
|
1075
|
-
location,
|
|
1076
|
-
}: UiAuthEventProps) => void;
|
|
1077
|
-
authAlternateAccountEvent: ({
|
|
1078
|
-
display,
|
|
1079
|
-
extensionKey,
|
|
1080
|
-
definitionId,
|
|
1081
|
-
resourceType,
|
|
1082
|
-
destinationProduct,
|
|
1083
|
-
destinationSubproduct,
|
|
1084
|
-
location,
|
|
1085
|
-
}: UiAuthAlternateAccountEventProps) => void;
|
|
1086
|
-
buttonClickedEvent: (
|
|
1087
|
-
data: Partial<AnalyticsPayload> & {
|
|
1088
|
-
actionSubjectId: Required<string>;
|
|
1089
|
-
},
|
|
1090
|
-
) => void;
|
|
1091
|
-
cardClickedEvent: ({
|
|
1092
|
-
id,
|
|
1093
|
-
display,
|
|
1094
|
-
status,
|
|
1095
|
-
definitionId,
|
|
1096
|
-
extensionKey,
|
|
1097
|
-
isModifierKeyPressed,
|
|
1098
|
-
location,
|
|
1099
|
-
destinationProduct,
|
|
1100
|
-
destinationSubproduct,
|
|
1101
|
-
actionSubjectId,
|
|
1102
|
-
}: UiCardClickedEventProps) => void;
|
|
1103
|
-
iframeDwelledEvent: ({
|
|
1104
|
-
id,
|
|
1105
|
-
display,
|
|
1106
|
-
status,
|
|
1107
|
-
definitionId,
|
|
1108
|
-
extensionKey,
|
|
1109
|
-
location,
|
|
1110
|
-
destinationProduct,
|
|
1111
|
-
destinationSubproduct,
|
|
1112
|
-
dwellTime,
|
|
1113
|
-
dwellPercentVisible,
|
|
1114
|
-
}: UiIframeDwelledEventProps) => void;
|
|
1115
|
-
iframeFocusedEvent: ({
|
|
1116
|
-
id,
|
|
1117
|
-
display,
|
|
1118
|
-
status,
|
|
1119
|
-
definitionId,
|
|
1120
|
-
extensionKey,
|
|
1121
|
-
location,
|
|
1122
|
-
destinationProduct,
|
|
1123
|
-
destinationSubproduct,
|
|
1124
|
-
}: UiIframeFocusedEventProps) => void;
|
|
1125
|
-
actionClickedEvent: ({
|
|
1126
|
-
id,
|
|
1127
|
-
actionType,
|
|
1128
|
-
display,
|
|
1129
|
-
extensionKey: overrideExtensionKey,
|
|
1130
|
-
definitionId,
|
|
1131
|
-
resourceType,
|
|
1132
|
-
destinationProduct,
|
|
1133
|
-
destinationSubproduct,
|
|
1134
|
-
location,
|
|
1135
|
-
}: UiActionClickedEventProps) => void;
|
|
1136
|
-
hoverCardOpenLinkClickedEvent: ({
|
|
1137
|
-
previewDisplay,
|
|
1138
|
-
definitionId,
|
|
1139
|
-
extensionKey,
|
|
1140
|
-
destinationProduct,
|
|
1141
|
-
destinationSubproduct,
|
|
1142
|
-
location,
|
|
1143
|
-
previewInvokeMethod,
|
|
1144
|
-
}: UiHoverCardOpenLinkClickedEventProps) => void;
|
|
1145
|
-
closedAuthEvent: ({
|
|
1146
|
-
display,
|
|
1147
|
-
extensionKey,
|
|
1148
|
-
definitionId,
|
|
1149
|
-
resourceType,
|
|
1150
|
-
destinationProduct,
|
|
1151
|
-
destinationSubproduct,
|
|
1152
|
-
location,
|
|
1153
|
-
}: UiClosedAuthEventProps) => void;
|
|
1154
|
-
modalClosedEvent: (
|
|
1155
|
-
data: Partial<AnalyticsPayload> & {
|
|
1156
|
-
actionSubjectId: Required<string>;
|
|
1157
|
-
},
|
|
1158
|
-
) => void;
|
|
1159
|
-
renderSuccessEvent: ({
|
|
1160
|
-
display,
|
|
1161
|
-
status,
|
|
1162
|
-
id,
|
|
1163
|
-
extensionKey,
|
|
1164
|
-
definitionId,
|
|
1165
|
-
resourceType,
|
|
1166
|
-
destinationProduct,
|
|
1167
|
-
destinationSubproduct,
|
|
1168
|
-
location,
|
|
1169
|
-
canBeDatasource,
|
|
1170
|
-
}: UiRenderSuccessEventProps) => void;
|
|
1171
|
-
renderFailedEvent: ({
|
|
1172
|
-
display,
|
|
1173
|
-
id,
|
|
1174
|
-
error,
|
|
1175
|
-
errorInfo,
|
|
1176
|
-
extensionKey,
|
|
1177
|
-
definitionId,
|
|
1178
|
-
resourceType,
|
|
1179
|
-
destinationProduct,
|
|
1180
|
-
destinationSubproduct,
|
|
1181
|
-
location,
|
|
1182
|
-
}: UiRenderFailedEventProps) => void;
|
|
1183
|
-
hoverCardViewedEvent: ({
|
|
1184
|
-
previewDisplay,
|
|
1185
|
-
previewInvokeMethod,
|
|
1186
|
-
id,
|
|
1187
|
-
extensionKey,
|
|
1188
|
-
definitionId,
|
|
1189
|
-
resourceType,
|
|
1190
|
-
destinationProduct,
|
|
1191
|
-
destinationSubproduct,
|
|
1192
|
-
location,
|
|
1193
|
-
status,
|
|
1194
|
-
}: UiHoverCardViewedEventProps) => void;
|
|
1195
|
-
hoverCardDismissedEvent: ({
|
|
1196
|
-
id,
|
|
1197
|
-
previewDisplay,
|
|
1198
|
-
hoverTime,
|
|
1199
|
-
previewInvokeMethod,
|
|
1200
|
-
extensionKey,
|
|
1201
|
-
definitionId,
|
|
1202
|
-
resourceType,
|
|
1203
|
-
destinationProduct,
|
|
1204
|
-
destinationSubproduct,
|
|
1205
|
-
location,
|
|
1206
|
-
status,
|
|
1207
|
-
}: UiHoverCardDismissedEventProps) => void;
|
|
1208
|
-
learnMoreClickedEvent: () => void;
|
|
1209
|
-
smartLinkLozengeActionClickedEvent: () => void;
|
|
1210
|
-
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
1211
|
-
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
1212
|
-
smartLinkServerActionClickedEvent: (props: UiServerActionClickedEventProps) => void;
|
|
1213
|
-
};
|
|
1214
|
-
operational: {
|
|
1215
|
-
invokeSucceededEvent: ({
|
|
1216
|
-
id,
|
|
1217
|
-
actionType,
|
|
1218
|
-
display,
|
|
1219
|
-
extensionKey,
|
|
1220
|
-
definitionId,
|
|
1221
|
-
resourceType,
|
|
1222
|
-
destinationProduct,
|
|
1223
|
-
destinationSubproduct,
|
|
1224
|
-
location,
|
|
1225
|
-
}: InvokeSucceededEventProps) => void;
|
|
1226
|
-
invokeFailedEvent: ({
|
|
1227
|
-
id,
|
|
1228
|
-
actionType,
|
|
1229
|
-
display,
|
|
1230
|
-
reason,
|
|
1231
|
-
extensionKey,
|
|
1232
|
-
definitionId,
|
|
1233
|
-
resourceType,
|
|
1234
|
-
destinationProduct,
|
|
1235
|
-
destinationSubproduct,
|
|
1236
|
-
location,
|
|
1237
|
-
}: InvokeFailedEventProps) => void;
|
|
1238
|
-
connectSucceededEvent: ({
|
|
1239
|
-
id,
|
|
1240
|
-
extensionKey,
|
|
1241
|
-
definitionId,
|
|
1242
|
-
resourceType,
|
|
1243
|
-
destinationProduct,
|
|
1244
|
-
destinationSubproduct,
|
|
1245
|
-
location,
|
|
1246
|
-
}: ConnectSucceededEventProps) => void;
|
|
1247
|
-
connectFailedEvent: ({
|
|
1248
|
-
id,
|
|
1249
|
-
reason,
|
|
1250
|
-
extensionKey,
|
|
1251
|
-
definitionId,
|
|
1252
|
-
resourceType,
|
|
1253
|
-
destinationProduct,
|
|
1254
|
-
destinationSubproduct,
|
|
1255
|
-
location,
|
|
1256
|
-
}: ConnectFailedEventProps) => void;
|
|
1257
|
-
instrument: ({
|
|
1258
|
-
id,
|
|
1259
|
-
status,
|
|
1260
|
-
extensionKey,
|
|
1261
|
-
definitionId,
|
|
1262
|
-
resourceType,
|
|
1263
|
-
destinationProduct,
|
|
1264
|
-
destinationSubproduct,
|
|
1265
|
-
location,
|
|
1266
|
-
error,
|
|
1267
|
-
}: InstrumentEventProps) => void;
|
|
1268
|
-
chunkloadFailedEvent: ({
|
|
1269
|
-
display,
|
|
1270
|
-
error,
|
|
1271
|
-
errorInfo,
|
|
1272
|
-
extensionKey,
|
|
1273
|
-
definitionId,
|
|
1274
|
-
resourceType,
|
|
1275
|
-
destinationProduct,
|
|
1276
|
-
destinationSubproduct,
|
|
1277
|
-
location,
|
|
1278
|
-
}: UiRenderFailedEventProps) => void;
|
|
1279
|
-
};
|
|
1280
|
-
track: {
|
|
1281
|
-
appAccountConnected: ({
|
|
1282
|
-
extensionKey,
|
|
1283
|
-
definitionId,
|
|
1284
|
-
resourceType,
|
|
1285
|
-
destinationProduct,
|
|
1286
|
-
destinationSubproduct,
|
|
1287
|
-
location,
|
|
1288
|
-
}: TrackAppAccountConnectedProps) => void;
|
|
1289
|
-
appAccountAuthStarted: ({ extensionKey, location }: TrackAppAccountConnectedProps) => void;
|
|
1290
|
-
linkUpdated: () => void;
|
|
1291
|
-
smartLinkQuickActionStarted: (props: {
|
|
1292
|
-
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
1293
|
-
}) => void;
|
|
1294
|
-
smartLinkQuickActionSuccess: (props: {
|
|
1295
|
-
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
1296
|
-
}) => void;
|
|
1297
|
-
smartLinkQuickActionFailed: (props: {
|
|
1298
|
-
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
1299
|
-
reason?: TrackQuickActionFailureReason;
|
|
1300
|
-
step?: string;
|
|
1301
|
-
}) => void;
|
|
1302
|
-
hoverCardResolutionStarted: () => void;
|
|
1303
|
-
};
|
|
1304
|
-
screen: {
|
|
1305
|
-
authPopupEvent: ({
|
|
1306
|
-
extensionKey,
|
|
1307
|
-
definitionId,
|
|
1308
|
-
resourceType,
|
|
1309
|
-
destinationProduct,
|
|
1310
|
-
destinationSubproduct,
|
|
1311
|
-
location,
|
|
1312
|
-
}: ScreenAuthPopupEventProps) => void;
|
|
1313
|
-
modalViewedEvent: (
|
|
1314
|
-
data: Partial<AnalyticsPayload> & {
|
|
1315
|
-
name: Extract<AnalyticsName, 'embedPreviewModal'>;
|
|
1316
|
-
},
|
|
1317
|
-
) => void;
|
|
1318
|
-
};
|
|
1319
|
-
};
|
|
1320
|
-
|
|
1321
|
-
// @public (undocumented)
|
|
1322
|
-
export function useSmartLinkEvents(): SmartLinkEvents;
|
|
1323
|
-
|
|
1324
|
-
// @public
|
|
1325
|
-
type ViewCount = {
|
|
1326
|
-
name: ElementName.ViewCount;
|
|
1327
|
-
};
|
|
1328
|
-
|
|
1329
|
-
// @public
|
|
1330
|
-
type VoteCount = {
|
|
1331
|
-
name: ElementName.VoteCount;
|
|
1332
|
-
};
|
|
1333
|
-
|
|
1334
|
-
// (No @packageDocumentation comment for this package)
|
|
1335
|
-
```
|
|
1336
|
-
|
|
1337
|
-
<!--SECTION END: Main Entry Types-->
|
|
1338
|
-
|
|
1339
|
-
### Peer Dependencies
|
|
1340
|
-
|
|
1341
|
-
<!--SECTION START: Peer Dependencies-->
|
|
1342
|
-
|
|
1343
|
-
```json
|
|
1344
|
-
{
|
|
1345
|
-
"@atlaskit/link-provider": "^1.6.4",
|
|
1346
|
-
"react": "^16.8.0",
|
|
1347
|
-
"react-dom": "^16.8.0",
|
|
1348
|
-
"react-intl": "npm:react-intl@^5.18.1"
|
|
1349
|
-
}
|
|
1350
|
-
```
|
|
1351
|
-
|
|
1352
|
-
<!--SECTION END: Peer Dependencies-->
|