@atlaskit/renderer 152.0.1 → 152.1.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 +21 -0
- package/dist/cjs/ui/Renderer/index.js +6 -3
- package/dist/cjs/ui/annotations/hooks/use-events.js +3 -0
- package/dist/es2019/ui/Renderer/index.js +11 -6
- package/dist/es2019/ui/annotations/hooks/use-events.js +3 -0
- package/dist/esm/ui/Renderer/index.js +6 -3
- package/dist/esm/ui/annotations/hooks/use-events.js +3 -0
- package/dist/types/react/index.d.ts +2 -0
- package/dist/types/renderer-context.d.ts +2 -0
- package/dist/types/ui/renderer-props.d.ts +2 -0
- package/package.json +6 -6
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,26 @@
|
|
|
1
1
|
# @atlaskit/renderer
|
|
2
2
|
|
|
3
|
+
## 152.1.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- [`29dedebbe1445`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/29dedebbe1445) -
|
|
8
|
+
Expose host-derived performance mode activation through renderer context and custom serializer
|
|
9
|
+
initialization. Confluence supplies activation behind confluence_view_page_performance_mode; no
|
|
10
|
+
rendering optimizations are enabled by this API.
|
|
11
|
+
|
|
12
|
+
### Patch Changes
|
|
13
|
+
|
|
14
|
+
- [`ecf2ff276250a`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/ecf2ff276250a) -
|
|
15
|
+
Include the annotation id in existing annotation viewed analytics so products can classify the
|
|
16
|
+
comment target.
|
|
17
|
+
|
|
18
|
+
## 152.0.2
|
|
19
|
+
|
|
20
|
+
### Patch Changes
|
|
21
|
+
|
|
22
|
+
- Updated dependencies
|
|
23
|
+
|
|
3
24
|
## 152.0.1
|
|
4
25
|
|
|
5
26
|
### Patch Changes
|
|
@@ -79,7 +79,7 @@ var DEGRADED_SEVERITY_THRESHOLD = exports.DEGRADED_SEVERITY_THRESHOLD = 3000;
|
|
|
79
79
|
var TABLE_INFO_TIMEOUT = 10000;
|
|
80
80
|
var RENDER_EVENT_SAMPLE_RATE = 0.1;
|
|
81
81
|
var packageName = "@atlaskit/renderer";
|
|
82
|
-
var packageVersion = "152.0.
|
|
82
|
+
var packageVersion = "152.0.2";
|
|
83
83
|
var setAsQueryContainerStyles = (0, _react2.css)({
|
|
84
84
|
containerName: 'ak-renderer-wrapper',
|
|
85
85
|
containerType: 'inline-size'
|
|
@@ -233,7 +233,7 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
|
|
|
233
233
|
exposure: true
|
|
234
234
|
}) ? fireAnalyticsEventNew : fireAnalyticsEventOld;
|
|
235
235
|
var deriveSerializerProps = (0, _react.useCallback)(function (props) {
|
|
236
|
-
var _props$startPos;
|
|
236
|
+
var _props$startPos, _props$isPerformanceM;
|
|
237
237
|
var stickyHeaders = props.stickyHeaders ? props.stickyHeaders === true ? {} : props.stickyHeaders : undefined;
|
|
238
238
|
var annotationProvider = props.annotationProvider;
|
|
239
239
|
var allowAnnotationsDraftMode = Boolean(annotationProvider && annotationProvider.inlineComment && annotationProvider.inlineComment.allowDraftMode);
|
|
@@ -241,6 +241,7 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
|
|
|
241
241
|
featureFlags = _createRendererContex.featureFlags;
|
|
242
242
|
return {
|
|
243
243
|
startPos: (_props$startPos = props.startPos) !== null && _props$startPos !== void 0 ? _props$startPos : 0,
|
|
244
|
+
isPerformanceModeActive: (_props$isPerformanceM = props.isPerformanceModeActive) !== null && _props$isPerformanceM !== void 0 ? _props$isPerformanceM : false,
|
|
244
245
|
providers: providerFactory,
|
|
245
246
|
eventHandlers: props.eventHandlers,
|
|
246
247
|
extensionHandlers: props.extensionHandlers,
|
|
@@ -472,10 +473,12 @@ var RendererFunctionalComponent = exports.RendererFunctionalComponent = function
|
|
|
472
473
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
473
474
|
}, []);
|
|
474
475
|
var rendererContext = (0, _react.useMemo)(function () {
|
|
476
|
+
var _props$isPerformanceM2;
|
|
475
477
|
return _objectSpread(_objectSpread({}, createRendererContext(props.featureFlags, props.isTopLevelRenderer)), {}, {
|
|
478
|
+
isPerformanceModeActive: (_props$isPerformanceM2 = props.isPerformanceModeActive) !== null && _props$isPerformanceM2 !== void 0 ? _props$isPerformanceM2 : false,
|
|
476
479
|
timeZone: props.timeZone
|
|
477
480
|
});
|
|
478
|
-
}, [props.featureFlags, props.isTopLevelRenderer, createRendererContext, props.timeZone]);
|
|
481
|
+
}, [props.featureFlags, props.isTopLevelRenderer, createRendererContext, props.timeZone, props.isPerformanceModeActive]);
|
|
479
482
|
var isCollapsibleHeadingsEnabled = props.allowCollapsibleHeadings === true && ['full-page', 'full-width', 'max'].includes(props.appearance || '') && rendererContext.isTopLevelRenderer && (0, _isExperimentEnabled.isExperimentEnabled)('platform_editor_collapsible_headings');
|
|
480
483
|
(0, _useScrollToBlock.useScrollToBlock)(editorRef, props.document, props.scrollToBlock);
|
|
481
484
|
var allowNestedTables = props.allowNestedTables;
|
|
@@ -171,12 +171,15 @@ var useAnnotationClickEvent = exports.useAnnotationClickEvent = function useAnno
|
|
|
171
171
|
};
|
|
172
172
|
});
|
|
173
173
|
if (createAnalyticsEvent) {
|
|
174
|
+
var _annotationsByType$;
|
|
174
175
|
createAnalyticsEvent({
|
|
175
176
|
action: _enums.ACTION.VIEWED,
|
|
176
177
|
actionSubject: _enums.ACTION_SUBJECT.ANNOTATION,
|
|
177
178
|
actionSubjectId: _enums.ACTION_SUBJECT_ID.INLINE_COMMENT,
|
|
178
179
|
eventType: _enums.EVENT_TYPE.TRACK,
|
|
179
180
|
attributes: {
|
|
181
|
+
// Let products identify the annotated target without changing the open behavior.
|
|
182
|
+
annotationId: (_annotationsByType$ = annotationsByType[0]) === null || _annotationsByType$ === void 0 ? void 0 : _annotationsByType$.id,
|
|
180
183
|
overlap: annotationsByType.length || 0,
|
|
181
184
|
targetNodeType: eventTargetType,
|
|
182
185
|
method: viewMethod
|
|
@@ -64,7 +64,7 @@ export const DEGRADED_SEVERITY_THRESHOLD = 3000;
|
|
|
64
64
|
const TABLE_INFO_TIMEOUT = 10000;
|
|
65
65
|
const RENDER_EVENT_SAMPLE_RATE = 0.1;
|
|
66
66
|
const packageName = "@atlaskit/renderer";
|
|
67
|
-
const packageVersion = "152.0.
|
|
67
|
+
const packageVersion = "152.0.2";
|
|
68
68
|
const setAsQueryContainerStyles = css({
|
|
69
69
|
containerName: 'ak-renderer-wrapper',
|
|
70
70
|
containerType: 'inline-size'
|
|
@@ -221,7 +221,7 @@ export const RendererFunctionalComponent = props => {
|
|
|
221
221
|
exposure: true
|
|
222
222
|
}) ? fireAnalyticsEventNew : fireAnalyticsEventOld;
|
|
223
223
|
const deriveSerializerProps = useCallback(props => {
|
|
224
|
-
var _props$startPos;
|
|
224
|
+
var _props$startPos, _props$isPerformanceM;
|
|
225
225
|
const stickyHeaders = props.stickyHeaders ? props.stickyHeaders === true ? {} : props.stickyHeaders : undefined;
|
|
226
226
|
const {
|
|
227
227
|
annotationProvider
|
|
@@ -232,6 +232,7 @@ export const RendererFunctionalComponent = props => {
|
|
|
232
232
|
} = createRendererContext(props.featureFlags, props.isTopLevelRenderer);
|
|
233
233
|
return {
|
|
234
234
|
startPos: (_props$startPos = props.startPos) !== null && _props$startPos !== void 0 ? _props$startPos : 0,
|
|
235
|
+
isPerformanceModeActive: (_props$isPerformanceM = props.isPerformanceModeActive) !== null && _props$isPerformanceM !== void 0 ? _props$isPerformanceM : false,
|
|
235
236
|
providers: providerFactory,
|
|
236
237
|
eventHandlers: props.eventHandlers,
|
|
237
238
|
extensionHandlers: props.extensionHandlers,
|
|
@@ -460,10 +461,14 @@ export const RendererFunctionalComponent = props => {
|
|
|
460
461
|
// having a dependency array means we run stopMeasure twice per render
|
|
461
462
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
462
463
|
}, []);
|
|
463
|
-
const rendererContext = useMemo(() =>
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
464
|
+
const rendererContext = useMemo(() => {
|
|
465
|
+
var _props$isPerformanceM2;
|
|
466
|
+
return {
|
|
467
|
+
...createRendererContext(props.featureFlags, props.isTopLevelRenderer),
|
|
468
|
+
isPerformanceModeActive: (_props$isPerformanceM2 = props.isPerformanceModeActive) !== null && _props$isPerformanceM2 !== void 0 ? _props$isPerformanceM2 : false,
|
|
469
|
+
timeZone: props.timeZone
|
|
470
|
+
};
|
|
471
|
+
}, [props.featureFlags, props.isTopLevelRenderer, createRendererContext, props.timeZone, props.isPerformanceModeActive]);
|
|
467
472
|
const isCollapsibleHeadingsEnabled = props.allowCollapsibleHeadings === true && ['full-page', 'full-width', 'max'].includes(props.appearance || '') && rendererContext.isTopLevelRenderer && isExperimentEnabled('platform_editor_collapsible_headings');
|
|
468
473
|
useScrollToBlock(editorRef, props.document, props.scrollToBlock);
|
|
469
474
|
const {
|
|
@@ -164,12 +164,15 @@ export const useAnnotationClickEvent = props => {
|
|
|
164
164
|
type: AnnotationTypes.INLINE_COMMENT
|
|
165
165
|
}));
|
|
166
166
|
if (createAnalyticsEvent) {
|
|
167
|
+
var _annotationsByType$;
|
|
167
168
|
createAnalyticsEvent({
|
|
168
169
|
action: ACTION.VIEWED,
|
|
169
170
|
actionSubject: ACTION_SUBJECT.ANNOTATION,
|
|
170
171
|
actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
|
|
171
172
|
eventType: EVENT_TYPE.TRACK,
|
|
172
173
|
attributes: {
|
|
174
|
+
// Let products identify the annotated target without changing the open behavior.
|
|
175
|
+
annotationId: (_annotationsByType$ = annotationsByType[0]) === null || _annotationsByType$ === void 0 ? void 0 : _annotationsByType$.id,
|
|
173
176
|
overlap: annotationsByType.length || 0,
|
|
174
177
|
targetNodeType: eventTargetType,
|
|
175
178
|
method: viewMethod
|
|
@@ -69,7 +69,7 @@ export var DEGRADED_SEVERITY_THRESHOLD = 3000;
|
|
|
69
69
|
var TABLE_INFO_TIMEOUT = 10000;
|
|
70
70
|
var RENDER_EVENT_SAMPLE_RATE = 0.1;
|
|
71
71
|
var packageName = "@atlaskit/renderer";
|
|
72
|
-
var packageVersion = "152.0.
|
|
72
|
+
var packageVersion = "152.0.2";
|
|
73
73
|
var setAsQueryContainerStyles = css({
|
|
74
74
|
containerName: 'ak-renderer-wrapper',
|
|
75
75
|
containerType: 'inline-size'
|
|
@@ -223,7 +223,7 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
|
|
|
223
223
|
exposure: true
|
|
224
224
|
}) ? fireAnalyticsEventNew : fireAnalyticsEventOld;
|
|
225
225
|
var deriveSerializerProps = useCallback(function (props) {
|
|
226
|
-
var _props$startPos;
|
|
226
|
+
var _props$startPos, _props$isPerformanceM;
|
|
227
227
|
var stickyHeaders = props.stickyHeaders ? props.stickyHeaders === true ? {} : props.stickyHeaders : undefined;
|
|
228
228
|
var annotationProvider = props.annotationProvider;
|
|
229
229
|
var allowAnnotationsDraftMode = Boolean(annotationProvider && annotationProvider.inlineComment && annotationProvider.inlineComment.allowDraftMode);
|
|
@@ -231,6 +231,7 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
|
|
|
231
231
|
featureFlags = _createRendererContex.featureFlags;
|
|
232
232
|
return {
|
|
233
233
|
startPos: (_props$startPos = props.startPos) !== null && _props$startPos !== void 0 ? _props$startPos : 0,
|
|
234
|
+
isPerformanceModeActive: (_props$isPerformanceM = props.isPerformanceModeActive) !== null && _props$isPerformanceM !== void 0 ? _props$isPerformanceM : false,
|
|
234
235
|
providers: providerFactory,
|
|
235
236
|
eventHandlers: props.eventHandlers,
|
|
236
237
|
extensionHandlers: props.extensionHandlers,
|
|
@@ -462,10 +463,12 @@ export var RendererFunctionalComponent = function RendererFunctionalComponent(pr
|
|
|
462
463
|
// eslint-disable-next-line react-hooks/exhaustive-deps
|
|
463
464
|
}, []);
|
|
464
465
|
var rendererContext = useMemo(function () {
|
|
466
|
+
var _props$isPerformanceM2;
|
|
465
467
|
return _objectSpread(_objectSpread({}, createRendererContext(props.featureFlags, props.isTopLevelRenderer)), {}, {
|
|
468
|
+
isPerformanceModeActive: (_props$isPerformanceM2 = props.isPerformanceModeActive) !== null && _props$isPerformanceM2 !== void 0 ? _props$isPerformanceM2 : false,
|
|
466
469
|
timeZone: props.timeZone
|
|
467
470
|
});
|
|
468
|
-
}, [props.featureFlags, props.isTopLevelRenderer, createRendererContext, props.timeZone]);
|
|
471
|
+
}, [props.featureFlags, props.isTopLevelRenderer, createRendererContext, props.timeZone, props.isPerformanceModeActive]);
|
|
469
472
|
var isCollapsibleHeadingsEnabled = props.allowCollapsibleHeadings === true && ['full-page', 'full-width', 'max'].includes(props.appearance || '') && rendererContext.isTopLevelRenderer && isExperimentEnabled('platform_editor_collapsible_headings');
|
|
470
473
|
useScrollToBlock(editorRef, props.document, props.scrollToBlock);
|
|
471
474
|
var allowNestedTables = props.allowNestedTables;
|
|
@@ -164,12 +164,15 @@ export var useAnnotationClickEvent = function useAnnotationClickEvent(props) {
|
|
|
164
164
|
};
|
|
165
165
|
});
|
|
166
166
|
if (createAnalyticsEvent) {
|
|
167
|
+
var _annotationsByType$;
|
|
167
168
|
createAnalyticsEvent({
|
|
168
169
|
action: ACTION.VIEWED,
|
|
169
170
|
actionSubject: ACTION_SUBJECT.ANNOTATION,
|
|
170
171
|
actionSubjectId: ACTION_SUBJECT_ID.INLINE_COMMENT,
|
|
171
172
|
eventType: EVENT_TYPE.TRACK,
|
|
172
173
|
attributes: {
|
|
174
|
+
// Let products identify the annotated target without changing the open behavior.
|
|
175
|
+
annotationId: (_annotationsByType$ = annotationsByType[0]) === null || _annotationsByType$ === void 0 ? void 0 : _annotationsByType$.id,
|
|
173
176
|
overlap: annotationsByType.length || 0,
|
|
174
177
|
targetNodeType: eventTargetType,
|
|
175
178
|
method: viewMethod
|
|
@@ -44,6 +44,8 @@ export interface ReactSerializerInit {
|
|
|
44
44
|
headingIdPrefix?: string;
|
|
45
45
|
hideExtensionKeysWhilePending?: string[];
|
|
46
46
|
isInsideOfInlineExtension?: boolean;
|
|
47
|
+
/** Document activation supplied by the host, available to custom serializers. */
|
|
48
|
+
isPerformanceModeActive?: boolean;
|
|
47
49
|
isPresentational?: boolean;
|
|
48
50
|
media?: MediaOptions;
|
|
49
51
|
mentionNodeDataProvider?: MentionNodeDataProvider;
|
|
@@ -3,6 +3,8 @@ import type { FeatureFlags } from '@atlaskit/editor-common/types/feature-flags';
|
|
|
3
3
|
import type { NestedRendererType } from './ui/Renderer/types';
|
|
4
4
|
export type RendererContextProps = {
|
|
5
5
|
featureFlags?: FeatureFlags;
|
|
6
|
+
/** Explicit to each renderer; independent nested renderers default to false. */
|
|
7
|
+
isPerformanceModeActive?: boolean;
|
|
6
8
|
isTopLevelRenderer?: boolean;
|
|
7
9
|
nestedRendererType?: NestedRendererType;
|
|
8
10
|
timeZone?: string;
|
|
@@ -160,6 +160,8 @@ export interface RendererProps {
|
|
|
160
160
|
includeNodesCountInStats?: boolean;
|
|
161
161
|
innerRef?: React.RefObject<HTMLDivElement>;
|
|
162
162
|
isInsideOfInlineExtension?: boolean;
|
|
163
|
+
/** Document activation decided by the host product. Defaults to false. */
|
|
164
|
+
isPerformanceModeActive?: boolean;
|
|
163
165
|
isTopLevelRenderer?: boolean;
|
|
164
166
|
maxHeight?: number;
|
|
165
167
|
media?: MediaOptions;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@atlaskit/renderer",
|
|
3
|
-
"version": "152.0
|
|
3
|
+
"version": "152.1.0",
|
|
4
4
|
"description": "Renderer component",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"registry": "https://registry.npmjs.org/"
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
"@atlaskit/analytics-namespaced-context": "^8.2.0",
|
|
41
41
|
"@atlaskit/analytics-next": "^12.6.0",
|
|
42
42
|
"@atlaskit/browser-apis": "^1.2.0",
|
|
43
|
-
"@atlaskit/button": "^25.
|
|
43
|
+
"@atlaskit/button": "^25.6.0",
|
|
44
44
|
"@atlaskit/code": "^20.0.0",
|
|
45
45
|
"@atlaskit/css": "^1.1.0",
|
|
46
46
|
"@atlaskit/editor-card-provider": "^8.1.0",
|
|
47
47
|
"@atlaskit/editor-json-transformer": "^10.0.0",
|
|
48
48
|
"@atlaskit/editor-palette": "^3.5.0",
|
|
49
49
|
"@atlaskit/editor-prosemirror": "^9.0.0",
|
|
50
|
-
"@atlaskit/editor-shared-styles": "^4.
|
|
50
|
+
"@atlaskit/editor-shared-styles": "^4.6.0",
|
|
51
51
|
"@atlaskit/editor-smart-link-draggable": "^1.2.0",
|
|
52
52
|
"@atlaskit/emoji": "^73.0.0",
|
|
53
53
|
"@atlaskit/feature-gate-js-client": "^7.0.0",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"@atlaskit/status": "^5.13.0",
|
|
74
74
|
"@atlaskit/task-decision": "^21.12.0",
|
|
75
75
|
"@atlaskit/theme": "^28.2.0",
|
|
76
|
-
"@atlaskit/tmp-editor-statsig": "^
|
|
76
|
+
"@atlaskit/tmp-editor-statsig": "^244.0.0",
|
|
77
77
|
"@atlaskit/tokens": "^20.6.0",
|
|
78
78
|
"@atlaskit/tooltip": "^24.4.0",
|
|
79
79
|
"@atlaskit/visually-hidden": "^4.4.0",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"uuid": "^11.1.1"
|
|
89
89
|
},
|
|
90
90
|
"peerDependencies": {
|
|
91
|
-
"@atlaskit/editor-common": "^133.
|
|
91
|
+
"@atlaskit/editor-common": "^133.3.0",
|
|
92
92
|
"@atlaskit/link-provider": "^6.0.0",
|
|
93
93
|
"@atlaskit/media-core": "^39.0.0",
|
|
94
94
|
"react": "^18.2.0 || ^19.2.0",
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
"@atlaskit/radio": "^10.2.0",
|
|
120
120
|
"@atlaskit/range": "^12.2.0",
|
|
121
121
|
"@atlaskit/section-message": "^10.2.0",
|
|
122
|
-
"@atlaskit/side-nav-items": "^2.
|
|
122
|
+
"@atlaskit/side-nav-items": "^2.6.0",
|
|
123
123
|
"@atlaskit/textfield": "^10.2.0",
|
|
124
124
|
"@atlaskit/toggle": "^17.3.0",
|
|
125
125
|
"@atlaskit/util-data-test": "^19.1.0",
|