@atlaskit/renderer 137.1.10 → 137.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/dist/cjs/actions/index.js +2 -2
  3. package/dist/cjs/react/index.js +2 -2
  4. package/dist/cjs/react/marks/breakout.js +3 -3
  5. package/dist/cjs/react/marks/code.js +1 -1
  6. package/dist/cjs/react/nodes/date.js +1 -1
  7. package/dist/cjs/react/nodes/embedCard.js +2 -2
  8. package/dist/cjs/react/nodes/heading-anchor.js +1 -1
  9. package/dist/cjs/react/nodes/layoutSection.js +2 -2
  10. package/dist/cjs/react/nodes/mediaInline.js +1 -1
  11. package/dist/cjs/react/nodes/mediaSingle/index.js +1 -1
  12. package/dist/cjs/react/nodes/table.js +3 -3
  13. package/dist/cjs/ui/Expand.js +1 -1
  14. package/dist/cjs/ui/Renderer/RendererStyleContainer.js +3 -3
  15. package/dist/cjs/ui/Renderer/index.js +5 -5
  16. package/dist/cjs/utils.js +2 -2
  17. package/dist/es2019/actions/index.js +1 -1
  18. package/dist/es2019/react/index.js +1 -1
  19. package/dist/es2019/react/marks/breakout.js +1 -1
  20. package/dist/es2019/react/marks/code.js +1 -1
  21. package/dist/es2019/react/nodes/date.js +1 -1
  22. package/dist/es2019/react/nodes/embedCard.js +1 -1
  23. package/dist/es2019/react/nodes/heading-anchor.js +1 -1
  24. package/dist/es2019/react/nodes/layoutSection.js +1 -1
  25. package/dist/es2019/react/nodes/mediaInline.js +1 -1
  26. package/dist/es2019/react/nodes/mediaSingle/index.js +1 -1
  27. package/dist/es2019/react/nodes/table.js +1 -1
  28. package/dist/es2019/ui/Expand.js +1 -1
  29. package/dist/es2019/ui/Renderer/RendererStyleContainer.js +1 -1
  30. package/dist/es2019/ui/Renderer/index.js +2 -2
  31. package/dist/es2019/utils.js +1 -1
  32. package/dist/esm/actions/index.js +1 -1
  33. package/dist/esm/react/index.js +1 -1
  34. package/dist/esm/react/marks/breakout.js +1 -1
  35. package/dist/esm/react/marks/code.js +1 -1
  36. package/dist/esm/react/nodes/date.js +1 -1
  37. package/dist/esm/react/nodes/embedCard.js +1 -1
  38. package/dist/esm/react/nodes/heading-anchor.js +1 -1
  39. package/dist/esm/react/nodes/layoutSection.js +1 -1
  40. package/dist/esm/react/nodes/mediaInline.js +1 -1
  41. package/dist/esm/react/nodes/mediaSingle/index.js +1 -1
  42. package/dist/esm/react/nodes/table.js +1 -1
  43. package/dist/esm/ui/Expand.js +1 -1
  44. package/dist/esm/ui/Renderer/RendererStyleContainer.js +1 -1
  45. package/dist/esm/ui/Renderer/index.js +2 -2
  46. package/dist/esm/utils.js +1 -1
  47. package/package.json +55 -54
  48. package/report.api.md +0 -766
package/report.api.md DELETED
@@ -1,766 +0,0 @@
1
- <!-- API Report Version: 2.3 -->
2
-
3
- ## API Report File for "@atlaskit/renderer"
4
-
5
- > Do not edit this file. This report is auto-generated using
6
- > [API Extractor](https://api-extractor.com/).
7
- > [Learn more about API reports](https://hello.atlassian.net/wiki/spaces/UR/pages/1825484529/Package+API+Reports)
8
-
9
- ### Table of contents
10
-
11
- - [Main Entry Types](#main-entry-types)
12
- - [Peer Dependencies](#peer-dependencies)
13
-
14
- ### Main Entry Types
15
-
16
- <!--SECTION START: Main Entry Types-->
17
-
18
- ```ts
19
- /// <reference types="react" />
20
-
21
- import { ACTION } from '@atlaskit/editor-common/analytics';
22
- import { ACTION_SUBJECT } from '@atlaskit/editor-common/analytics';
23
- import { ACTION_SUBJECT_ID } from '@atlaskit/editor-common/analytics';
24
- import type { ADFStage } from '@atlaskit/editor-common/validator';
25
- import type { AnnotationProviders } from '@atlaskit/editor-common/types';
26
- import type { CardProps } from '@atlaskit/smart-card';
27
- import type { CreateUIAnalyticsEvent } from '@atlaskit/analytics-next';
28
- import type { DocNode } from '@atlaskit/adf-schema';
29
- import type { EmojiProviderLookupOrder } from '@atlaskit/emoji/resource';
30
- import type { EmojiResourceConfig } from '@atlaskit/emoji/resource';
31
- import { EVENT_TYPE } from '@atlaskit/editor-common/analytics';
32
- import type { EventHandlers } from '@atlaskit/editor-common/ui';
33
- import type { ExtensionHandlers } from '@atlaskit/editor-common/extensions';
34
- import { Fragment } from '@atlaskit/editor-prosemirror/model';
35
- import { jsx } from '@emotion/react';
36
- import type { Mark } from '@atlaskit/editor-prosemirror/model';
37
- import type { MediaClientConfig } from '@atlaskit/media-core';
38
- import type { MediaFeatureFlags } from '@atlaskit/media-common';
39
- import { Node as Node_2 } from '@atlaskit/editor-prosemirror/model';
40
- import { OperationalAEP } from '@atlaskit/editor-common/analytics';
41
- import { PropsDifference } from '@atlaskit/editor-common/utils';
42
- import type { ProviderFactory } from '@atlaskit/editor-common/provider-factory';
43
- import { Schema } from '@atlaskit/editor-prosemirror/model';
44
- import { SEVERITY } from '@atlaskit/editor-common/utils';
45
- import { ShallowPropsDifference } from '@atlaskit/editor-common/utils';
46
- import { SortOrder } from '@atlaskit/editor-common/types';
47
- import type { SSR } from '@atlaskit/media-common';
48
- import type { Transformer as Transformer_2 } from '@atlaskit/editor-common/types';
49
- import { UNSUPPORTED_CONTENT_LEVEL_SEVERITY } from '@atlaskit/editor-common/utils';
50
- import type { UnsupportedContentLevelsTracking } from '@atlaskit/editor-common/utils';
51
- import type { UnsupportedContentPayload } from '@atlaskit/editor-common/utils';
52
- import type { UnsupportedContentTooltipPayload } from '@atlaskit/editor-common/utils';
53
-
54
- // @public (undocumented)
55
- export class ADFEncoder<T> {
56
- constructor(createTransformerWithSchema: TransformerProvider<T>);
57
- // (undocumented)
58
- encode: (value: T) => any;
59
- }
60
-
61
- // @public (undocumented)
62
- type AEP<Action, ActionSubject, ActionSubjectID, Attributes, EventType> = {
63
- action: Action;
64
- actionSubject: ActionSubject;
65
- actionSubjectId?: ActionSubjectID;
66
- attributes?: Attributes;
67
- eventType: EventType;
68
- };
69
-
70
- // @public (undocumented)
71
- type AnalyticsEventPayload<T = void> =
72
- | AnchorLinkAEP
73
- | AnnotationAEP
74
- | AnnotationDeleteAEP
75
- | CodeBlockCopyAEP
76
- | CodeBlockWrapAEP
77
- | ComponentCrashErrorAEP
78
- | ExpandAEP
79
- | HeadingAnchorLinkButtonAEP
80
- | InvalidProsemirrorDocumentErrorAEP
81
- | MediaLnkTransformedAEP
82
- | RendererReRenderedAEP<T>
83
- | RendererRenderedAEP
84
- | RendererSelectAllCaughtAEP
85
- | RendererSelectAllEscapedAEP
86
- | RendererStartAEP
87
- | RendererTTIAEP
88
- | RendererUnsupportedContentLevelsTrackingErrored
89
- | RendererUnsupportedContentLevelsTrackingSucceeded
90
- | TableSortColumnAEP
91
- | TableSortColumnNotAllowedAEP
92
- | UnsupportedContentPayload
93
- | UnsupportedContentTooltipPayload
94
- | VisitLinkAEP
95
- | VisitMediaLinkAEP;
96
-
97
- // @public (undocumented)
98
- type AnchorLinkAEP = UIAEP<
99
- ACTION.VIEWED,
100
- ACTION_SUBJECT.ANCHOR_LINK,
101
- undefined,
102
- {
103
- platform: PLATFORM.WEB;
104
- mode: MODE.RENDERER;
105
- }
106
- >;
107
-
108
- // @public (undocumented)
109
- type AnnotationActionType =
110
- | ACTION.CLOSED
111
- | ACTION.CREATE_NOT_ALLOWED
112
- | ACTION.DELETED
113
- | ACTION.EDITED
114
- | ACTION.INSERTED
115
- | ACTION.OPENED
116
- | ACTION.RESOLVED
117
- | ACTION.VIEWED;
118
-
119
- // @public (undocumented)
120
- type AnnotationAEP = AEP<
121
- AnnotationActionType,
122
- ACTION_SUBJECT.ANNOTATION,
123
- ACTION_SUBJECT_ID.INLINE_COMMENT,
124
- AnnotationAEPAttributes,
125
- undefined
126
- >;
127
-
128
- // @public (undocumented)
129
- type AnnotationAEPAttributes = AnnotationDraftAEPAttributes | AnnotationResolvedAEPAttributes;
130
-
131
- // @public (undocumented)
132
- type AnnotationDeleteAEP = AEP<
133
- AnnotationActionType,
134
- ACTION_SUBJECT.ANNOTATION,
135
- ACTION_SUBJECT_ID,
136
- undefined,
137
- EVENT_TYPE.TRACK
138
- >;
139
-
140
- // @public (undocumented)
141
- type AnnotationDraftAEPAttributes = {
142
- overlap?: number;
143
- };
144
-
145
- // @public (undocumented)
146
- type AnnotationResolvedAEPAttributes = {
147
- method?: RESOLVE_METHOD;
148
- };
149
-
150
- // @public (undocumented)
151
- type ButtonAEP<ActionSubjectID, Attributes> = UIAEP<
152
- ACTION.CLICKED,
153
- ACTION_SUBJECT.BUTTON,
154
- ActionSubjectID,
155
- Attributes
156
- >;
157
-
158
- // @public (undocumented)
159
- type CodeBlockCopyAEP = ButtonAEP<ACTION_SUBJECT_ID.CODEBLOCK_COPY, undefined>;
160
-
161
- // @public (undocumented)
162
- type CodeBlockWrapAEP = ButtonAEP<
163
- ACTION_SUBJECT_ID.CODEBLOCK_WRAP,
164
- {
165
- wrapped: boolean;
166
- }
167
- >;
168
-
169
- // @public (undocumented)
170
- type ComponentCrashErrorAEP = OperationalAEP<
171
- ACTION.CRASHED,
172
- ACTION_SUBJECT.RENDERER,
173
- ACTION_SUBJECT_ID,
174
- {
175
- platform: PLATFORM.WEB;
176
- errorMessage?: string;
177
- errorStack?: string;
178
- componentStack?: string;
179
- errorRethrown?: boolean;
180
- },
181
- {
182
- errorStack?: string;
183
- }
184
- >;
185
-
186
- // @public (undocumented)
187
- type DispatchAnalyticsEvent = (event: AnalyticsEventPayload) => void;
188
-
189
- // @public (undocumented)
190
- type ExpandAEP = AEP<
191
- ACTION.TOGGLE_EXPAND,
192
- ACTION_SUBJECT.EXPAND | ACTION_SUBJECT.NESTED_EXPAND,
193
- undefined,
194
- {
195
- platform: PLATFORM.WEB;
196
- mode: MODE.RENDERER;
197
- expanded: boolean;
198
- },
199
- EVENT_TYPE.TRACK
200
- >;
201
-
202
- // @public (undocumented)
203
- type HeadingAnchorLinkButtonAEP = ButtonAEP<ACTION_SUBJECT_ID.HEADING_ANCHOR_LINK, undefined>;
204
-
205
- // @public (undocumented)
206
- type HeadingAnchorLinksConfig = {
207
- activeHeadingId?: string;
208
- allowNestedHeaderLinks?: boolean;
209
- };
210
-
211
- // @public (undocumented)
212
- export type HeadingAnchorLinksProps = HeadingAnchorLinksConfig | boolean;
213
-
214
- // @public (undocumented)
215
- type InvalidProsemirrorDocumentErrorAEP = AEP<
216
- ACTION.INVALID_PROSEMIRROR_DOCUMENT,
217
- ACTION_SUBJECT.RENDERER,
218
- ACTION_SUBJECT_ID,
219
- {
220
- platform: PLATFORM.WEB;
221
- errorStack?: string;
222
- },
223
- EVENT_TYPE.OPERATIONAL
224
- >;
225
-
226
- // @public (undocumented)
227
- type MediaLnkTransformedAEP = AEP<
228
- ACTION.MEDIA_LINK_TRANSFORMED,
229
- ACTION_SUBJECT.RENDERER,
230
- undefined,
231
- undefined,
232
- EVENT_TYPE.OPERATIONAL
233
- >;
234
-
235
- // @public (undocumented)
236
- interface MediaOptions {
237
- // (undocumented)
238
- allowCaptions?: boolean;
239
- // (undocumented)
240
- allowLinking?: boolean;
241
- // (undocumented)
242
- enableDownloadButton?: boolean;
243
- // (undocumented)
244
- featureFlags?: MediaFeatureFlags;
245
- // (undocumented)
246
- ssr?: MediaSSR;
247
- }
248
-
249
- // @public (undocumented)
250
- export type MediaSSR = {
251
- mode: SSR;
252
- config: MediaClientConfig;
253
- };
254
-
255
- // @public (undocumented)
256
- enum MODE {
257
- // (undocumented)
258
- EDITOR = 'editor',
259
- // (undocumented)
260
- RENDERER = 'renderer',
261
- }
262
-
263
- // @public (undocumented)
264
- type NodeComponentsProps = {
265
- [key: string]: React.ComponentType<any>;
266
- };
267
-
268
- // @public (undocumented)
269
- interface ParentInfo {
270
- // (undocumented)
271
- parentIsIncompleteTask: boolean;
272
- // (undocumented)
273
- path: Array<Node_2>;
274
- // (undocumented)
275
- pos: number;
276
- }
277
-
278
- // @public (undocumented)
279
- enum PLATFORM {
280
- // (undocumented)
281
- HYBRID = 'mobileHybrid',
282
- // (undocumented)
283
- NATIVE = 'mobileNative',
284
- // (undocumented)
285
- WEB = 'web',
286
- }
287
-
288
- // @public (undocumented)
289
- interface RawObjectFeatureFlags {
290
- // (undocumented)
291
- ['renderer-render-tracking']: string;
292
- }
293
-
294
- // @public (undocumented)
295
- export const ReactRenderer: (props: RendererProps) => jsx.JSX.Element;
296
-
297
- // @public (undocumented)
298
- export class ReactSerializer implements Serializer<JSX.Element> {
299
- constructor(init: ReactSerializerInit);
300
- // (undocumented)
301
- static buildMarkStructure(content: Node_2[]): Mark[];
302
- // (undocumented)
303
- static fromSchema(_: unknown, init: ReactSerializerInit): ReactSerializer;
304
- // (undocumented)
305
- static getChildNodes(fragment: Fragment): (Node_2 | TextWrapper)[];
306
- // (undocumented)
307
- static getMarks(node: Node_2): Mark[];
308
- // (undocumented)
309
- serializeFragment(
310
- fragment: Fragment,
311
- props?: any,
312
- target?: any,
313
- key?: string,
314
- parentInfo?: ParentInfo,
315
- ): JSX.Element | null;
316
- }
317
-
318
- // @public (undocumented)
319
- interface ReactSerializerInit {
320
- // (undocumented)
321
- allowAltTextOnImages?: boolean;
322
- // (undocumented)
323
- allowAnnotations?: boolean;
324
- // (undocumented)
325
- allowColumnSorting?: boolean;
326
- // (undocumented)
327
- allowCopyToClipboard?: boolean;
328
- // (undocumented)
329
- allowCustomPanels?: boolean;
330
- // (undocumented)
331
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
332
- // (undocumented)
333
- allowMediaLinking?: boolean;
334
- // (undocumented)
335
- allowPlaceholderText?: boolean;
336
- // (undocumented)
337
- allowSelectAllTrap?: boolean;
338
- // (undocumented)
339
- allowWindowedCodeBlock?: boolean;
340
- // (undocumented)
341
- allowWrapCodeBlock?: boolean;
342
- // (undocumented)
343
- appearance?: RendererAppearance;
344
- // (undocumented)
345
- disableActions?: boolean;
346
- // (undocumented)
347
- disableHeadingIDs?: boolean;
348
- // (undocumented)
349
- emojiProviderLookupOrder?: EmojiProviderLookupOrder;
350
- // (undocumented)
351
- emojiResourceConfig?: EmojiResourceConfig;
352
- // (undocumented)
353
- eventHandlers?: EventHandlers;
354
- // (undocumented)
355
- extensionHandlers?: ExtensionHandlers;
356
- // (undocumented)
357
- fireAnalyticsEvent?: (event: AnalyticsEventPayload) => void;
358
- // (undocumented)
359
- media?: MediaOptions;
360
- // (undocumented)
361
- nodeComponents?: NodeComponentsProps;
362
- // (undocumented)
363
- objectContext?: RendererContext;
364
- // (undocumented)
365
- portal?: HTMLElement;
366
- // (undocumented)
367
- providers?: ProviderFactory;
368
- // (undocumented)
369
- shouldOpenMediaViewer?: boolean;
370
- // (undocumented)
371
- smartLinks?: SmartLinksOptions;
372
- // (undocumented)
373
- stickyHeaders?: StickyHeaderConfig;
374
- // (undocumented)
375
- surroundTextNodesWithTextWrapper?: boolean;
376
- }
377
-
378
- // @public (undocumented)
379
- export const renderDocument: <T>(
380
- doc: any,
381
- serializer: Serializer<T>,
382
- schema?: Schema,
383
- adfStage?: ADFStage,
384
- useSpecBasedValidator?: boolean,
385
- rendererId?: string,
386
- dispatchAnalyticsEvent?: DispatchAnalyticsEvent,
387
- unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking,
388
- appearance?: RendererAppearance,
389
- ) => RenderOutput<T | null>;
390
-
391
- // @public (undocumented)
392
- export type RendererAppearance = 'comment' | 'full-page' | 'full-width' | 'mobile' | undefined;
393
-
394
- // @public (undocumented)
395
- export interface RendererContext {
396
- // (undocumented)
397
- adDoc?: any;
398
- // (undocumented)
399
- containerAri?: string;
400
- // (undocumented)
401
- objectAri?: string;
402
- // (undocumented)
403
- schema?: Schema;
404
- }
405
-
406
- // @public (undocumented)
407
- export interface RendererProps {
408
- addTelepointer?: boolean;
409
- // (undocumented)
410
- adfStage?: ADFStage;
411
- // (undocumented)
412
- allowAltTextOnImages?: boolean;
413
- // (undocumented)
414
- allowAnnotations?: boolean;
415
- // (undocumented)
416
- allowColumnSorting?: boolean;
417
- // (undocumented)
418
- allowCopyToClipboard?: boolean;
419
- // (undocumented)
420
- allowCustomPanels?: boolean;
421
- // (undocumented)
422
- allowHeadingAnchorLinks?: HeadingAnchorLinksProps;
423
- // (undocumented)
424
- allowPlaceholderText?: boolean;
425
- // (undocumented)
426
- allowSelectAllTrap?: boolean;
427
- // (undocumented)
428
- allowUgcScrubber?: boolean;
429
- // (undocumented)
430
- allowWrapCodeBlock?: boolean;
431
- // (undocumented)
432
- analyticsEventSeverityTracking?: {
433
- enabled: boolean;
434
- severityNormalThreshold: number;
435
- severityDegradedThreshold: number;
436
- };
437
- // (undocumented)
438
- annotationProvider?: AnnotationProviders | null;
439
- // (undocumented)
440
- appearance?: RendererAppearance;
441
- // (undocumented)
442
- createAnalyticsEvent?: CreateUIAnalyticsEvent;
443
- // (undocumented)
444
- dataProviders?: ProviderFactory;
445
- // (undocumented)
446
- disableActions?: boolean;
447
- // (undocumented)
448
- disableHeadingIDs?: boolean;
449
- // (undocumented)
450
- document: DocNode;
451
- // (undocumented)
452
- emojiProviderLookupOrder?: EmojiProviderLookupOrder;
453
- // (undocumented)
454
- emojiResourceConfig?: EmojiResourceConfig;
455
- // (undocumented)
456
- enableSsrInlineScripts?: boolean;
457
- // (undocumented)
458
- eventHandlers?: EventHandlers;
459
- // (undocumented)
460
- extensionHandlers?: ExtensionHandlers;
461
- // (undocumented)
462
- fadeOutHeight?: number;
463
- featureFlags?:
464
- | Partial<RawObjectFeatureFlags>
465
- | {
466
- [featureFlag: string]: boolean;
467
- };
468
- // (undocumented)
469
- innerRef?: React.RefObject<HTMLDivElement>;
470
- // (undocumented)
471
- maxHeight?: number;
472
- // (undocumented)
473
- media?: MediaOptions;
474
- // (undocumented)
475
- nodeComponents?: NodeComponentsProps;
476
- // (undocumented)
477
- onComplete?: (stat: RenderOutputStat) => void;
478
- // (undocumented)
479
- onError?: (error: any) => void;
480
- // (undocumented)
481
- portal?: HTMLElement;
482
- // (undocumented)
483
- rendererContext?: RendererContext;
484
- // (undocumented)
485
- schema?: Schema;
486
- // (undocumented)
487
- shouldOpenMediaViewer?: boolean;
488
- // (undocumented)
489
- smartLinks?: SmartLinksOptions;
490
- // (undocumented)
491
- stickyHeaders?: StickyHeaderProps;
492
- // (undocumented)
493
- truncated?: boolean;
494
- // (undocumented)
495
- unsupportedContentLevelsTracking?: UnsupportedContentLevelsTracking;
496
- // @deprecated (undocumented)
497
- useSpecBasedValidator?: boolean;
498
- }
499
-
500
- // @public (undocumented)
501
- type RendererRenderedAEP = AEP<
502
- ACTION.RENDERED,
503
- ACTION_SUBJECT.RENDERER,
504
- undefined,
505
- {
506
- platform: PLATFORM.WEB;
507
- duration: number;
508
- distortedDuration: boolean;
509
- ttfb?: number;
510
- nodes: Record<string, number>;
511
- severity?: SEVERITY;
512
- },
513
- EVENT_TYPE.OPERATIONAL
514
- >;
515
-
516
- // @public (undocumented)
517
- type RendererReRenderedAEP<Props> = AEP<
518
- ACTION.RE_RENDERED,
519
- ACTION_SUBJECT.RENDERER,
520
- undefined,
521
- {
522
- propsDifference: PropsDifference<Props> | ShallowPropsDifference<Props>;
523
- count: number;
524
- componentId?: string;
525
- },
526
- EVENT_TYPE.OPERATIONAL
527
- >;
528
-
529
- // @public (undocumented)
530
- type RendererSelectAllCaughtAEP = AEP<
531
- ACTION.SELECT_ALL_CAUGHT,
532
- ACTION_SUBJECT.RENDERER,
533
- undefined,
534
- {
535
- platform: PLATFORM.WEB;
536
- },
537
- EVENT_TYPE.TRACK
538
- >;
539
-
540
- // @public (undocumented)
541
- type RendererSelectAllEscapedAEP = AEP<
542
- ACTION.SELECT_ALL_ESCAPED,
543
- ACTION_SUBJECT.RENDERER,
544
- undefined,
545
- {
546
- platform: PLATFORM.WEB;
547
- },
548
- EVENT_TYPE.TRACK
549
- >;
550
-
551
- // @public (undocumented)
552
- type RendererStartAEP = AEP<
553
- ACTION.STARTED,
554
- ACTION_SUBJECT.RENDERER,
555
- undefined,
556
- {
557
- platform: PLATFORM.WEB;
558
- },
559
- EVENT_TYPE.UI
560
- >;
561
-
562
- // @public (undocumented)
563
- type RendererTTIAEP = AEP<
564
- ACTION.RENDERER_TTI,
565
- ACTION_SUBJECT.RENDERER,
566
- undefined,
567
- {
568
- tti: number;
569
- ttiFromInvocation: number;
570
- canceled: boolean;
571
- },
572
- EVENT_TYPE.OPERATIONAL
573
- >;
574
-
575
- // @public (undocumented)
576
- type RendererUnsupportedContentLevelsTrackingErrored = AEP<
577
- ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_ERRORED,
578
- ACTION_SUBJECT.RENDERER,
579
- undefined,
580
- {
581
- platform: PLATFORM.WEB;
582
- error: string;
583
- },
584
- EVENT_TYPE.OPERATIONAL
585
- >;
586
-
587
- // @public (undocumented)
588
- type RendererUnsupportedContentLevelsTrackingSucceeded = AEP<
589
- ACTION.UNSUPPORTED_CONTENT_LEVELS_TRACKING_SUCCEEDED,
590
- ACTION_SUBJECT.RENDERER,
591
- undefined,
592
- {
593
- appearance?: string;
594
- platform: PLATFORM.WEB;
595
- unsupportedContentLevelSeverity: UNSUPPORTED_CONTENT_LEVEL_SEVERITY;
596
- unsupportedContentLevelPercentage: number;
597
- unsupportedNodesCount: number;
598
- supportedNodesCount: number;
599
- },
600
- EVENT_TYPE.OPERATIONAL
601
- >;
602
-
603
- // @public (undocumented)
604
- interface RenderOutput<T> {
605
- // (undocumented)
606
- pmDoc?: Node_2;
607
- // (undocumented)
608
- result: T;
609
- // (undocumented)
610
- stat: RenderOutputStat;
611
- }
612
-
613
- // @public (undocumented)
614
- export interface RenderOutputStat {
615
- // (undocumented)
616
- buildTreeTime?: number;
617
- // (undocumented)
618
- sanitizeTime: number;
619
- // (undocumented)
620
- serializeTime?: number;
621
- }
622
-
623
- // @public (undocumented)
624
- enum RESOLVE_METHOD {
625
- // (undocumented)
626
- COMPONENT = 'component',
627
- // (undocumented)
628
- CONSUMER = 'consumer',
629
- // (undocumented)
630
- ORPHANED = 'orphaned',
631
- }
632
-
633
- // @public (undocumented)
634
- export interface Serializer<T> {
635
- // (undocumented)
636
- serializeFragment(fragment: Fragment, props?: any, target?: any, key?: string): T | null;
637
- }
638
-
639
- // @public (undocumented)
640
- interface SmartLinksOptions {
641
- // (undocumented)
642
- frameStyle?: CardProps['frameStyle'];
643
- // (undocumented)
644
- hideHoverPreview?: boolean;
645
- // (undocumented)
646
- showAuthTooltip?: boolean;
647
- // (undocumented)
648
- showServerActions?: boolean;
649
- // (undocumented)
650
- ssr?: boolean;
651
- }
652
-
653
- // @public (undocumented)
654
- type StickyHeaderConfig = {
655
- offsetTop?: number;
656
- };
657
-
658
- // @public (undocumented)
659
- export type StickyHeaderProps =
660
- | ({
661
- show?: boolean;
662
- } & StickyHeaderConfig)
663
- | boolean;
664
-
665
- // @public (undocumented)
666
- type TableSortColumnAEP = AEP<
667
- ACTION.SORT_COLUMN,
668
- ACTION_SUBJECT.TABLE,
669
- undefined,
670
- {
671
- platform: PLATFORM.WEB;
672
- mode: MODE.RENDERER;
673
- sortOrder: SortOrder;
674
- columnIndex: number;
675
- },
676
- EVENT_TYPE.TRACK
677
- >;
678
-
679
- // @public (undocumented)
680
- type TableSortColumnNotAllowedAEP = AEP<
681
- ACTION.SORT_COLUMN_NOT_ALLOWED,
682
- ACTION_SUBJECT.TABLE,
683
- undefined,
684
- {
685
- platform: PLATFORM.WEB;
686
- mode: MODE.RENDERER;
687
- },
688
- EVENT_TYPE.TRACK
689
- >;
690
-
691
- // @public (undocumented)
692
- export class TextSerializer implements Serializer<string> {
693
- constructor(schema: Schema);
694
- // (undocumented)
695
- static fromSchema(schema?: Schema): TextSerializer;
696
- // (undocumented)
697
- serializeFragment(fragment: Fragment): string;
698
- }
699
-
700
- // @public (undocumented)
701
- interface TextWrapper {
702
- // (undocumented)
703
- content: Node_2[];
704
- // (undocumented)
705
- nodeSize: number;
706
- // (undocumented)
707
- type: {
708
- name: 'textWrapper';
709
- };
710
- }
711
-
712
- // @public (undocumented)
713
- type TransformerProvider<T> = (schema: Schema) => Transformer_2<T>;
714
-
715
- // @public (undocumented)
716
- type UIAEP<Action, ActionSubject, ActionSubjectID, Attributes> = AEP<
717
- Action,
718
- ActionSubject,
719
- ActionSubjectID,
720
- Attributes,
721
- EVENT_TYPE.UI
722
- >;
723
-
724
- // @public (undocumented)
725
- type VisitLinkAEP = AEP<
726
- ACTION.VISITED,
727
- ACTION_SUBJECT.LINK,
728
- undefined,
729
- {
730
- platform: PLATFORM.WEB;
731
- mode: MODE.RENDERER;
732
- },
733
- EVENT_TYPE.TRACK
734
- >;
735
-
736
- // @public (undocumented)
737
- type VisitMediaLinkAEP = AEP<
738
- ACTION.VISITED,
739
- ACTION_SUBJECT.MEDIA,
740
- ACTION_SUBJECT_ID.LINK,
741
- {
742
- platform: PLATFORM.WEB;
743
- mode: MODE.RENDERER;
744
- },
745
- EVENT_TYPE.TRACK
746
- >;
747
-
748
- // (No @packageDocumentation comment for this package)
749
- ```
750
-
751
- <!--SECTION END: Main Entry Types-->
752
-
753
- ### Peer Dependencies
754
-
755
- <!--SECTION START: Peer Dependencies-->
756
-
757
- ```json
758
- {
759
- "@atlaskit/link-provider": "^1.6.2",
760
- "@atlaskit/media-core": "^34.1.2",
761
- "react": "^16.8.0",
762
- "react-dom": "^16.8.0"
763
- }
764
- ```
765
-
766
- <!--SECTION END: Peer Dependencies-->