@atlaskit/renderer 108.7.0 → 108.7.2

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 CHANGED
@@ -1,5 +1,17 @@
1
1
  # @atlaskit/renderer
2
2
 
3
+ ## 108.7.2
4
+
5
+ ### Patch Changes
6
+
7
+ - [`3fb20c4aeba`](https://bitbucket.org/atlassian/atlassian-frontend/commits/3fb20c4aeba) - Add postinstall check to enforce internal peer dependencies
8
+
9
+ ## 108.7.1
10
+
11
+ ### Patch Changes
12
+
13
+ - [`4fe49c40988`](https://bitbucket.org/atlassian/atlassian-frontend/commits/4fe49c40988) - [ux] ED-18966 fix default table in renderer full-width appearance mode
14
+
3
15
  ## 108.7.0
4
16
 
5
17
  ### Minor Changes
@@ -258,8 +258,11 @@ var TableContainer = /*#__PURE__*/function (_React$Component) {
258
258
  var lineLength = _editorSharedStyles.akEditorDefaultLayoutWidth;
259
259
  var tableWidth;
260
260
  var left;
261
+ var calcDefaultLayoutWidthByAppearance = function calcDefaultLayoutWidthByAppearance(tableNode, rendererAppearance) {
262
+ return rendererAppearance === 'full-width' && !tableNode.attrs.width ? Math.min(_editorSharedStyles.akEditorFullWidthLayoutWidth, renderWidth) : Math.min((0, _nodeWidth.getTableContainerWidth)(tableNode), renderWidth);
263
+ };
261
264
  if ((0, _platformFeatureFlags.getBooleanFF)('platform.editor.custom-table-width') && tableNode) {
262
- tableWidth = Math.min((0, _nodeWidth.getTableContainerWidth)(tableNode), renderWidth);
265
+ tableWidth = calcDefaultLayoutWidthByAppearance(tableNode, rendererAppearance);
263
266
  } else {
264
267
  tableWidth = (0, _styles.calcTableWidth)(layout, renderWidth, false);
265
268
  }
@@ -55,7 +55,7 @@ exports.NORMAL_SEVERITY_THRESHOLD = NORMAL_SEVERITY_THRESHOLD;
55
55
  var DEGRADED_SEVERITY_THRESHOLD = 3000;
56
56
  exports.DEGRADED_SEVERITY_THRESHOLD = DEGRADED_SEVERITY_THRESHOLD;
57
57
  var packageName = "@atlaskit/renderer";
58
- var packageVersion = "108.7.0";
58
+ var packageVersion = "108.7.2";
59
59
  var Renderer = /*#__PURE__*/function (_PureComponent) {
60
60
  (0, _inherits2.default)(Renderer, _PureComponent);
61
61
  var _super = _createSuper(Renderer);
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "108.7.0",
3
+ "version": "108.7.2",
4
4
  "sideEffects": false
5
5
  }
@@ -8,6 +8,7 @@ import { SortOrder } from '@atlaskit/editor-common/types';
8
8
  import { akEditorDefaultLayoutWidth } from '@atlaskit/editor-shared-styles';
9
9
  import { getBooleanFF } from '@atlaskit/platform-feature-flags';
10
10
  import { getTableContainerWidth } from '@atlaskit/editor-common/node-width';
11
+ import { akEditorFullWidthLayoutWidth } from '@atlaskit/editor-shared-styles';
11
12
  import { FullPagePadding } from '../../ui/Renderer/style';
12
13
  import { TableHeader } from './tableCell';
13
14
  import { withSmartCardStorage } from '../../ui/SmartCardStorage';
@@ -217,8 +218,11 @@ export class TableContainer extends React.Component {
217
218
  const lineLength = akEditorDefaultLayoutWidth;
218
219
  let tableWidth;
219
220
  let left;
221
+ const calcDefaultLayoutWidthByAppearance = (tableNode, rendererAppearance) => {
222
+ return rendererAppearance === 'full-width' && !tableNode.attrs.width ? Math.min(akEditorFullWidthLayoutWidth, renderWidth) : Math.min(getTableContainerWidth(tableNode), renderWidth);
223
+ };
220
224
  if (getBooleanFF('platform.editor.custom-table-width') && tableNode) {
221
- tableWidth = Math.min(getTableContainerWidth(tableNode), renderWidth);
225
+ tableWidth = calcDefaultLayoutWidthByAppearance(tableNode, rendererAppearance);
222
226
  } else {
223
227
  tableWidth = calcTableWidth(layout, renderWidth, false);
224
228
  }
@@ -35,7 +35,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
35
35
  export const NORMAL_SEVERITY_THRESHOLD = 2000;
36
36
  export const DEGRADED_SEVERITY_THRESHOLD = 3000;
37
37
  const packageName = "@atlaskit/renderer";
38
- const packageVersion = "108.7.0";
38
+ const packageVersion = "108.7.2";
39
39
  export class Renderer extends PureComponent {
40
40
  constructor(props) {
41
41
  super(props);
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "108.7.0",
3
+ "version": "108.7.2",
4
4
  "sideEffects": false
5
5
  }
@@ -16,6 +16,7 @@ import { SortOrder } from '@atlaskit/editor-common/types';
16
16
  import { akEditorDefaultLayoutWidth } from '@atlaskit/editor-shared-styles';
17
17
  import { getBooleanFF } from '@atlaskit/platform-feature-flags';
18
18
  import { getTableContainerWidth } from '@atlaskit/editor-common/node-width';
19
+ import { akEditorFullWidthLayoutWidth } from '@atlaskit/editor-shared-styles';
19
20
  import { FullPagePadding } from '../../ui/Renderer/style';
20
21
  import { TableHeader } from './tableCell';
21
22
  import { withSmartCardStorage } from '../../ui/SmartCardStorage';
@@ -251,8 +252,11 @@ export var TableContainer = /*#__PURE__*/function (_React$Component) {
251
252
  var lineLength = akEditorDefaultLayoutWidth;
252
253
  var tableWidth;
253
254
  var left;
255
+ var calcDefaultLayoutWidthByAppearance = function calcDefaultLayoutWidthByAppearance(tableNode, rendererAppearance) {
256
+ return rendererAppearance === 'full-width' && !tableNode.attrs.width ? Math.min(akEditorFullWidthLayoutWidth, renderWidth) : Math.min(getTableContainerWidth(tableNode), renderWidth);
257
+ };
254
258
  if (getBooleanFF('platform.editor.custom-table-width') && tableNode) {
255
- tableWidth = Math.min(getTableContainerWidth(tableNode), renderWidth);
259
+ tableWidth = calcDefaultLayoutWidthByAppearance(tableNode, rendererAppearance);
256
260
  } else {
257
261
  tableWidth = calcTableWidth(layout, renderWidth, false);
258
262
  }
@@ -45,7 +45,7 @@ import { RenderTracking } from '../../react/utils/performance/RenderTracking';
45
45
  export var NORMAL_SEVERITY_THRESHOLD = 2000;
46
46
  export var DEGRADED_SEVERITY_THRESHOLD = 3000;
47
47
  var packageName = "@atlaskit/renderer";
48
- var packageVersion = "108.7.0";
48
+ var packageVersion = "108.7.2";
49
49
  export var Renderer = /*#__PURE__*/function (_PureComponent) {
50
50
  _inherits(Renderer, _PureComponent);
51
51
  var _super = _createSuper(Renderer);
@@ -1,5 +1,5 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "108.7.0",
3
+ "version": "108.7.2",
4
4
  "sideEffects": false
5
5
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@atlaskit/renderer",
3
- "version": "108.7.0",
3
+ "version": "108.7.2",
4
4
  "description": "Renderer component",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/"
@@ -36,6 +36,7 @@
36
36
  "@atlaskit/editor-palette": "1.5.1",
37
37
  "@atlaskit/editor-shared-styles": "^2.4.0",
38
38
  "@atlaskit/emoji": "^67.4.0",
39
+ "@atlaskit/enforce-peer-dependencies": "^1.0.1",
39
40
  "@atlaskit/icon": "^21.12.0",
40
41
  "@atlaskit/link-datasource": "^0.28.0",
41
42
  "@atlaskit/media-card": "^76.1.0",
@@ -72,7 +73,7 @@
72
73
  "@af/visual-regression": "*",
73
74
  "@atlaskit/analytics-gas-types": "^5.1.0",
74
75
  "@atlaskit/css-reset": "^6.5.0",
75
- "@atlaskit/editor-core": "^186.0.0",
76
+ "@atlaskit/editor-core": "^187.0.0",
76
77
  "@atlaskit/editor-test-helpers": "^18.10.0",
77
78
  "@atlaskit/link-provider": "^1.6.0",
78
79
  "@atlaskit/link-test-helpers": "^4.1.0",
@@ -122,5 +123,8 @@
122
123
  "platform.editor.custom-table-width": {
123
124
  "type": "boolean"
124
125
  }
126
+ },
127
+ "scripts": {
128
+ "postinstall": "npx enforce-peer-dependencies --internal-packages"
125
129
  }
126
130
  }
@@ -1,546 +0,0 @@
1
- ## API Report File for "@atlaskit/renderer"
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 { ACTION } from '@atlaskit/editor-common/analytics';
10
- import { ACTION_SUBJECT } from '@atlaskit/editor-common/analytics';
11
- import { ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
12
- import type { ADFStage } from '@atlaskit/editor-common/validator';
13
- import type { AnnotationProviders } from '@atlaskit/editor-common/types';
14
- import { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
15
- import { DocNode } from '@atlaskit/adf-schema';
16
- import { EmojiResourceConfig } from '@atlaskit/emoji/resource';
17
- import { EVENT_TYPE } from '@atlaskit/editor-common/analytics';
18
- import type { EventHandlers } from '@atlaskit/editor-common/ui';
19
- import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
20
- import { Fragment } from 'prosemirror-model';
21
- import { jsx } from '@emotion/react';
22
- import { Mark } from 'prosemirror-model';
23
- import { MediaClientConfig } from '@atlaskit/media-core';
24
- import { MediaFeatureFlags } from '@atlaskit/media-common';
25
- import { Node as Node_2 } from 'prosemirror-model';
26
- import { OperationalAEP } from '@atlaskit/editor-common/analytics';
27
- import { PropsDifference } from '@atlaskit/editor-common/utils';
28
- import { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
29
- import { Schema } from 'prosemirror-model';
30
- import { SEVERITY } from '@atlaskit/editor-common/utils';
31
- import { ShallowPropsDifference } from '@atlaskit/editor-common/utils';
32
- import { SortOrder } from '@atlaskit/editor-common/types';
33
- import { SSR } from '@atlaskit/media-common';
34
- import type { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
35
- import { UNSUPPORTED_CONTENT_LEVEL_SEVERITY } from '@atlaskit/editor-common/utils';
36
- import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
37
- import type { UnsupportedContentPayload } from '@atlaskit/editor-common/utils';
38
- import type { UnsupportedContentTooltipPayload } from '@atlaskit/editor-common/utils';
39
-
40
- // @public (undocumented)
41
- export class ADFEncoder<T> {
42
- constructor(createTransformerWithSchema: TransformerProvider<T>);
43
- // (undocumented)
44
- encode: (value: T) => any;
45
- }
46
-
47
- // @public (undocumented)
48
- type AEP<Action, ActionSubject, ActionSubjectID, Attributes, EventType> = {
49
- action: Action;
50
- actionSubject: ActionSubject;
51
- actionSubjectId?: ActionSubjectID;
52
- attributes?: Attributes;
53
- eventType: EventType;
54
- };
55
-
56
- // @public (undocumented)
57
- type AnalyticsEventPayload<T = void> = AnchorLinkAEP | AnnotationAEP | AnnotationDeleteAEP | CodeBlockCopyAEP | CodeBlockWrapAEP | ComponentCrashErrorAEP | ExpandAEP | HeadingAnchorLinkButtonAEP | InvalidProsemirrorDocumentErrorAEP | MediaLnkTransformedAEP | RendererReRenderedAEP<T> | RendererRenderedAEP | RendererSelectAllCaughtAEP | RendererSelectAllEscapedAEP | RendererStartAEP | RendererTTIAEP | RendererUnsupportedContentLevelsTrackingErrored | RendererUnsupportedContentLevelsTrackingSucceeded | TableSortColumnAEP | TableSortColumnNotAllowedAEP | UnsupportedContentPayload | UnsupportedContentTooltipPayload | VisitLinkAEP | VisitMediaLinkAEP;
58
-
59
- // @public (undocumented)
60
- type AnchorLinkAEP = UIAEP<ACTION.VIEWED, ACTION_SUBJECT.ANCHOR_LINK, undefined, {
61
- platform: PLATFORM.WEB;
62
- mode: MODE.RENDERER;
63
- }>;
64
-
65
- // @public (undocumented)
66
- type AnnotationActionType = ACTION.CLOSED | ACTION.CREATE_NOT_ALLOWED | ACTION.DELETED | ACTION.EDITED | ACTION.INSERTED | ACTION.OPENED | ACTION.RESOLVED | ACTION.VIEWED;
67
-
68
- // @public (undocumented)
69
- type AnnotationAEP = AEP<AnnotationActionType, ACTION_SUBJECT.ANNOTATION, ACTION_SUBJECT_ID.INLINE_COMMENT, AnnotationAEPAttributes, undefined>;
70
-
71
- // @public (undocumented)
72
- type AnnotationAEPAttributes = AnnotationDraftAEPAttributes | AnnotationResolvedAEPAttributes;
73
-
74
- // @public (undocumented)
75
- type AnnotationDeleteAEP = AEP<AnnotationActionType, ACTION_SUBJECT.ANNOTATION, ACTION_SUBJECT_ID, undefined, EVENT_TYPE.TRACK>;
76
-
77
- // @public (undocumented)
78
- type AnnotationDraftAEPAttributes = {
79
- overlap?: number;
80
- };
81
-
82
- // @public (undocumented)
83
- type AnnotationResolvedAEPAttributes = {
84
- method?: RESOLVE_METHOD;
85
- };
86
-
87
- // @public (undocumented)
88
- type ButtonAEP<ActionSubjectID, Attributes> = UIAEP<ACTION.CLICKED, ACTION_SUBJECT.BUTTON, ActionSubjectID, Attributes>;
89
-
90
- // @public (undocumented)
91
- type CodeBlockCopyAEP = ButtonAEP<ACTION_SUBJECT_ID.CODEBLOCK_COPY, undefined>;
92
-
93
- // @public (undocumented)
94
- type CodeBlockWrapAEP = ButtonAEP<ACTION_SUBJECT_ID.CODEBLOCK_WRAP, {
95
- wrapped: boolean;
96
- }>;
97
-
98
- // @public (undocumented)
99
- type ComponentCrashErrorAEP = OperationalAEP<ACTION.CRASHED, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
100
- platform: PLATFORM.WEB;
101
- errorMessage?: string;
102
- errorStack?: string;
103
- componentStack?: string;
104
- errorRethrown?: boolean;
105
- }, {
106
- errorStack?: string;
107
- }>;
108
-
109
- // @public (undocumented)
110
- type DispatchAnalyticsEvent = (event: AnalyticsEventPayload) => void;
111
-
112
- // @public (undocumented)
113
- type ExpandAEP = AEP<ACTION.TOGGLE_EXPAND, ACTION_SUBJECT.EXPAND | ACTION_SUBJECT.NESTED_EXPAND, undefined, {
114
- platform: PLATFORM.WEB;
115
- mode: MODE.RENDERER;
116
- expanded: boolean;
117
- }, EVENT_TYPE.TRACK>;
118
-
119
- // @public (undocumented)
120
- type HeadingAnchorLinkButtonAEP = ButtonAEP<ACTION_SUBJECT_ID.HEADING_ANCHOR_LINK, undefined>;
121
-
122
- // @public (undocumented)
123
- type HeadingAnchorLinksConfig = {
124
- activeHeadingId?: string;
125
- allowNestedHeaderLinks?: boolean;
126
- };
127
-
128
- // @public (undocumented)
129
- export type HeadingAnchorLinksProps = HeadingAnchorLinksConfig | boolean;
130
-
131
- // @public (undocumented)
132
- type InvalidProsemirrorDocumentErrorAEP = AEP<ACTION.INVALID_PROSEMIRROR_DOCUMENT, ACTION_SUBJECT.RENDERER, ACTION_SUBJECT_ID, {
133
- platform: PLATFORM.WEB;
134
- errorStack?: string;
135
- }, EVENT_TYPE.OPERATIONAL>;
136
-
137
- // @public (undocumented)
138
- type MediaLnkTransformedAEP = AEP<ACTION.MEDIA_LINK_TRANSFORMED, ACTION_SUBJECT.RENDERER, undefined, undefined, EVENT_TYPE.OPERATIONAL>;
139
-
140
- // @public (undocumented)
141
- interface MediaOptions {
142
- // (undocumented)
143
- allowLinking?: boolean;
144
- // (undocumented)
145
- enableDownloadButton?: boolean;
146
- // (undocumented)
147
- featureFlags?: MediaFeatureFlags;
148
- // (undocumented)
149
- ssr?: MediaSSR;
150
- }
151
-
152
- // @public (undocumented)
153
- export type MediaSSR = {
154
- mode: SSR;
155
- config: MediaClientConfig;
156
- };
157
-
158
- // @public (undocumented)
159
- enum MODE {
160
- // (undocumented)
161
- EDITOR = "editor",
162
- // (undocumented)
163
- RENDERER = "renderer"
164
- }
165
-
166
- // @public (undocumented)
167
- type NodeComponentsProps = {
168
- [key: string]: React.ComponentType<any>;
169
- };
170
-
171
- // @public (undocumented)
172
- interface ParentInfo {
173
- // (undocumented)
174
- parentIsIncompleteTask: boolean;
175
- // (undocumented)
176
- path: Array<Node_2>;
177
- // (undocumented)
178
- pos: number;
179
- }
180
-
181
- // @public (undocumented)
182
- enum PLATFORM {
183
- // (undocumented)
184
- HYBRID = "mobileHybrid",
185
- // (undocumented)
186
- NATIVE = "mobileNative",
187
- // (undocumented)
188
- WEB = "web"
189
- }
190
-
191
- // @public (undocumented)
192
- interface RawObjectFeatureFlags {
193
- // (undocumented)
194
- ['renderer-render-tracking']: string;
195
- }
196
-
197
- // @public (undocumented)
198
- export const ReactRenderer: (props: RendererProps) => jsx.JSX.Element;
199
-
200
- // @public (undocumented)
201
- export class ReactSerializer implements Serializer<JSX.Element> {
202
- constructor(init: ReactSerializerInit);
203
- // (undocumented)
204
- static buildMarkStructure(content: Node_2[]): Mark[];
205
- // (undocumented)
206
- static fromSchema(_: unknown, init: ReactSerializerInit): ReactSerializer;
207
- // (undocumented)
208
- static getChildNodes(fragment: Fragment): (Node_2 | TextWrapper)[];
209
- // (undocumented)
210
- static getMarks(node: Node_2): Mark[];
211
- // (undocumented)
212
- serializeFragment(fragment: Fragment, props?: any, target?: any, key?: string, parentInfo?: ParentInfo): JSX.Element | null;
213
- }
214
-
215
- // @public (undocumented)
216
- interface ReactSerializerInit {
217
- // (undocumented)
218
- allowAltTextOnImages?: boolean;
219
- // (undocumented)
220
- allowAnnotations?: boolean;
221
- // (undocumented)
222
- allowColumnSorting?: boolean;
223
- // (undocumented)
224
- allowCopyToClipboard?: boolean;
225
- // (undocumented)
226
- allowCustomPanels?: boolean;
227
- // (undocumented)
228
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
229
- // (undocumented)
230
- allowMediaLinking?: boolean;
231
- // (undocumented)
232
- allowPlaceholderText?: boolean;
233
- // (undocumented)
234
- allowSelectAllTrap?: boolean;
235
- // (undocumented)
236
- allowWindowedCodeBlock?: boolean;
237
- // (undocumented)
238
- allowWrapCodeBlock?: boolean;
239
- // (undocumented)
240
- appearance?: RendererAppearance;
241
- // (undocumented)
242
- disableActions?: boolean;
243
- // (undocumented)
244
- disableHeadingIDs?: boolean;
245
- // (undocumented)
246
- emojiResourceConfig?: EmojiResourceConfig;
247
- // (undocumented)
248
- eventHandlers?: EventHandlers;
249
- // (undocumented)
250
- extensionHandlers?: ExtensionHandlers;
251
- // (undocumented)
252
- fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
253
- // (undocumented)
254
- media?: MediaOptions;
255
- // (undocumented)
256
- nodeComponents?: NodeComponentsProps;
257
- // (undocumented)
258
- objectContext?: RendererContext;
259
- // (undocumented)
260
- portal?: HTMLElement;
261
- // (undocumented)
262
- providers?: ProviderFactory;
263
- // (undocumented)
264
- shouldOpenMediaViewer?: boolean;
265
- // (undocumented)
266
- smartLinks?: SmartLinksOptions;
267
- // (undocumented)
268
- stickyHeaders?: StickyHeaderConfig;
269
- // (undocumented)
270
- surroundTextNodesWithTextWrapper?: boolean;
271
- }
272
-
273
- // @public (undocumented)
274
- export const renderDocument: <T>(doc: any, serializer: Serializer<T>, schema?: Schema, adfStage?: ADFStage, useSpecBasedValidator?: boolean, rendererId?: string, dispatchAnalyticsEvent?: DispatchAnalyticsEvent, unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking, appearance?: RendererAppearance) => RenderOutput<T | null>;
275
-
276
- // @public (undocumented)
277
- export type RendererAppearance = 'comment' | 'full-page' | 'full-width' | 'mobile' | undefined;
278
-
279
- // @public (undocumented)
280
- export interface RendererContext {
281
- // (undocumented)
282
- adDoc?: any;
283
- // (undocumented)
284
- containerAri?: string;
285
- // (undocumented)
286
- objectAri?: string;
287
- // (undocumented)
288
- schema?: Schema;
289
- }
290
-
291
- // @public (undocumented)
292
- export interface RendererProps {
293
- // (undocumented)
294
- adfStage?: ADFStage;
295
- // (undocumented)
296
- allowAltTextOnImages?: boolean;
297
- // (undocumented)
298
- allowAnnotations?: boolean;
299
- // (undocumented)
300
- allowColumnSorting?: boolean;
301
- // (undocumented)
302
- allowCopyToClipboard?: boolean;
303
- // (undocumented)
304
- allowCustomPanels?: boolean;
305
- // (undocumented)
306
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
307
- // (undocumented)
308
- allowPlaceholderText?: boolean;
309
- // (undocumented)
310
- allowSelectAllTrap?: boolean;
311
- // (undocumented)
312
- allowUgcScrubber?: boolean;
313
- // (undocumented)
314
- allowWrapCodeBlock?: boolean;
315
- // (undocumented)
316
- analyticsEventSeverityTracking?: {
317
- enabled: boolean;
318
- severityNormalThreshold: number;
319
- severityDegradedThreshold: number;
320
- };
321
- // (undocumented)
322
- annotationProvider?: AnnotationProviders | null;
323
- // (undocumented)
324
- appearance?: RendererAppearance;
325
- // (undocumented)
326
- createAnalyticsEvent?: CreateUIAnalyticsEvent;
327
- // (undocumented)
328
- dataProviders?: ProviderFactory;
329
- // (undocumented)
330
- disableActions?: boolean;
331
- // (undocumented)
332
- disableHeadingIDs?: boolean;
333
- // (undocumented)
334
- document: DocNode;
335
- // (undocumented)
336
- emojiResourceConfig?: EmojiResourceConfig;
337
- // (undocumented)
338
- enableSsrInlineScripts?: boolean;
339
- // (undocumented)
340
- eventHandlers?: EventHandlers;
341
- // (undocumented)
342
- extensionHandlers?: ExtensionHandlers;
343
- // (undocumented)
344
- fadeOutHeight?: number;
345
- featureFlags?: Partial<RawObjectFeatureFlags> | {
346
- [featureFlag: string]: boolean;
347
- };
348
- // (undocumented)
349
- innerRef?: React.RefObject<HTMLDivElement>;
350
- // (undocumented)
351
- maxHeight?: number;
352
- // (undocumented)
353
- media?: MediaOptions;
354
- // (undocumented)
355
- nodeComponents?: NodeComponentsProps;
356
- // (undocumented)
357
- onComplete?: (stat: RenderOutputStat) => void;
358
- // (undocumented)
359
- onError?: (error: any) => void;
360
- // (undocumented)
361
- portal?: HTMLElement;
362
- // (undocumented)
363
- rendererContext?: RendererContext;
364
- // (undocumented)
365
- schema?: Schema;
366
- // (undocumented)
367
- shouldOpenMediaViewer?: boolean;
368
- // (undocumented)
369
- smartLinks?: SmartLinksOptions;
370
- // (undocumented)
371
- stickyHeaders?: StickyHeaderProps;
372
- // (undocumented)
373
- truncated?: boolean;
374
- // (undocumented)
375
- unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking;
376
- // (undocumented)
377
- useSpecBasedValidator?: boolean;
378
- }
379
-
380
- // @public (undocumented)
381
- type RendererRenderedAEP = AEP<ACTION.RENDERED, ACTION_SUBJECT.RENDERER, undefined, {
382
- platform: PLATFORM.WEB;
383
- duration: number;
384
- distortedDuration: boolean;
385
- ttfb?: number;
386
- nodes: Record<string, number>;
387
- severity?: SEVERITY;
388
- }, EVENT_TYPE.OPERATIONAL>;
389
-
390
- // @public (undocumented)
391
- type RendererReRenderedAEP<Props> = AEP<ACTION.RE_RENDERED, ACTION_SUBJECT.RENDERER, undefined, {
392
- propsDifference: PropsDifference<Props> | ShallowPropsDifference<Props>;
393
- count: number;
394
- componentId?: string;
395
- }, EVENT_TYPE.OPERATIONAL>;
396
-
397
- // @public (undocumented)
398
- type RendererSelectAllCaughtAEP = AEP<ACTION.SELECT_ALL_CAUGHT, ACTION_SUBJECT.RENDERER, undefined, {
399
- platform: PLATFORM.WEB;
400
- }, EVENT_TYPE.TRACK>;
401
-
402
- // @public (undocumented)
403
- type RendererSelectAllEscapedAEP = AEP<ACTION.SELECT_ALL_ESCAPED, ACTION_SUBJECT.RENDERER, undefined, {
404
- platform: PLATFORM.WEB;
405
- }, EVENT_TYPE.TRACK>;
406
-
407
- // @public (undocumented)
408
- type RendererStartAEP = AEP<ACTION.STARTED, ACTION_SUBJECT.RENDERER, undefined, {
409
- platform: PLATFORM.WEB;
410
- }, EVENT_TYPE.UI>;
411
-
412
- // @public (undocumented)
413
- type RendererTTIAEP = AEP<ACTION.RENDERER_TTI, ACTION_SUBJECT.RENDERER, undefined, {
414
- tti: number;
415
- ttiFromInvocation: number;
416
- canceled: boolean;
417
- }, EVENT_TYPE.OPERATIONAL>;
418
-
419
- // @public (undocumented)
420
- type RendererUnsupportedContentLevelsTrackingErrored = AEP<ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_ERRORED, ACTION_SUBJECT.RENDERER, undefined, {
421
- platform: PLATFORM.WEB;
422
- error: string;
423
- }, EVENT_TYPE.OPERATIONAL>;
424
-
425
- // @public (undocumented)
426
- type RendererUnsupportedContentLevelsTrackingSucceeded = AEP<ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_SUCCEEDED, ACTION_SUBJECT.RENDERER, undefined, {
427
- appearance?: string;
428
- platform: PLATFORM.WEB;
429
- unsupportedContentLevelSeverity: UNSUPPORTED_CONTENT_LEVEL_SEVERITY;
430
- unsupportedContentLevelPercentage: number;
431
- unsupportedNodesCount: number;
432
- supportedNodesCount: number;
433
- }, EVENT_TYPE.OPERATIONAL>;
434
-
435
- // @public (undocumented)
436
- interface RenderOutput<T> {
437
- // (undocumented)
438
- pmDoc?: Node_2;
439
- // (undocumented)
440
- result: T;
441
- // (undocumented)
442
- stat: RenderOutputStat;
443
- }
444
-
445
- // @public (undocumented)
446
- export interface RenderOutputStat {
447
- // (undocumented)
448
- buildTreeTime?: number;
449
- // (undocumented)
450
- sanitizeTime: number;
451
- // (undocumented)
452
- serializeTime?: number;
453
- }
454
-
455
- // @public (undocumented)
456
- enum RESOLVE_METHOD {
457
- // (undocumented)
458
- COMPONENT = "component",
459
- // (undocumented)
460
- CONSUMER = "consumer",
461
- // (undocumented)
462
- ORPHANED = "orphaned"
463
- }
464
-
465
- // @public (undocumented)
466
- export interface Serializer<T> {
467
- // (undocumented)
468
- serializeFragment(fragment: Fragment, props?: any, target?: any, key?: string): T | null;
469
- }
470
-
471
- // @public (undocumented)
472
- interface SmartLinksOptions {
473
- // (undocumented)
474
- showAuthTooltip?: boolean;
475
- // (undocumented)
476
- showServerActions?: boolean;
477
- // (undocumented)
478
- ssr?: boolean;
479
- }
480
-
481
- // @public (undocumented)
482
- type StickyHeaderConfig = {
483
- offsetTop?: number;
484
- };
485
-
486
- // @public (undocumented)
487
- type StickyHeaderProps = ({
488
- show?: boolean;
489
- } & StickyHeaderConfig) | boolean;
490
-
491
- // @public (undocumented)
492
- type TableSortColumnAEP = AEP<ACTION.SORT_COLUMN, ACTION_SUBJECT.TABLE, undefined, {
493
- platform: PLATFORM.WEB;
494
- mode: MODE.RENDERER;
495
- sortOrder: SortOrder;
496
- columnIndex: number;
497
- }, EVENT_TYPE.TRACK>;
498
-
499
- // @public (undocumented)
500
- type TableSortColumnNotAllowedAEP = AEP<ACTION.SORT_COLUMN_NOT_ALLOWED, ACTION_SUBJECT.TABLE, undefined, {
501
- platform: PLATFORM.WEB;
502
- mode: MODE.RENDERER;
503
- }, EVENT_TYPE.TRACK>;
504
-
505
- // @public (undocumented)
506
- export class TextSerializer implements Serializer<string> {
507
- constructor(schema: Schema);
508
- // (undocumented)
509
- static fromSchema(schema?: Schema): TextSerializer;
510
- // (undocumented)
511
- serializeFragment(fragment: Fragment): string;
512
- }
513
-
514
- // @public (undocumented)
515
- interface TextWrapper {
516
- // (undocumented)
517
- content: Node_2[];
518
- // (undocumented)
519
- nodeSize: number;
520
- // (undocumented)
521
- type: {
522
- name: 'textWrapper';
523
- };
524
- }
525
-
526
- // @public (undocumented)
527
- type TransformerProvider<T> = (schema: Schema) => Transformer_2<T>;
528
-
529
- // @public (undocumented)
530
- type UIAEP<Action, ActionSubject, ActionSubjectID, Attributes> = AEP<Action, ActionSubject, ActionSubjectID, Attributes, EVENT_TYPE.UI>;
531
-
532
- // @public (undocumented)
533
- type VisitLinkAEP = AEP<ACTION.VISITED, ACTION_SUBJECT.LINK, undefined, {
534
- platform: PLATFORM.WEB;
535
- mode: MODE.RENDERER;
536
- }, EVENT_TYPE.TRACK>;
537
-
538
- // @public (undocumented)
539
- type VisitMediaLinkAEP = AEP<ACTION.VISITED, ACTION_SUBJECT.MEDIA, ACTION_SUBJECT_ID.LINK, {
540
- platform: PLATFORM.WEB;
541
- mode: MODE.RENDERER;
542
- }, EVENT_TYPE.TRACK>;
543
-
544
- // (No @packageDocumentation comment for this package)
545
-
546
- ```