@atlaskit/smart-card 26.9.13 → 26.9.15
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 +12 -0
- package/dist/cjs/version.json +1 -1
- package/dist/cjs/view/HoverCard/components/HoverCardComponent.js +0 -1
- package/dist/cjs/view/HoverCard/components/HoverCardContent.js +1 -21
- package/dist/es2019/version.json +1 -1
- package/dist/es2019/view/HoverCard/components/HoverCardComponent.js +0 -1
- package/dist/es2019/view/HoverCard/components/HoverCardContent.js +1 -21
- package/dist/esm/version.json +1 -1
- package/dist/esm/view/HoverCard/components/HoverCardComponent.js +0 -1
- package/dist/esm/view/HoverCard/components/HoverCardContent.js +1 -21
- package/dist/types/view/HoverCard/types.d.ts +0 -1
- package/dist/types-ts4.5/view/HoverCard/types.d.ts +0 -1
- package/package.json +3 -7
- package/tmp/api-report-tmp.d.ts +937 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @atlaskit/smart-card
|
|
2
2
|
|
|
3
|
+
## 26.9.15
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`b9355830504`](https://bitbucket.org/atlassian/atlassian-frontend/commits/b9355830504) - Opt out of peer dependency enforcement
|
|
8
|
+
|
|
9
|
+
## 26.9.14
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`08c372c1547`](https://bitbucket.org/atlassian/atlassian-frontend/commits/08c372c1547) - [ux] Revert of functionality added in 26.9.8
|
|
14
|
+
|
|
3
15
|
## 26.9.13
|
|
4
16
|
|
|
5
17
|
### Patch Changes
|
package/dist/cjs/version.json
CHANGED
|
@@ -185,7 +185,6 @@ var HoverCardComponent = function HoverCardComponent(_ref) {
|
|
|
185
185
|
var hoverCardContentProps = {
|
|
186
186
|
onMouseEnter: initShowCard,
|
|
187
187
|
onMouseLeave: initHideCard,
|
|
188
|
-
onWheel: initHideCard,
|
|
189
188
|
cardActions: filteredActions,
|
|
190
189
|
cardState: linkState,
|
|
191
190
|
onActionClick: onActionClick,
|
|
@@ -80,7 +80,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
80
80
|
url = _ref.url,
|
|
81
81
|
onMouseEnter = _ref.onMouseEnter,
|
|
82
82
|
onMouseLeave = _ref.onMouseLeave,
|
|
83
|
-
onWheel = _ref.onWheel,
|
|
84
83
|
showServerActions = _ref.showServerActions;
|
|
85
84
|
var useLozengeAction = (0, _linkProvider.useFeatureFlag)('useLozengeAction');
|
|
86
85
|
var _useAnalyticsEvents = (0, _analyticsNext.useAnalyticsEvents)(),
|
|
@@ -94,7 +93,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
94
93
|
var linkStatus = (_linkState$status = linkState.status) !== null && _linkState$status !== void 0 ? _linkState$status : 'pending';
|
|
95
94
|
var statusRef = (0, _react2.useRef)(linkStatus);
|
|
96
95
|
var analyticsRef = (0, _react2.useRef)(analytics);
|
|
97
|
-
var wrapperRef = (0, _react2.useRef)(null);
|
|
98
96
|
(0, _react2.useEffect)(function () {
|
|
99
97
|
/**
|
|
100
98
|
* Must access current analytics object value via ref because its not stable
|
|
@@ -126,22 +124,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
126
124
|
});
|
|
127
125
|
};
|
|
128
126
|
}, []);
|
|
129
|
-
(0, _react2.useEffect)(function () {
|
|
130
|
-
var wrapperRefValue = null;
|
|
131
|
-
if (wrapperRef.current && onWheel) {
|
|
132
|
-
// Detect wheel even on hover card content to close hover card
|
|
133
|
-
// Add event listener through ref because we want it to execute only once.
|
|
134
|
-
wrapperRef.current.addEventListener('wheel', onWheel, {
|
|
135
|
-
once: true
|
|
136
|
-
});
|
|
137
|
-
wrapperRefValue = wrapperRef.current;
|
|
138
|
-
}
|
|
139
|
-
return function () {
|
|
140
|
-
if (wrapperRefValue && onWheel) {
|
|
141
|
-
wrapperRefValue.removeEventListener('wheel', onWheel);
|
|
142
|
-
}
|
|
143
|
-
};
|
|
144
|
-
}, [onWheel]);
|
|
145
127
|
var onClick = (0, _react2.useCallback)(function (event) {
|
|
146
128
|
var isModifierKeyPressed = (0, _utils.isSpecialEvent)(event);
|
|
147
129
|
analytics.ui.cardClickedEvent({
|
|
@@ -217,13 +199,11 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
217
199
|
};
|
|
218
200
|
var cardView = getCardView(cardState);
|
|
219
201
|
return cardView ? (0, _react.jsx)("div", {
|
|
220
|
-
"data-testid": "hover-card-content",
|
|
221
202
|
onMouseEnter: onMouseEnter,
|
|
222
203
|
onMouseLeave: onMouseLeave,
|
|
223
204
|
onClick: onClickStopPropagation,
|
|
224
205
|
className: hoverCardClassName,
|
|
225
|
-
css: _styled.HoverCardContainer
|
|
226
|
-
ref: wrapperRef
|
|
206
|
+
css: _styled.HoverCardContainer
|
|
227
207
|
}, cardView) : null;
|
|
228
208
|
};
|
|
229
209
|
var _default = HoverCardContent;
|
package/dist/es2019/version.json
CHANGED
|
@@ -41,7 +41,6 @@ const HoverCardContent = ({
|
|
|
41
41
|
url,
|
|
42
42
|
onMouseEnter,
|
|
43
43
|
onMouseLeave,
|
|
44
|
-
onWheel,
|
|
45
44
|
showServerActions
|
|
46
45
|
}) => {
|
|
47
46
|
var _linkState$status, _cardState$details;
|
|
@@ -56,7 +55,6 @@ const HoverCardContent = ({
|
|
|
56
55
|
const linkStatus = (_linkState$status = linkState.status) !== null && _linkState$status !== void 0 ? _linkState$status : 'pending';
|
|
57
56
|
const statusRef = useRef(linkStatus);
|
|
58
57
|
const analyticsRef = useRef(analytics);
|
|
59
|
-
const wrapperRef = useRef(null);
|
|
60
58
|
useEffect(() => {
|
|
61
59
|
/**
|
|
62
60
|
* Must access current analytics object value via ref because its not stable
|
|
@@ -88,22 +86,6 @@ const HoverCardContent = ({
|
|
|
88
86
|
});
|
|
89
87
|
};
|
|
90
88
|
}, []);
|
|
91
|
-
useEffect(() => {
|
|
92
|
-
let wrapperRefValue = null;
|
|
93
|
-
if (wrapperRef.current && onWheel) {
|
|
94
|
-
// Detect wheel even on hover card content to close hover card
|
|
95
|
-
// Add event listener through ref because we want it to execute only once.
|
|
96
|
-
wrapperRef.current.addEventListener('wheel', onWheel, {
|
|
97
|
-
once: true
|
|
98
|
-
});
|
|
99
|
-
wrapperRefValue = wrapperRef.current;
|
|
100
|
-
}
|
|
101
|
-
return () => {
|
|
102
|
-
if (wrapperRefValue && onWheel) {
|
|
103
|
-
wrapperRefValue.removeEventListener('wheel', onWheel);
|
|
104
|
-
}
|
|
105
|
-
};
|
|
106
|
-
}, [onWheel]);
|
|
107
89
|
const onClick = useCallback(event => {
|
|
108
90
|
const isModifierKeyPressed = isSpecialEvent(event);
|
|
109
91
|
analytics.ui.cardClickedEvent({
|
|
@@ -176,13 +158,11 @@ const HoverCardContent = ({
|
|
|
176
158
|
};
|
|
177
159
|
const cardView = getCardView(cardState);
|
|
178
160
|
return cardView ? jsx("div", {
|
|
179
|
-
"data-testid": "hover-card-content",
|
|
180
161
|
onMouseEnter: onMouseEnter,
|
|
181
162
|
onMouseLeave: onMouseLeave,
|
|
182
163
|
onClick: onClickStopPropagation,
|
|
183
164
|
className: hoverCardClassName,
|
|
184
|
-
css: HoverCardContainer
|
|
185
|
-
ref: wrapperRef
|
|
165
|
+
css: HoverCardContainer
|
|
186
166
|
}, cardView) : null;
|
|
187
167
|
};
|
|
188
168
|
export default HoverCardContent;
|
package/dist/esm/version.json
CHANGED
|
@@ -174,7 +174,6 @@ export var HoverCardComponent = function HoverCardComponent(_ref) {
|
|
|
174
174
|
var hoverCardContentProps = {
|
|
175
175
|
onMouseEnter: initShowCard,
|
|
176
176
|
onMouseLeave: initHideCard,
|
|
177
|
-
onWheel: initHideCard,
|
|
178
177
|
cardActions: filteredActions,
|
|
179
178
|
cardState: linkState,
|
|
180
179
|
onActionClick: onActionClick,
|
|
@@ -67,7 +67,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
67
67
|
url = _ref.url,
|
|
68
68
|
onMouseEnter = _ref.onMouseEnter,
|
|
69
69
|
onMouseLeave = _ref.onMouseLeave,
|
|
70
|
-
onWheel = _ref.onWheel,
|
|
71
70
|
showServerActions = _ref.showServerActions;
|
|
72
71
|
var useLozengeAction = useFeatureFlag('useLozengeAction');
|
|
73
72
|
var _useAnalyticsEvents = useAnalyticsEvents(),
|
|
@@ -81,7 +80,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
81
80
|
var linkStatus = (_linkState$status = linkState.status) !== null && _linkState$status !== void 0 ? _linkState$status : 'pending';
|
|
82
81
|
var statusRef = useRef(linkStatus);
|
|
83
82
|
var analyticsRef = useRef(analytics);
|
|
84
|
-
var wrapperRef = useRef(null);
|
|
85
83
|
useEffect(function () {
|
|
86
84
|
/**
|
|
87
85
|
* Must access current analytics object value via ref because its not stable
|
|
@@ -113,22 +111,6 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
113
111
|
});
|
|
114
112
|
};
|
|
115
113
|
}, []);
|
|
116
|
-
useEffect(function () {
|
|
117
|
-
var wrapperRefValue = null;
|
|
118
|
-
if (wrapperRef.current && onWheel) {
|
|
119
|
-
// Detect wheel even on hover card content to close hover card
|
|
120
|
-
// Add event listener through ref because we want it to execute only once.
|
|
121
|
-
wrapperRef.current.addEventListener('wheel', onWheel, {
|
|
122
|
-
once: true
|
|
123
|
-
});
|
|
124
|
-
wrapperRefValue = wrapperRef.current;
|
|
125
|
-
}
|
|
126
|
-
return function () {
|
|
127
|
-
if (wrapperRefValue && onWheel) {
|
|
128
|
-
wrapperRefValue.removeEventListener('wheel', onWheel);
|
|
129
|
-
}
|
|
130
|
-
};
|
|
131
|
-
}, [onWheel]);
|
|
132
114
|
var onClick = useCallback(function (event) {
|
|
133
115
|
var isModifierKeyPressed = isSpecialEvent(event);
|
|
134
116
|
analytics.ui.cardClickedEvent({
|
|
@@ -204,13 +186,11 @@ var HoverCardContent = function HoverCardContent(_ref) {
|
|
|
204
186
|
};
|
|
205
187
|
var cardView = getCardView(cardState);
|
|
206
188
|
return cardView ? jsx("div", {
|
|
207
|
-
"data-testid": "hover-card-content",
|
|
208
189
|
onMouseEnter: onMouseEnter,
|
|
209
190
|
onMouseLeave: onMouseLeave,
|
|
210
191
|
onClick: onClickStopPropagation,
|
|
211
192
|
className: hoverCardClassName,
|
|
212
|
-
css: HoverCardContainer
|
|
213
|
-
ref: wrapperRef
|
|
193
|
+
css: HoverCardContainer
|
|
214
194
|
}, cardView) : null;
|
|
215
195
|
};
|
|
216
196
|
export default HoverCardContent;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/smart-card",
|
|
3
|
-
"version": "26.9.
|
|
3
|
+
"version": "26.9.15",
|
|
4
4
|
"description": "Smart card component",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -28,7 +28,6 @@
|
|
|
28
28
|
"@atlaskit/avatar-group": "^9.3.0",
|
|
29
29
|
"@atlaskit/button": "^16.8.0",
|
|
30
30
|
"@atlaskit/dropdown-menu": "^11.10.0",
|
|
31
|
-
"@atlaskit/enforce-peer-dependencies": "^1.0.1",
|
|
32
31
|
"@atlaskit/frontend-utilities": "^2.7.0",
|
|
33
32
|
"@atlaskit/icon": "^21.12.0",
|
|
34
33
|
"@atlaskit/icon-file-type": "^6.4.0",
|
|
@@ -75,7 +74,7 @@
|
|
|
75
74
|
"@af/visual-regression": "*",
|
|
76
75
|
"@atlaskit/avatar": "^21.3.0",
|
|
77
76
|
"@atlaskit/css-reset": "^6.5.0",
|
|
78
|
-
"@atlaskit/link-test-helpers": "^4.
|
|
77
|
+
"@atlaskit/link-test-helpers": "^4.2.0",
|
|
79
78
|
"@atlaskit/lozenge": "^11.4.0",
|
|
80
79
|
"@atlaskit/media-integration-test-helpers": "^3.0.0",
|
|
81
80
|
"@atlaskit/media-test-helpers": "^33.0.0",
|
|
@@ -145,8 +144,5 @@
|
|
|
145
144
|
"type": "boolean"
|
|
146
145
|
}
|
|
147
146
|
},
|
|
148
|
-
"prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
|
|
149
|
-
"scripts": {
|
|
150
|
-
"postinstall": "npx enforce-peer-dependencies --internal-packages"
|
|
151
|
-
}
|
|
147
|
+
"prettier": "@atlassian/atlassian-frontend-prettier-config-1.0.1"
|
|
152
148
|
}
|
|
@@ -0,0 +1,937 @@
|
|
|
1
|
+
## API Report File for "@atlaskit/smart-card"
|
|
2
|
+
|
|
3
|
+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
4
|
+
|
|
5
|
+
```ts
|
|
6
|
+
|
|
7
|
+
/// <reference types="react" />
|
|
8
|
+
|
|
9
|
+
import { APIError } from '@atlaskit/linking-common';
|
|
10
|
+
import { Appearance } from '@atlaskit/button/types';
|
|
11
|
+
import { BlockCardAdf } from '@atlaskit/linking-common';
|
|
12
|
+
import { CardAdf } from '@atlaskit/linking-common';
|
|
13
|
+
import { CardAppearance } from '@atlaskit/linking-common';
|
|
14
|
+
import { CardContext } from '@atlaskit/link-provider';
|
|
15
|
+
import { CardPlatform } from '@atlaskit/link-extractors';
|
|
16
|
+
import { CardType } from '@atlaskit/linking-common';
|
|
17
|
+
import { CardClient as Client } from '@atlaskit/link-provider';
|
|
18
|
+
import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
|
|
19
|
+
import { DatasourceAdf } from '@atlaskit/linking-common';
|
|
20
|
+
import { DatasourceAdfView } from '@atlaskit/linking-common';
|
|
21
|
+
import { EditorCardProvider } from '@atlaskit/link-provider';
|
|
22
|
+
import { editorCardProvider } from '@atlaskit/link-provider';
|
|
23
|
+
import { EmbedCardAdf } from '@atlaskit/linking-common';
|
|
24
|
+
import { ErrorInfo } from 'react';
|
|
25
|
+
import { GasPayload } from '@atlaskit/analytics-gas-types';
|
|
26
|
+
import { InlineCardAdf } from '@atlaskit/linking-common';
|
|
27
|
+
import { JsonLd } from 'json-ld-types';
|
|
28
|
+
import { MessageDescriptor } from 'react-intl-next';
|
|
29
|
+
import { SmartCardProvider as Provider } from '@atlaskit/link-provider';
|
|
30
|
+
import { ProviderProps } from '@atlaskit/link-provider';
|
|
31
|
+
import { default as React_2 } from 'react';
|
|
32
|
+
import { ReactChild } from 'react';
|
|
33
|
+
import { Ref } from 'react';
|
|
34
|
+
import { SerializedStyles } from '@emotion/react';
|
|
35
|
+
import { SmartCardContext } from '@atlaskit/link-provider';
|
|
36
|
+
import { SmartLinkActionType } from '@atlaskit/linking-types';
|
|
37
|
+
import { WithAnalyticsEventsProps } from '@atlaskit/analytics-next';
|
|
38
|
+
import { WithContextProps } from '@atlaskit/analytics-next';
|
|
39
|
+
import { WithIntlProps } from 'react-intl-next';
|
|
40
|
+
import { WrappedComponentProps } from 'react-intl-next';
|
|
41
|
+
|
|
42
|
+
// @public (undocumented)
|
|
43
|
+
export type ActionItem = CustomActionItem | NamedActionItem | NamedDataActionItem;
|
|
44
|
+
|
|
45
|
+
// @public
|
|
46
|
+
export enum ActionName {
|
|
47
|
+
// (undocumented)
|
|
48
|
+
CustomAction = "CustomAction",
|
|
49
|
+
// (undocumented)
|
|
50
|
+
DeleteAction = "DeleteAction",
|
|
51
|
+
// (undocumented)
|
|
52
|
+
DownloadAction = "DownloadAction",
|
|
53
|
+
// (undocumented)
|
|
54
|
+
EditAction = "EditAction",
|
|
55
|
+
// (undocumented)
|
|
56
|
+
PreviewAction = "PreviewAction",
|
|
57
|
+
// (undocumented)
|
|
58
|
+
ViewAction = "ViewAction"
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
// @public (undocumented)
|
|
62
|
+
type ActionProps = {
|
|
63
|
+
size?: SmartLinkSize;
|
|
64
|
+
content?: React.ReactNode;
|
|
65
|
+
appearance?: Appearance;
|
|
66
|
+
onClick: () => any;
|
|
67
|
+
icon?: ReactChild;
|
|
68
|
+
iconPosition?: 'after' | 'before';
|
|
69
|
+
tooltipMessage?: React.ReactNode;
|
|
70
|
+
asDropDownItem?: boolean;
|
|
71
|
+
overrideCss?: SerializedStyles;
|
|
72
|
+
testId?: string;
|
|
73
|
+
};
|
|
74
|
+
|
|
75
|
+
// @public (undocumented)
|
|
76
|
+
export type AnalyticsAction = 'authStarted' | 'chunkLoadFailed' | 'clicked' | 'closed' | 'connectFailed' | 'connectSucceeded' | 'connected' | 'created' | 'dismissed' | 'dwelled' | 'failed' | 'focused' | 'inserted' | 'renderFailed' | 'renderSuccess' | 'renderWithStatus' | 'resolved' | 'started' | 'success' | 'unresolved' | 'updated' | 'viewed';
|
|
77
|
+
|
|
78
|
+
// @public (undocumented)
|
|
79
|
+
export type AnalyticsActionSubject = 'applicationAccount' | 'button' | 'consentModal' | 'embedPreviewModal' | 'hoverCard' | 'link' | 'modal' | 'smartLink' | 'smartLinkAction' | 'smartLinkIframe' | 'smartLinkQuickAction';
|
|
80
|
+
|
|
81
|
+
// @public (undocumented)
|
|
82
|
+
type AnalyticsFacade = ReturnType<typeof useSmartLinkAnalytics>;
|
|
83
|
+
|
|
84
|
+
// @public (undocumented)
|
|
85
|
+
export type AnalyticsHandler = (event: AnalyticsPayload) => void;
|
|
86
|
+
|
|
87
|
+
// @public (undocumented)
|
|
88
|
+
type AnalyticsName = 'embedPreviewModal';
|
|
89
|
+
|
|
90
|
+
// @public (undocumented)
|
|
91
|
+
export type AnalyticsPayload = GasPayload & {
|
|
92
|
+
action?: AnalyticsAction;
|
|
93
|
+
actionSubject: AnalyticsActionSubject;
|
|
94
|
+
attributes: GasPayload['attributes'] & {
|
|
95
|
+
display?: CardInnerAppearance;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
// @public (undocumented)
|
|
100
|
+
type AnchorTarget = '_blank' | '_parent' | '_self' | '_top';
|
|
101
|
+
|
|
102
|
+
export { APIError }
|
|
103
|
+
|
|
104
|
+
// @public
|
|
105
|
+
type AttachmentCount = {
|
|
106
|
+
name: ElementName.AttachmentCount;
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
// @public
|
|
110
|
+
type AuthorGroup = {
|
|
111
|
+
name: ElementName.AuthorGroup;
|
|
112
|
+
};
|
|
113
|
+
|
|
114
|
+
// @public
|
|
115
|
+
type BaseActionItem = {
|
|
116
|
+
hideContent?: boolean;
|
|
117
|
+
hideIcon?: boolean;
|
|
118
|
+
name: ActionName;
|
|
119
|
+
onClick: () => any;
|
|
120
|
+
overrideCss?: SerializedStyles;
|
|
121
|
+
size?: SmartLinkSize;
|
|
122
|
+
testId?: string;
|
|
123
|
+
};
|
|
124
|
+
|
|
125
|
+
// @public
|
|
126
|
+
type BaseDataActionItem = {
|
|
127
|
+
hideContent?: boolean;
|
|
128
|
+
hideIcon?: boolean;
|
|
129
|
+
name: ActionName;
|
|
130
|
+
onClick?: () => any;
|
|
131
|
+
overrideCss?: SerializedStyles;
|
|
132
|
+
size?: SmartLinkSize;
|
|
133
|
+
testId?: string;
|
|
134
|
+
};
|
|
135
|
+
|
|
136
|
+
export { BlockCardAdf }
|
|
137
|
+
|
|
138
|
+
// @public (undocumented)
|
|
139
|
+
export const blockCardContentClassName = "block-card-content";
|
|
140
|
+
|
|
141
|
+
// @public (undocumented)
|
|
142
|
+
export const blockCardContentHeaderClassName = "block-card-content-header";
|
|
143
|
+
|
|
144
|
+
// @public (undocumented)
|
|
145
|
+
export const blockCardContentHeaderNameClassName = "block-card-content-header-name";
|
|
146
|
+
|
|
147
|
+
// @public (undocumented)
|
|
148
|
+
export const blockCardErroredViewClassName = "block-card-errored-view";
|
|
149
|
+
|
|
150
|
+
// @public (undocumented)
|
|
151
|
+
export const blockCardForbiddenViewClassName = "block-card-forbidden-view";
|
|
152
|
+
|
|
153
|
+
// @public (undocumented)
|
|
154
|
+
export const blockCardForbiddenViewLinkClassName = "block-card-forbidden-view-link";
|
|
155
|
+
|
|
156
|
+
// @public (undocumented)
|
|
157
|
+
export const blockCardIconImageClassName = "block-card-icon-image";
|
|
158
|
+
|
|
159
|
+
// @public (undocumented)
|
|
160
|
+
export const blockCardNotFoundViewClassName = "block-card-not-found-view";
|
|
161
|
+
|
|
162
|
+
// @public (undocumented)
|
|
163
|
+
export const blockCardResolvedViewByClassName = "block-card-resolved-view-by";
|
|
164
|
+
|
|
165
|
+
// @public (undocumented)
|
|
166
|
+
export const blockCardResolvedViewClassName = "block-card-resolved-view";
|
|
167
|
+
|
|
168
|
+
// @public (undocumented)
|
|
169
|
+
export const blockCardResolvingViewClassName = "block-card-resolving-view";
|
|
170
|
+
|
|
171
|
+
// @public (undocumented)
|
|
172
|
+
type BlockProps = {
|
|
173
|
+
direction?: SmartLinkDirection;
|
|
174
|
+
overrideCss?: SerializedStyles;
|
|
175
|
+
size?: SmartLinkSize;
|
|
176
|
+
status?: SmartLinkStatus;
|
|
177
|
+
testId?: string;
|
|
178
|
+
blockRef?: Ref<HTMLDivElement>;
|
|
179
|
+
onRender?: () => void;
|
|
180
|
+
onTransitionEnd?: () => void;
|
|
181
|
+
};
|
|
182
|
+
|
|
183
|
+
// @public (undocumented)
|
|
184
|
+
export const Card: React_2.ForwardRefExoticComponent<Pick<Omit<React_2.PropsWithChildren<WithIntlProps<CardProps & WrappedComponentProps<"intl">>>, keyof WithAnalyticsEventsProps> & React_2.RefAttributes<any> & WithContextProps, "analyticsContext" | "analyticsEvents" | "appearance" | "children" | "container" | "data" | "embedIframeRef" | "embedIframeUrlType" | "fallbackComponent" | "forwardedRef" | "frameStyle" | "id" | "importer" | "inheritDimensions" | "inlinePreloaderStyle" | "isFrameVisible" | "isSelected" | "key" | "onClick" | "onError" | "onResolve" | "placeholder" | "platform" | "showActions" | "showAuthTooltip" | "showHoverPreview" | "showServerActions" | "testId" | "ui" | "url"> & React_2.RefAttributes<any>>;
|
|
185
|
+
|
|
186
|
+
export { CardAdf }
|
|
187
|
+
|
|
188
|
+
export { CardAppearance }
|
|
189
|
+
|
|
190
|
+
export { CardContext }
|
|
191
|
+
|
|
192
|
+
// @public (undocumented)
|
|
193
|
+
type CardInnerAppearance = 'embedPreview' | 'flexible' | 'hoverCardPreview' | CardAppearance;
|
|
194
|
+
|
|
195
|
+
export { CardPlatform }
|
|
196
|
+
|
|
197
|
+
// @public (undocumented)
|
|
198
|
+
export interface CardProps extends WithAnalyticsEventsProps {
|
|
199
|
+
// @deprecated (undocumented)
|
|
200
|
+
analyticsEvents?: AnalyticsFacade;
|
|
201
|
+
// (undocumented)
|
|
202
|
+
appearance: CardAppearance;
|
|
203
|
+
// (undocumented)
|
|
204
|
+
children?: React.ReactNode;
|
|
205
|
+
// (undocumented)
|
|
206
|
+
container?: HTMLElement;
|
|
207
|
+
// @deprecated (undocumented)
|
|
208
|
+
data?: any;
|
|
209
|
+
// (undocumented)
|
|
210
|
+
embedIframeRef?: React.Ref<HTMLIFrameElement>;
|
|
211
|
+
// (undocumented)
|
|
212
|
+
embedIframeUrlType?: EmbedIframeUrlType;
|
|
213
|
+
fallbackComponent?: React.ComponentType;
|
|
214
|
+
frameStyle?: FrameStyle;
|
|
215
|
+
// (undocumented)
|
|
216
|
+
id?: string;
|
|
217
|
+
// (undocumented)
|
|
218
|
+
importer?: (target: any) => void;
|
|
219
|
+
inheritDimensions?: boolean;
|
|
220
|
+
// (undocumented)
|
|
221
|
+
inlinePreloaderStyle?: InlinePreloaderStyle;
|
|
222
|
+
// @deprecated (undocumented)
|
|
223
|
+
isFrameVisible?: boolean;
|
|
224
|
+
// (undocumented)
|
|
225
|
+
isSelected?: boolean;
|
|
226
|
+
// (undocumented)
|
|
227
|
+
onClick?: React.EventHandler<React.KeyboardEvent | React.MouseEvent>;
|
|
228
|
+
onError?: OnErrorCallback;
|
|
229
|
+
// (undocumented)
|
|
230
|
+
onResolve?: OnResolveCallback;
|
|
231
|
+
// (undocumented)
|
|
232
|
+
placeholder?: string;
|
|
233
|
+
// (undocumented)
|
|
234
|
+
platform?: CardPlatform;
|
|
235
|
+
showActions?: boolean;
|
|
236
|
+
// (undocumented)
|
|
237
|
+
showAuthTooltip?: boolean;
|
|
238
|
+
// (undocumented)
|
|
239
|
+
showHoverPreview?: boolean;
|
|
240
|
+
showServerActions?: boolean;
|
|
241
|
+
// (undocumented)
|
|
242
|
+
testId?: string;
|
|
243
|
+
// (undocumented)
|
|
244
|
+
ui?: FlexibleUiOptions;
|
|
245
|
+
// (undocumented)
|
|
246
|
+
url?: string;
|
|
247
|
+
}
|
|
248
|
+
|
|
249
|
+
export { CardType }
|
|
250
|
+
|
|
251
|
+
// @public
|
|
252
|
+
type ChecklistProgress = {
|
|
253
|
+
name: ElementName.ChecklistProgress;
|
|
254
|
+
};
|
|
255
|
+
|
|
256
|
+
export { Client }
|
|
257
|
+
|
|
258
|
+
// @public
|
|
259
|
+
type CollaboratorGroup = {
|
|
260
|
+
name: ElementName.CollaboratorGroup;
|
|
261
|
+
};
|
|
262
|
+
|
|
263
|
+
// @public
|
|
264
|
+
type CommentCount = {
|
|
265
|
+
name: ElementName.CommentCount;
|
|
266
|
+
};
|
|
267
|
+
|
|
268
|
+
// @public (undocumented)
|
|
269
|
+
interface CommonEventProps {
|
|
270
|
+
// (undocumented)
|
|
271
|
+
definitionId?: string;
|
|
272
|
+
// (undocumented)
|
|
273
|
+
destinatinoObjectType?: string;
|
|
274
|
+
// (undocumented)
|
|
275
|
+
destinationProduct?: DestinationProduct | string;
|
|
276
|
+
// (undocumented)
|
|
277
|
+
destinationSubproduct?: DestinationSubproduct | string;
|
|
278
|
+
// (undocumented)
|
|
279
|
+
extensionKey?: string;
|
|
280
|
+
// (undocumented)
|
|
281
|
+
id?: string;
|
|
282
|
+
// (undocumented)
|
|
283
|
+
location?: string;
|
|
284
|
+
// (undocumented)
|
|
285
|
+
resourceType?: string;
|
|
286
|
+
// (undocumented)
|
|
287
|
+
statusDetails?: string;
|
|
288
|
+
}
|
|
289
|
+
|
|
290
|
+
// @public (undocumented)
|
|
291
|
+
type ConnectFailedEventProps = CommonEventProps & {
|
|
292
|
+
id?: string;
|
|
293
|
+
reason?: string;
|
|
294
|
+
};
|
|
295
|
+
|
|
296
|
+
// @public (undocumented)
|
|
297
|
+
type ConnectSucceededEventProps = CommonEventProps & {
|
|
298
|
+
id?: string;
|
|
299
|
+
};
|
|
300
|
+
|
|
301
|
+
// @public (undocumented)
|
|
302
|
+
export const contentFooterClassName = "smart-link-content-footer";
|
|
303
|
+
|
|
304
|
+
// @public
|
|
305
|
+
type CreatedBy = {
|
|
306
|
+
name: ElementName.CreatedBy;
|
|
307
|
+
};
|
|
308
|
+
|
|
309
|
+
// @public
|
|
310
|
+
type CreatedOn = {
|
|
311
|
+
name: ElementName.CreatedOn;
|
|
312
|
+
text?: string;
|
|
313
|
+
};
|
|
314
|
+
|
|
315
|
+
// @public
|
|
316
|
+
type CustomActionItem = BaseActionItem & {
|
|
317
|
+
name: ActionName.CustomAction;
|
|
318
|
+
} & (((Required<Pick<ActionProps, 'content'>> & Pick<ActionProps, 'icon' | 'iconPosition'>) & Pick<ActionProps, 'tooltipMessage'>) | (Required<Pick<ActionProps, 'icon' | 'iconPosition'>> & Pick<ActionProps, 'content'>));
|
|
319
|
+
|
|
320
|
+
export { DatasourceAdf }
|
|
321
|
+
|
|
322
|
+
export { DatasourceAdfView }
|
|
323
|
+
|
|
324
|
+
// @public (undocumented)
|
|
325
|
+
type DestinationProduct = 'bitbucket' | 'confluence' | 'jira' | 'trello';
|
|
326
|
+
|
|
327
|
+
// @public (undocumented)
|
|
328
|
+
type DestinationSubproduct = 'core' | 'servicedesk' | 'software';
|
|
329
|
+
|
|
330
|
+
// @public
|
|
331
|
+
type DueOn = {
|
|
332
|
+
name: ElementName.DueOn;
|
|
333
|
+
};
|
|
334
|
+
|
|
335
|
+
export { EditorCardProvider }
|
|
336
|
+
|
|
337
|
+
export { editorCardProvider }
|
|
338
|
+
|
|
339
|
+
// @public
|
|
340
|
+
export type ElementItem = {
|
|
341
|
+
overrideCss?: SerializedStyles;
|
|
342
|
+
size?: SmartLinkSize;
|
|
343
|
+
testId?: string;
|
|
344
|
+
} & ElementItemProps;
|
|
345
|
+
|
|
346
|
+
// @public
|
|
347
|
+
type ElementItemProps = AttachmentCount | AuthorGroup | ChecklistProgress | CollaboratorGroup | CommentCount | CreatedBy | CreatedOn | DueOn | LatestCommit | LinkIcon | Location_2 | ModifiedBy | ModifiedOn | OwnedBy | Preview | Priority | ProgrammingLanguage | Provider_2 | ReactCount | Snippet | SourceBranch | State_2 | SubscriberCount | TargetBranch | Title | ViewCount | VoteCount;
|
|
348
|
+
|
|
349
|
+
// @public
|
|
350
|
+
export enum ElementName {
|
|
351
|
+
// (undocumented)
|
|
352
|
+
AttachmentCount = "AttachmentCount",
|
|
353
|
+
// (undocumented)
|
|
354
|
+
AuthorGroup = "AuthorGroup",
|
|
355
|
+
// (undocumented)
|
|
356
|
+
ChecklistProgress = "ChecklistProgress",
|
|
357
|
+
// (undocumented)
|
|
358
|
+
CollaboratorGroup = "CollaboratorGroup",
|
|
359
|
+
// (undocumented)
|
|
360
|
+
CommentCount = "CommentCount",
|
|
361
|
+
// (undocumented)
|
|
362
|
+
CreatedBy = "CreatedBy",
|
|
363
|
+
// (undocumented)
|
|
364
|
+
CreatedOn = "CreatedOn",
|
|
365
|
+
// (undocumented)
|
|
366
|
+
DueOn = "DueOn",
|
|
367
|
+
// (undocumented)
|
|
368
|
+
LatestCommit = "LatestCommit",
|
|
369
|
+
// (undocumented)
|
|
370
|
+
LinkIcon = "LinkIcon",
|
|
371
|
+
// (undocumented)
|
|
372
|
+
Location = "Location",
|
|
373
|
+
// (undocumented)
|
|
374
|
+
ModifiedBy = "ModifiedBy",
|
|
375
|
+
// (undocumented)
|
|
376
|
+
ModifiedOn = "ModifiedOn",
|
|
377
|
+
// (undocumented)
|
|
378
|
+
OwnedBy = "OwnedBy",
|
|
379
|
+
// (undocumented)
|
|
380
|
+
Preview = "Preview",
|
|
381
|
+
// (undocumented)
|
|
382
|
+
Priority = "Priority",
|
|
383
|
+
// (undocumented)
|
|
384
|
+
ProgrammingLanguage = "ProgrammingLanguage",
|
|
385
|
+
// (undocumented)
|
|
386
|
+
Provider = "Provider",
|
|
387
|
+
// (undocumented)
|
|
388
|
+
ReactCount = "ReactCount",
|
|
389
|
+
// (undocumented)
|
|
390
|
+
Snippet = "Snippet",
|
|
391
|
+
// (undocumented)
|
|
392
|
+
SourceBranch = "SourceBranch",
|
|
393
|
+
// (undocumented)
|
|
394
|
+
State = "State",
|
|
395
|
+
// (undocumented)
|
|
396
|
+
SubscriberCount = "SubscriberCount",
|
|
397
|
+
// (undocumented)
|
|
398
|
+
TargetBranch = "TargetBranch",
|
|
399
|
+
// (undocumented)
|
|
400
|
+
Title = "Title",
|
|
401
|
+
// (undocumented)
|
|
402
|
+
ViewCount = "ViewCount",
|
|
403
|
+
// (undocumented)
|
|
404
|
+
VoteCount = "VoteCount"
|
|
405
|
+
}
|
|
406
|
+
|
|
407
|
+
export { EmbedCardAdf }
|
|
408
|
+
|
|
409
|
+
// @public (undocumented)
|
|
410
|
+
export const embedHeaderHeight = 32;
|
|
411
|
+
|
|
412
|
+
// @public (undocumented)
|
|
413
|
+
type EmbedIframeUrlType = 'href' | 'interactiveHref';
|
|
414
|
+
|
|
415
|
+
// @public (undocumented)
|
|
416
|
+
export class EmbedResizeMessageListener extends React_2.Component<Props, State> {
|
|
417
|
+
// (undocumented)
|
|
418
|
+
componentDidMount(): void;
|
|
419
|
+
// (undocumented)
|
|
420
|
+
componentWillUnmount(): void;
|
|
421
|
+
// (undocumented)
|
|
422
|
+
render(): React_2.ReactNode;
|
|
423
|
+
}
|
|
424
|
+
|
|
425
|
+
// @public (undocumented)
|
|
426
|
+
type ErrorCardType = 'errored' | 'fallback' | 'forbidden' | 'not_found' | 'unauthorized';
|
|
427
|
+
|
|
428
|
+
// @public (undocumented)
|
|
429
|
+
type FlexibleUiOptions = {
|
|
430
|
+
clickableContainer?: boolean;
|
|
431
|
+
hideElevation?: boolean;
|
|
432
|
+
hideHoverCardPreviewButton?: boolean;
|
|
433
|
+
hidePadding?: boolean;
|
|
434
|
+
hideBackground?: boolean;
|
|
435
|
+
size?: SmartLinkSize;
|
|
436
|
+
theme?: SmartLinkTheme;
|
|
437
|
+
zIndex?: number;
|
|
438
|
+
};
|
|
439
|
+
|
|
440
|
+
// @public
|
|
441
|
+
export const FooterBlock: React_2.FC<FooterBlockProps>;
|
|
442
|
+
|
|
443
|
+
// @public (undocumented)
|
|
444
|
+
type FooterBlockProps = {
|
|
445
|
+
actions?: ActionItem[];
|
|
446
|
+
onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
|
|
447
|
+
} & BlockProps;
|
|
448
|
+
|
|
449
|
+
// @public (undocumented)
|
|
450
|
+
type FrameStyle = 'hide' | 'show' | 'showOnHover';
|
|
451
|
+
|
|
452
|
+
export { InlineCardAdf }
|
|
453
|
+
|
|
454
|
+
// @public (undocumented)
|
|
455
|
+
type InlinePreloaderStyle = 'on-left-with-skeleton' | 'on-right-without-skeleton';
|
|
456
|
+
|
|
457
|
+
// @public (undocumented)
|
|
458
|
+
type InstrumentEventProps = CommonEventProps & {
|
|
459
|
+
error?: APIError;
|
|
460
|
+
status: CardType;
|
|
461
|
+
id: string;
|
|
462
|
+
};
|
|
463
|
+
|
|
464
|
+
// @public (undocumented)
|
|
465
|
+
type InvokeFailedEventProps = CommonEventProps & {
|
|
466
|
+
id: string;
|
|
467
|
+
actionType: string;
|
|
468
|
+
display: CardInnerAppearance;
|
|
469
|
+
reason: string;
|
|
470
|
+
};
|
|
471
|
+
|
|
472
|
+
// @public (undocumented)
|
|
473
|
+
type InvokeSucceededEventProps = CommonEventProps & {
|
|
474
|
+
id: string;
|
|
475
|
+
actionType: string;
|
|
476
|
+
display: CardInnerAppearance;
|
|
477
|
+
};
|
|
478
|
+
|
|
479
|
+
// @public (undocumented)
|
|
480
|
+
type InvokeType = 'client' | 'server';
|
|
481
|
+
|
|
482
|
+
// @public
|
|
483
|
+
type LatestCommit = {
|
|
484
|
+
name: ElementName.LatestCommit;
|
|
485
|
+
};
|
|
486
|
+
|
|
487
|
+
// @public
|
|
488
|
+
type LinkIcon = {
|
|
489
|
+
name: ElementName.LinkIcon;
|
|
490
|
+
};
|
|
491
|
+
|
|
492
|
+
// @public (undocumented)
|
|
493
|
+
export const loadingPlaceholderClassName = "smart-link-loading-placeholder";
|
|
494
|
+
|
|
495
|
+
// @public
|
|
496
|
+
type Location_2 = {
|
|
497
|
+
name: ElementName.Location;
|
|
498
|
+
};
|
|
499
|
+
|
|
500
|
+
// @public (undocumented)
|
|
501
|
+
export enum MediaPlacement {
|
|
502
|
+
// (undocumented)
|
|
503
|
+
Left = "left",
|
|
504
|
+
// (undocumented)
|
|
505
|
+
Right = "right"
|
|
506
|
+
}
|
|
507
|
+
|
|
508
|
+
// @public
|
|
509
|
+
export const MetadataBlock: React_2.FC<MetadataBlockProps>;
|
|
510
|
+
|
|
511
|
+
// @public (undocumented)
|
|
512
|
+
type MetadataBlockProps = {
|
|
513
|
+
maxLines?: number;
|
|
514
|
+
primary?: ElementItem[];
|
|
515
|
+
secondary?: ElementItem[];
|
|
516
|
+
} & BlockProps;
|
|
517
|
+
|
|
518
|
+
// @public (undocumented)
|
|
519
|
+
export const metadataListClassName = "smart-link-metadata-list";
|
|
520
|
+
|
|
521
|
+
// @public
|
|
522
|
+
type ModifiedBy = {
|
|
523
|
+
name: ElementName.ModifiedBy;
|
|
524
|
+
};
|
|
525
|
+
|
|
526
|
+
// @public
|
|
527
|
+
type ModifiedOn = {
|
|
528
|
+
name: ElementName.ModifiedOn;
|
|
529
|
+
text?: string;
|
|
530
|
+
};
|
|
531
|
+
|
|
532
|
+
// @public
|
|
533
|
+
type NamedActionItem = BaseActionItem & {
|
|
534
|
+
name: ActionName.DeleteAction | ActionName.EditAction;
|
|
535
|
+
};
|
|
536
|
+
|
|
537
|
+
// @public
|
|
538
|
+
type NamedDataActionItem = BaseDataActionItem & {
|
|
539
|
+
name: ActionName.DownloadAction | ActionName.PreviewAction | ActionName.ViewAction;
|
|
540
|
+
};
|
|
541
|
+
|
|
542
|
+
// @public (undocumented)
|
|
543
|
+
export type OnActionMenuOpenChangeOptions = {
|
|
544
|
+
isOpen: boolean;
|
|
545
|
+
};
|
|
546
|
+
|
|
547
|
+
// @public (undocumented)
|
|
548
|
+
type OnErrorCallback = (data: {
|
|
549
|
+
status: Extract<CardType, ErrorCardType>;
|
|
550
|
+
url: string;
|
|
551
|
+
err?: Error;
|
|
552
|
+
}) => void;
|
|
553
|
+
|
|
554
|
+
// @public (undocumented)
|
|
555
|
+
type OnResolveCallback = (data: {
|
|
556
|
+
url?: string;
|
|
557
|
+
title?: string;
|
|
558
|
+
aspectRatio?: number;
|
|
559
|
+
}) => void;
|
|
560
|
+
|
|
561
|
+
// @public
|
|
562
|
+
type OwnedBy = {
|
|
563
|
+
name: ElementName.OwnedBy;
|
|
564
|
+
};
|
|
565
|
+
|
|
566
|
+
// @public
|
|
567
|
+
type Preview = {
|
|
568
|
+
name: ElementName.Preview;
|
|
569
|
+
};
|
|
570
|
+
|
|
571
|
+
// @public
|
|
572
|
+
export const PreviewBlock: React_2.FC<PreviewBlockProps>;
|
|
573
|
+
|
|
574
|
+
// @public (undocumented)
|
|
575
|
+
type PreviewBlockProps = {
|
|
576
|
+
ignoreContainerPadding?: boolean;
|
|
577
|
+
onError?: () => void;
|
|
578
|
+
placement?: MediaPlacement;
|
|
579
|
+
} & BlockProps;
|
|
580
|
+
|
|
581
|
+
// @public (undocumented)
|
|
582
|
+
type PreviewDisplay = 'card' | 'embed';
|
|
583
|
+
|
|
584
|
+
// @public (undocumented)
|
|
585
|
+
type PreviewInvokeMethod = 'keyboard' | 'mouse_click' | 'mouse_hover';
|
|
586
|
+
|
|
587
|
+
// @public
|
|
588
|
+
type Priority = {
|
|
589
|
+
name: ElementName.Priority;
|
|
590
|
+
};
|
|
591
|
+
|
|
592
|
+
// @public
|
|
593
|
+
type ProgrammingLanguage = {
|
|
594
|
+
name: ElementName.ProgrammingLanguage;
|
|
595
|
+
};
|
|
596
|
+
|
|
597
|
+
// @public (undocumented)
|
|
598
|
+
interface Props {
|
|
599
|
+
// (undocumented)
|
|
600
|
+
embedIframeRef: React_2.RefObject<HTMLIFrameElement>;
|
|
601
|
+
// (undocumented)
|
|
602
|
+
onHeightUpdate: (height: number) => void;
|
|
603
|
+
}
|
|
604
|
+
|
|
605
|
+
export { Provider }
|
|
606
|
+
|
|
607
|
+
// @public
|
|
608
|
+
type Provider_2 = {
|
|
609
|
+
name: ElementName.Provider;
|
|
610
|
+
};
|
|
611
|
+
|
|
612
|
+
export { ProviderProps }
|
|
613
|
+
|
|
614
|
+
// @public
|
|
615
|
+
type ReactCount = {
|
|
616
|
+
name: ElementName.ReactCount;
|
|
617
|
+
};
|
|
618
|
+
|
|
619
|
+
// @public (undocumented)
|
|
620
|
+
export type ResolveResponse = JsonLd.Response;
|
|
621
|
+
|
|
622
|
+
// @public
|
|
623
|
+
type RetryOptions = {
|
|
624
|
+
descriptor?: MessageDescriptor;
|
|
625
|
+
onClick?: ((e: React.MouseEvent<HTMLElement>) => void) | undefined;
|
|
626
|
+
values?: Record<string, string>;
|
|
627
|
+
};
|
|
628
|
+
|
|
629
|
+
// @public (undocumented)
|
|
630
|
+
type ScreenAuthPopupEventProps = CommonEventProps;
|
|
631
|
+
|
|
632
|
+
export { SmartCardContext as Context }
|
|
633
|
+
export { SmartCardContext }
|
|
634
|
+
|
|
635
|
+
// @public
|
|
636
|
+
export enum SmartLinkDirection {
|
|
637
|
+
// (undocumented)
|
|
638
|
+
Horizontal = "horizontal",
|
|
639
|
+
// (undocumented)
|
|
640
|
+
Vertical = "vertical"
|
|
641
|
+
}
|
|
642
|
+
|
|
643
|
+
// @public (undocumented)
|
|
644
|
+
export class SmartLinkEvents {
|
|
645
|
+
// (undocumented)
|
|
646
|
+
insertSmartLink(url: string, type: CardInnerAppearance, createAnalyticsEvent?: CreateUIAnalyticsEvent): void;
|
|
647
|
+
}
|
|
648
|
+
|
|
649
|
+
// @public
|
|
650
|
+
export enum SmartLinkPosition {
|
|
651
|
+
// (undocumented)
|
|
652
|
+
Center = "center",
|
|
653
|
+
// (undocumented)
|
|
654
|
+
Top = "top"
|
|
655
|
+
}
|
|
656
|
+
|
|
657
|
+
// @public
|
|
658
|
+
export enum SmartLinkSize {
|
|
659
|
+
// (undocumented)
|
|
660
|
+
Large = "large",
|
|
661
|
+
// (undocumented)
|
|
662
|
+
Medium = "medium",
|
|
663
|
+
// (undocumented)
|
|
664
|
+
Small = "small",
|
|
665
|
+
// (undocumented)
|
|
666
|
+
XLarge = "xlarge"
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
// @public
|
|
670
|
+
enum SmartLinkStatus {
|
|
671
|
+
// (undocumented)
|
|
672
|
+
Errored = "errored",
|
|
673
|
+
// (undocumented)
|
|
674
|
+
Fallback = "fallback",
|
|
675
|
+
// (undocumented)
|
|
676
|
+
Forbidden = "forbidden",
|
|
677
|
+
// (undocumented)
|
|
678
|
+
NotFound = "not_found",
|
|
679
|
+
// (undocumented)
|
|
680
|
+
Pending = "pending",
|
|
681
|
+
// (undocumented)
|
|
682
|
+
Resolved = "resolved",
|
|
683
|
+
// (undocumented)
|
|
684
|
+
Resolving = "resolving",
|
|
685
|
+
// (undocumented)
|
|
686
|
+
Unauthorized = "unauthorized"
|
|
687
|
+
}
|
|
688
|
+
|
|
689
|
+
// @public
|
|
690
|
+
export enum SmartLinkTheme {
|
|
691
|
+
// (undocumented)
|
|
692
|
+
Black = "black",
|
|
693
|
+
// (undocumented)
|
|
694
|
+
Link = "link"
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
// @public
|
|
698
|
+
type Snippet = {
|
|
699
|
+
name: ElementName.Snippet;
|
|
700
|
+
};
|
|
701
|
+
|
|
702
|
+
// @public
|
|
703
|
+
export const SnippetBlock: React_2.FC<SnippetBlockProps>;
|
|
704
|
+
|
|
705
|
+
// @public (undocumented)
|
|
706
|
+
type SnippetBlockProps = {
|
|
707
|
+
maxLines?: number;
|
|
708
|
+
} & BlockProps;
|
|
709
|
+
|
|
710
|
+
// @public
|
|
711
|
+
type SourceBranch = {
|
|
712
|
+
name: ElementName.SourceBranch;
|
|
713
|
+
};
|
|
714
|
+
|
|
715
|
+
// @public (undocumented)
|
|
716
|
+
interface State {
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
// @public
|
|
720
|
+
type State_2 = {
|
|
721
|
+
name: ElementName.State;
|
|
722
|
+
};
|
|
723
|
+
|
|
724
|
+
// @public
|
|
725
|
+
type SubscriberCount = {
|
|
726
|
+
name: ElementName.SubscriberCount;
|
|
727
|
+
};
|
|
728
|
+
|
|
729
|
+
// @public
|
|
730
|
+
type TargetBranch = {
|
|
731
|
+
name: ElementName.TargetBranch;
|
|
732
|
+
};
|
|
733
|
+
|
|
734
|
+
// @public
|
|
735
|
+
type Title = {
|
|
736
|
+
name: ElementName.Title;
|
|
737
|
+
};
|
|
738
|
+
|
|
739
|
+
// @public
|
|
740
|
+
export const TitleBlock: React_2.FC<TitleBlockProps>;
|
|
741
|
+
|
|
742
|
+
// @public (undocumented)
|
|
743
|
+
type TitleBlockProps = {
|
|
744
|
+
actions?: ActionItem[];
|
|
745
|
+
anchorTarget?: AnchorTarget;
|
|
746
|
+
hideTitleTooltip?: boolean;
|
|
747
|
+
maxLines?: number;
|
|
748
|
+
metadata?: ElementItem[];
|
|
749
|
+
onActionMenuOpenChange?: (options: OnActionMenuOpenChangeOptions) => void;
|
|
750
|
+
position?: SmartLinkPosition;
|
|
751
|
+
onClick?: React_2.EventHandler<React_2.KeyboardEvent | React_2.MouseEvent>;
|
|
752
|
+
retry?: RetryOptions;
|
|
753
|
+
hideRetry?: boolean;
|
|
754
|
+
showActionOnHover?: boolean;
|
|
755
|
+
subtitle?: ElementItem[];
|
|
756
|
+
text?: string;
|
|
757
|
+
theme?: SmartLinkTheme;
|
|
758
|
+
metadataPosition?: SmartLinkPosition;
|
|
759
|
+
} & BlockProps;
|
|
760
|
+
|
|
761
|
+
// @public (undocumented)
|
|
762
|
+
type TrackAppAccountConnectedProps = CommonEventProps;
|
|
763
|
+
|
|
764
|
+
// @public (undocumented)
|
|
765
|
+
enum TrackQuickActionFailureReason {
|
|
766
|
+
// (undocumented)
|
|
767
|
+
PermissionError = "PermissionError",
|
|
768
|
+
// (undocumented)
|
|
769
|
+
UnknownError = "UnknownError",
|
|
770
|
+
// (undocumented)
|
|
771
|
+
ValidationError = "ValidationError"
|
|
772
|
+
}
|
|
773
|
+
|
|
774
|
+
// @public (undocumented)
|
|
775
|
+
enum TrackQuickActionType {
|
|
776
|
+
// (undocumented)
|
|
777
|
+
StatusUpdate = "StatusUpdate"
|
|
778
|
+
}
|
|
779
|
+
|
|
780
|
+
// @public (undocumented)
|
|
781
|
+
type UiActionClickedEventProps = CommonEventProps & {
|
|
782
|
+
id: string;
|
|
783
|
+
display: CardInnerAppearance;
|
|
784
|
+
actionType: string;
|
|
785
|
+
invokeType?: InvokeType;
|
|
786
|
+
};
|
|
787
|
+
|
|
788
|
+
// @public (undocumented)
|
|
789
|
+
type UiAuthAlternateAccountEventProps = CommonEventProps & {
|
|
790
|
+
display: CardInnerAppearance;
|
|
791
|
+
};
|
|
792
|
+
|
|
793
|
+
// @public (undocumented)
|
|
794
|
+
type UiAuthEventProps = CommonEventProps & {
|
|
795
|
+
display: CardInnerAppearance;
|
|
796
|
+
};
|
|
797
|
+
|
|
798
|
+
// @public (undocumented)
|
|
799
|
+
type UiCardClickedEventProps = CommonEventProps & {
|
|
800
|
+
id: string;
|
|
801
|
+
display: CardInnerAppearance;
|
|
802
|
+
status: CardType;
|
|
803
|
+
isModifierKeyPressed?: boolean;
|
|
804
|
+
actionSubjectId?: string;
|
|
805
|
+
};
|
|
806
|
+
|
|
807
|
+
// @public (undocumented)
|
|
808
|
+
type UiClosedAuthEventProps = CommonEventProps & {
|
|
809
|
+
display: CardInnerAppearance;
|
|
810
|
+
};
|
|
811
|
+
|
|
812
|
+
// @public (undocumented)
|
|
813
|
+
type UiHoverCardDismissedEventProps = CommonEventProps & {
|
|
814
|
+
previewDisplay: PreviewDisplay;
|
|
815
|
+
hoverTime: number;
|
|
816
|
+
previewInvokeMethod?: PreviewInvokeMethod;
|
|
817
|
+
status: CardType;
|
|
818
|
+
};
|
|
819
|
+
|
|
820
|
+
// @public (undocumented)
|
|
821
|
+
type UiHoverCardOpenLinkClickedEventProps = CommonEventProps & {
|
|
822
|
+
previewDisplay: PreviewDisplay;
|
|
823
|
+
previewInvokeMethod?: PreviewInvokeMethod;
|
|
824
|
+
};
|
|
825
|
+
|
|
826
|
+
// @public (undocumented)
|
|
827
|
+
type UiHoverCardViewedEventProps = CommonEventProps & {
|
|
828
|
+
previewDisplay: PreviewDisplay;
|
|
829
|
+
previewInvokeMethod?: PreviewInvokeMethod;
|
|
830
|
+
status: CardType;
|
|
831
|
+
};
|
|
832
|
+
|
|
833
|
+
// @public (undocumented)
|
|
834
|
+
type UiIframeDwelledEventProps = CommonEventProps & {
|
|
835
|
+
id: string;
|
|
836
|
+
display: CardInnerAppearance;
|
|
837
|
+
status: CardType;
|
|
838
|
+
dwellTime: number;
|
|
839
|
+
dwellPercentVisible: number;
|
|
840
|
+
};
|
|
841
|
+
|
|
842
|
+
// @public (undocumented)
|
|
843
|
+
type UiIframeFocusedEventProps = CommonEventProps & {
|
|
844
|
+
id: string;
|
|
845
|
+
display: CardInnerAppearance;
|
|
846
|
+
status: CardType;
|
|
847
|
+
};
|
|
848
|
+
|
|
849
|
+
// @public (undocumented)
|
|
850
|
+
type UiRenderFailedEventProps = CommonEventProps & {
|
|
851
|
+
display: CardInnerAppearance;
|
|
852
|
+
error: Error;
|
|
853
|
+
errorInfo: ErrorInfo;
|
|
854
|
+
};
|
|
855
|
+
|
|
856
|
+
// @public (undocumented)
|
|
857
|
+
type UiRenderSuccessEventProps = CommonEventProps & {
|
|
858
|
+
display: CardInnerAppearance;
|
|
859
|
+
status: CardType;
|
|
860
|
+
};
|
|
861
|
+
|
|
862
|
+
// @public @deprecated
|
|
863
|
+
export const useSmartLinkAnalytics: (url: string, _dispatchAnalytics?: AnalyticsHandler, id?: string, defaultLocation?: string) => {
|
|
864
|
+
ui: {
|
|
865
|
+
authEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthEventProps) => void;
|
|
866
|
+
authAlternateAccountEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiAuthAlternateAccountEventProps) => void;
|
|
867
|
+
buttonClickedEvent: (data: Partial<AnalyticsPayload> & {
|
|
868
|
+
actionSubjectId: Required<string>;
|
|
869
|
+
}) => void;
|
|
870
|
+
cardClickedEvent: ({ id, display, status, definitionId, extensionKey, isModifierKeyPressed, location, destinationProduct, destinationSubproduct, actionSubjectId, }: UiCardClickedEventProps) => void;
|
|
871
|
+
iframeDwelledEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, dwellTime, dwellPercentVisible, }: UiIframeDwelledEventProps) => void;
|
|
872
|
+
iframeFocusedEvent: ({ id, display, status, definitionId, extensionKey, location, destinationProduct, destinationSubproduct, }: UiIframeFocusedEventProps) => void;
|
|
873
|
+
actionClickedEvent: ({ id, actionType, display, invokeType, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiActionClickedEventProps) => void;
|
|
874
|
+
hoverCardOpenLinkClickedEvent: ({ previewDisplay, definitionId, extensionKey, destinationProduct, destinationSubproduct, location, previewInvokeMethod, }: UiHoverCardOpenLinkClickedEventProps) => void;
|
|
875
|
+
closedAuthEvent: ({ display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiClosedAuthEventProps) => void;
|
|
876
|
+
modalClosedEvent: (data: Partial<AnalyticsPayload> & {
|
|
877
|
+
actionSubjectId: Required<string>;
|
|
878
|
+
}) => void;
|
|
879
|
+
renderSuccessEvent: ({ display, status, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderSuccessEventProps) => void;
|
|
880
|
+
renderFailedEvent: ({ display, id, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
|
|
881
|
+
hoverCardViewedEvent: ({ previewDisplay, previewInvokeMethod, id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardViewedEventProps) => void;
|
|
882
|
+
hoverCardDismissedEvent: ({ id, previewDisplay, hoverTime, previewInvokeMethod, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, status, }: UiHoverCardDismissedEventProps) => void;
|
|
883
|
+
learnMoreClickedEvent: () => void;
|
|
884
|
+
smartLinkLozengeActionClickedEvent: () => void;
|
|
885
|
+
smartLinkLozengeActionListItemClickedEvent: () => void;
|
|
886
|
+
smartLinkLozengeActionErrorOpenPreviewClickedEvent: () => void;
|
|
887
|
+
};
|
|
888
|
+
operational: {
|
|
889
|
+
invokeSucceededEvent: ({ id, actionType, display, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeSucceededEventProps) => void;
|
|
890
|
+
invokeFailedEvent: ({ id, actionType, display, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: InvokeFailedEventProps) => void;
|
|
891
|
+
connectSucceededEvent: ({ id, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectSucceededEventProps) => void;
|
|
892
|
+
connectFailedEvent: ({ id, reason, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ConnectFailedEventProps) => void;
|
|
893
|
+
instrument: ({ id, status, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, error, }: InstrumentEventProps) => void;
|
|
894
|
+
chunkloadFailedEvent: ({ display, error, errorInfo, extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: UiRenderFailedEventProps) => void;
|
|
895
|
+
};
|
|
896
|
+
track: {
|
|
897
|
+
appAccountConnected: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: TrackAppAccountConnectedProps) => void;
|
|
898
|
+
appAccountAuthStarted: ({ extensionKey, location, }: TrackAppAccountConnectedProps) => void;
|
|
899
|
+
linkUpdated: (props: CommonEventProps & {
|
|
900
|
+
[key: string]: any;
|
|
901
|
+
}) => void;
|
|
902
|
+
smartLinkQuickActionStarted: (props: {
|
|
903
|
+
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
904
|
+
}) => void;
|
|
905
|
+
smartLinkQuickActionSuccess: (props: {
|
|
906
|
+
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
907
|
+
}) => void;
|
|
908
|
+
smartLinkQuickActionFailed: (props: {
|
|
909
|
+
smartLinkActionType: SmartLinkActionType | TrackQuickActionType;
|
|
910
|
+
reason?: TrackQuickActionFailureReason;
|
|
911
|
+
step?: string;
|
|
912
|
+
}) => void;
|
|
913
|
+
};
|
|
914
|
+
screen: {
|
|
915
|
+
authPopupEvent: ({ extensionKey, definitionId, resourceType, destinationProduct, destinationSubproduct, location, }: ScreenAuthPopupEventProps) => void;
|
|
916
|
+
modalViewedEvent: (data: Partial<AnalyticsPayload> & {
|
|
917
|
+
name: Extract<AnalyticsName, 'embedPreviewModal'>;
|
|
918
|
+
}) => void;
|
|
919
|
+
};
|
|
920
|
+
};
|
|
921
|
+
|
|
922
|
+
// @public (undocumented)
|
|
923
|
+
export function useSmartLinkEvents(): SmartLinkEvents;
|
|
924
|
+
|
|
925
|
+
// @public
|
|
926
|
+
type ViewCount = {
|
|
927
|
+
name: ElementName.ViewCount;
|
|
928
|
+
};
|
|
929
|
+
|
|
930
|
+
// @public
|
|
931
|
+
type VoteCount = {
|
|
932
|
+
name: ElementName.VoteCount;
|
|
933
|
+
};
|
|
934
|
+
|
|
935
|
+
// (No @packageDocumentation comment for this package)
|
|
936
|
+
|
|
937
|
+
```
|