@atlaskit/editor-core 210.1.5 → 210.1.7

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 (129) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/afm-cc/tsconfig.json +2 -2
  3. package/dist/cjs/ui/Appearance/Comment/Comment.js +1 -2
  4. package/dist/cjs/ui/Appearance/FullPage/FullPage.js +16 -9
  5. package/dist/cjs/ui/ContentStyles/index.js +3 -3
  6. package/dist/cjs/ui/ContentStyles/status.js +2 -2
  7. package/dist/cjs/ui/EditorContentContainer/EditorContentContainer.js +7 -9
  8. package/dist/cjs/ui/EditorContentContainer/styles/findReplaceStyles.js +1 -174
  9. package/dist/cjs/version-wrapper.js +1 -1
  10. package/dist/es2019/ui/Appearance/Comment/Comment.js +1 -2
  11. package/dist/es2019/ui/Appearance/FullPage/FullPage.js +19 -12
  12. package/dist/es2019/ui/ContentStyles/index.js +5 -5
  13. package/dist/es2019/ui/ContentStyles/status.js +2 -2
  14. package/dist/es2019/ui/EditorContentContainer/EditorContentContainer.js +8 -10
  15. package/dist/es2019/ui/EditorContentContainer/styles/findReplaceStyles.js +0 -225
  16. package/dist/es2019/version-wrapper.js +1 -1
  17. package/dist/esm/ui/Appearance/Comment/Comment.js +1 -2
  18. package/dist/esm/ui/Appearance/FullPage/FullPage.js +16 -9
  19. package/dist/esm/ui/ContentStyles/index.js +4 -4
  20. package/dist/esm/ui/ContentStyles/status.js +2 -2
  21. package/dist/esm/ui/EditorContentContainer/EditorContentContainer.js +8 -10
  22. package/dist/esm/ui/EditorContentContainer/styles/findReplaceStyles.js +0 -173
  23. package/dist/esm/version-wrapper.js +1 -1
  24. package/dist/types/CollapsedEditor/index.d.ts +1 -1
  25. package/dist/types/composable-editor/BaseThemeWrapper.d.ts +1 -1
  26. package/dist/types/composable-editor/editor-internal.d.ts +6 -6
  27. package/dist/types/composable-editor/hooks/useProviders.d.ts +4 -4
  28. package/dist/types/create-editor/ErrorBoundary.d.ts +4 -4
  29. package/dist/types/create-editor/ReactEditorView/useDispatchTransaction.d.ts +2 -2
  30. package/dist/types/create-editor/ReactEditorView.d.ts +16 -16
  31. package/dist/types/create-editor/create-schema.d.ts +1 -1
  32. package/dist/types/create-editor/create-universal-preset.d.ts +203 -194
  33. package/dist/types/create-editor/editorStateNotificationPlugin.d.ts +2 -2
  34. package/dist/types/create-editor/get-plugins.d.ts +13 -13
  35. package/dist/types/editor-appearances/FullPageEditor.d.ts +1 -1
  36. package/dist/types/presets/default.d.ts +21 -21
  37. package/dist/types/presets/universal.d.ts +214 -205
  38. package/dist/types/presets/useUniversalPreset.d.ts +202 -193
  39. package/dist/types/test-utils.d.ts +6 -6
  40. package/dist/types/types/editor-appearance-component.d.ts +23 -23
  41. package/dist/types/types/editor-config.d.ts +9 -9
  42. package/dist/types/types/editor-instance.d.ts +7 -7
  43. package/dist/types/types/editor-onchange.d.ts +1 -1
  44. package/dist/types/types/editor-props.d.ts +100 -100
  45. package/dist/types/types/i18n.d.ts +2 -2
  46. package/dist/types/ui/Addon/ClickAreaBlock/index.d.ts +1 -1
  47. package/dist/types/ui/Addon/Dropdown/index.d.ts +1 -1
  48. package/dist/types/ui/Addon/types.d.ts +1 -1
  49. package/dist/types/ui/Appearance/Chromeless.d.ts +6 -6
  50. package/dist/types/ui/Appearance/Comment/Toolbar.d.ts +2 -2
  51. package/dist/types/ui/Appearance/FullPage/CustomToolbarWrapper.d.ts +3 -3
  52. package/dist/types/ui/Appearance/FullPage/FullPageContentArea.d.ts +11 -11
  53. package/dist/types/ui/Appearance/FullPage/FullPageToolbar.d.ts +12 -12
  54. package/dist/types/ui/Appearance/FullPage/FullPageToolbarNext.d.ts +1 -1
  55. package/dist/types/ui/Appearance/FullPage/MainToolbarWrapper.d.ts +2 -2
  56. package/dist/types/ui/Appearance/FullPage/types.d.ts +2 -2
  57. package/dist/types/ui/ChromeCollapsed/index.d.ts +2 -2
  58. package/dist/types/ui/CollapsedEditor/index.d.ts +2 -2
  59. package/dist/types/ui/ContentStyles/index.d.ts +4 -4
  60. package/dist/types/ui/ContextPanel/index.d.ts +4 -4
  61. package/dist/types/ui/EditorContentContainer/EditorContentContainer.d.ts +3 -3
  62. package/dist/types/ui/EditorContentContainer/styles/findReplaceStyles.d.ts +0 -1
  63. package/dist/types/ui/PluginSlot/index.d.ts +10 -10
  64. package/dist/types/ui/PluginSlot/mount-plugin-hooks.d.ts +1 -1
  65. package/dist/types/ui/Toolbar/Toolbar.d.ts +2 -2
  66. package/dist/types/ui/Toolbar/ToolbarPortal.d.ts +2 -2
  67. package/dist/types/ui/Toolbar/toolbar-types.d.ts +11 -11
  68. package/dist/types/ui/ToolbarHelp/index.d.ts +1 -1
  69. package/dist/types/utils/deprecation-warnings.d.ts +2 -2
  70. package/dist/types/utils/performance/components/RenderTracking.d.ts +1 -1
  71. package/dist/types/utils/performance/plugin-performance-report.d.ts +4 -4
  72. package/dist/types/utils/performance/simple-measure-to-entries.d.ts +1 -1
  73. package/dist/types/utils/performance/track-transactions.d.ts +1 -1
  74. package/dist/types-ts4.5/CollapsedEditor/index.d.ts +1 -1
  75. package/dist/types-ts4.5/composable-editor/BaseThemeWrapper.d.ts +1 -1
  76. package/dist/types-ts4.5/composable-editor/editor-internal.d.ts +7 -7
  77. package/dist/types-ts4.5/composable-editor/hooks/useProviders.d.ts +4 -4
  78. package/dist/types-ts4.5/create-editor/ErrorBoundary.d.ts +4 -4
  79. package/dist/types-ts4.5/create-editor/ReactEditorView/useDispatchTransaction.d.ts +2 -2
  80. package/dist/types-ts4.5/create-editor/ReactEditorView.d.ts +16 -16
  81. package/dist/types-ts4.5/create-editor/create-schema.d.ts +1 -1
  82. package/dist/types-ts4.5/create-editor/create-universal-preset.d.ts +239 -230
  83. package/dist/types-ts4.5/create-editor/editorStateNotificationPlugin.d.ts +2 -2
  84. package/dist/types-ts4.5/create-editor/get-plugins.d.ts +13 -13
  85. package/dist/types-ts4.5/editor-appearances/FullPageEditor.d.ts +1 -1
  86. package/dist/types-ts4.5/presets/default.d.ts +21 -21
  87. package/dist/types-ts4.5/presets/universal.d.ts +250 -241
  88. package/dist/types-ts4.5/presets/useUniversalPreset.d.ts +238 -229
  89. package/dist/types-ts4.5/test-utils.d.ts +6 -6
  90. package/dist/types-ts4.5/types/editor-appearance-component.d.ts +23 -23
  91. package/dist/types-ts4.5/types/editor-config.d.ts +9 -9
  92. package/dist/types-ts4.5/types/editor-instance.d.ts +7 -7
  93. package/dist/types-ts4.5/types/editor-onchange.d.ts +1 -1
  94. package/dist/types-ts4.5/types/editor-props.d.ts +100 -100
  95. package/dist/types-ts4.5/types/i18n.d.ts +2 -2
  96. package/dist/types-ts4.5/ui/Addon/ClickAreaBlock/index.d.ts +1 -1
  97. package/dist/types-ts4.5/ui/Addon/Dropdown/index.d.ts +1 -1
  98. package/dist/types-ts4.5/ui/Addon/types.d.ts +1 -1
  99. package/dist/types-ts4.5/ui/Appearance/Chromeless.d.ts +6 -6
  100. package/dist/types-ts4.5/ui/Appearance/Comment/Toolbar.d.ts +2 -2
  101. package/dist/types-ts4.5/ui/Appearance/FullPage/CustomToolbarWrapper.d.ts +3 -3
  102. package/dist/types-ts4.5/ui/Appearance/FullPage/FullPageContentArea.d.ts +13 -13
  103. package/dist/types-ts4.5/ui/Appearance/FullPage/FullPageToolbar.d.ts +12 -12
  104. package/dist/types-ts4.5/ui/Appearance/FullPage/FullPageToolbarNext.d.ts +1 -1
  105. package/dist/types-ts4.5/ui/Appearance/FullPage/MainToolbarWrapper.d.ts +2 -2
  106. package/dist/types-ts4.5/ui/Appearance/FullPage/types.d.ts +2 -2
  107. package/dist/types-ts4.5/ui/ChromeCollapsed/index.d.ts +2 -2
  108. package/dist/types-ts4.5/ui/CollapsedEditor/index.d.ts +2 -2
  109. package/dist/types-ts4.5/ui/ContentStyles/index.d.ts +4 -4
  110. package/dist/types-ts4.5/ui/ContextPanel/index.d.ts +4 -4
  111. package/dist/types-ts4.5/ui/EditorContentContainer/EditorContentContainer.d.ts +3 -3
  112. package/dist/types-ts4.5/ui/EditorContentContainer/styles/findReplaceStyles.d.ts +0 -1
  113. package/dist/types-ts4.5/ui/PluginSlot/index.d.ts +10 -10
  114. package/dist/types-ts4.5/ui/PluginSlot/mount-plugin-hooks.d.ts +1 -1
  115. package/dist/types-ts4.5/ui/Toolbar/Toolbar.d.ts +2 -2
  116. package/dist/types-ts4.5/ui/Toolbar/ToolbarPortal.d.ts +2 -2
  117. package/dist/types-ts4.5/ui/Toolbar/toolbar-types.d.ts +11 -11
  118. package/dist/types-ts4.5/ui/ToolbarHelp/index.d.ts +1 -1
  119. package/dist/types-ts4.5/utils/deprecation-warnings.d.ts +2 -2
  120. package/dist/types-ts4.5/utils/performance/components/RenderTracking.d.ts +1 -1
  121. package/dist/types-ts4.5/utils/performance/plugin-performance-report.d.ts +4 -4
  122. package/dist/types-ts4.5/utils/performance/simple-measure-to-entries.d.ts +1 -1
  123. package/dist/types-ts4.5/utils/performance/track-transactions.d.ts +1 -1
  124. package/package.json +5 -18
  125. package/dist/cjs/ui/Appearance/FullPage/getEditorViewModeSync.js +0 -43
  126. package/dist/es2019/ui/Appearance/FullPage/getEditorViewModeSync.js +0 -33
  127. package/dist/esm/ui/Appearance/FullPage/getEditorViewModeSync.js +0 -36
  128. package/dist/types/ui/Appearance/FullPage/getEditorViewModeSync.d.ts +0 -3
  129. package/dist/types-ts4.5/ui/Appearance/FullPage/getEditorViewModeSync.d.ts +0 -3
@@ -7,18 +7,18 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
7
7
  import type { LightPMPlugin, LightPMPluginFactoryParams, OnEditorViewStateUpdated } from './create-editor/get-plugins';
8
8
  export type { LightEditorPlugin } from './create-editor/get-plugins';
9
9
  export interface LightEditorConfig {
10
- nodes: NodeConfig[];
11
- marks: MarkConfig[];
12
- plugins: Array<LightPMPlugin>;
13
10
  contentComponents: UIComponentFactory[];
14
- pluginHooks: ReactHookFactory[];
11
+ marks: MarkConfig[];
12
+ nodes: NodeConfig[];
15
13
  onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
14
+ pluginHooks: ReactHookFactory[];
15
+ plugins: Array<LightPMPlugin>;
16
16
  }
17
17
  type PluginData = {
18
+ editorConfig: LightEditorConfig;
19
+ onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
18
20
  plugins: Plugin[];
19
21
  schema: Schema;
20
- onEditorViewStateUpdatedCallbacks: Array<OnEditorViewStateUpdated>;
21
- editorConfig: LightEditorConfig;
22
22
  };
23
23
  export declare const createPMSchemaAndPlugins: (inputPreset?: EditorPresetBuilder) => (pluginFactoryParams: Omit<LightPMPluginFactoryParams, "schema"> & {
24
24
  pluginInjectionAPI: EditorPluginInjectionAPI;
@@ -12,39 +12,39 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
12
12
  import type EditorActions from '../actions';
13
13
  import type { ContentComponents, PrimaryToolbarComponents, ReactComponents } from '../types/editor-props';
14
14
  export interface EditorAppearanceComponentProps<Plugins extends NextEditorPlugin<any, any>[]> {
15
- editorAPI: PublicPluginAPI<Plugins> | undefined;
16
- appearance?: EditorAppearance;
17
15
  __livePage?: boolean;
18
- preset?: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
19
- onSave?: (editorView: EditorView) => void;
20
- onCancel?: (editorView: EditorView) => void;
21
- providerFactory: ProviderFactory;
16
+ appearance?: EditorAppearance;
17
+ collabEdit?: CollabEditOptions;
18
+ contentComponents?: UIComponentFactory[];
19
+ contextPanel?: ReactComponents;
20
+ customContentComponents?: ContentComponents;
21
+ customPrimaryToolbarComponents?: PrimaryToolbarComponents;
22
+ customSecondaryToolbarComponents?: ReactComponents;
23
+ disabled?: boolean;
24
+ dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
22
25
  editorActions?: EditorActions;
26
+ editorAPI: PublicPluginAPI<Plugins> | undefined;
23
27
  editorDOMElement: JSX.Element;
24
28
  editorView?: EditorView;
29
+ enableToolbarMinWidth?: boolean;
25
30
  eventDispatcher?: EventDispatcher;
26
- dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
31
+ extensionHandlers?: ExtensionHandlers;
32
+ featureFlags: FeatureFlags;
33
+ innerRef?: RefObject<HTMLDivElement>;
34
+ insertMenuItems?: MenuItem[];
27
35
  maxHeight?: number;
28
36
  minHeight?: number;
29
- contentComponents?: UIComponentFactory[];
37
+ onCancel?: (editorView: EditorView) => void;
38
+ onSave?: (editorView: EditorView) => void;
39
+ persistScrollGutter?: boolean;
30
40
  pluginHooks?: ReactHookFactory[];
41
+ popupsBoundariesElement?: HTMLElement;
42
+ popupsMountPoint?: HTMLElement;
43
+ popupsScrollableElement?: HTMLElement;
44
+ preset?: EditorPresetBuilder<string[], AllEditorPresetPluginTypes[]>;
31
45
  primaryToolbarComponents?: ToolbarUIComponentFactory[];
32
46
  primaryToolbarIconBefore?: ReactElement;
47
+ providerFactory: ProviderFactory;
33
48
  secondaryToolbarComponents?: UIComponentFactory[];
34
- customContentComponents?: ContentComponents;
35
- customPrimaryToolbarComponents?: PrimaryToolbarComponents;
36
- customSecondaryToolbarComponents?: ReactComponents;
37
- insertMenuItems?: MenuItem[];
38
- contextPanel?: ReactComponents;
39
- popupsMountPoint?: HTMLElement;
40
- popupsBoundariesElement?: HTMLElement;
41
- popupsScrollableElement?: HTMLElement;
42
- extensionHandlers?: ExtensionHandlers;
43
- disabled?: boolean;
44
- collabEdit?: CollabEditOptions;
45
- persistScrollGutter?: boolean;
46
- enableToolbarMinWidth?: boolean;
47
- featureFlags: FeatureFlags;
48
49
  useStickyToolbar?: UseStickyToolbarType;
49
- innerRef?: RefObject<HTMLDivElement>;
50
50
  }
@@ -1,21 +1,21 @@
1
1
  import type { MarkConfig, NodeConfig, PMPlugin, ReactHookFactory, ToolbarUIComponentFactory, UIComponentFactory } from '@atlaskit/editor-common/types';
2
2
  import type { EditorState, Transaction } from '@atlaskit/editor-prosemirror/state';
3
3
  export type EditorViewStateUpdatedCallbackProps = {
4
+ readonly newEditorState: Readonly<EditorState>;
5
+ readonly oldEditorState: Readonly<EditorState>;
4
6
  readonly originalTransaction: Readonly<Transaction>;
5
7
  readonly transactions: readonly Transaction[];
6
- readonly oldEditorState: Readonly<EditorState>;
7
- readonly newEditorState: Readonly<EditorState>;
8
8
  };
9
9
  export interface EditorConfig {
10
- nodes: NodeConfig[];
11
- marks: MarkConfig[];
12
- pmPlugins: Array<PMPlugin>;
13
10
  contentComponents: UIComponentFactory[];
14
- pluginHooks: ReactHookFactory[];
15
- primaryToolbarComponents: ToolbarUIComponentFactory[];
16
- secondaryToolbarComponents: UIComponentFactory[];
11
+ marks: MarkConfig[];
12
+ nodes: NodeConfig[];
17
13
  onEditorViewStateUpdatedCallbacks: Array<{
18
- pluginName: string;
19
14
  callback: (props: EditorViewStateUpdatedCallbackProps) => void;
15
+ pluginName: string;
20
16
  }>;
17
+ pluginHooks: ReactHookFactory[];
18
+ pmPlugins: Array<PMPlugin>;
19
+ primaryToolbarComponents: ToolbarUIComponentFactory[];
20
+ secondaryToolbarComponents: UIComponentFactory[];
21
21
  }
@@ -4,16 +4,16 @@ import type { MenuItem } from '@atlaskit/editor-common/ui-menu';
4
4
  import type { EditorView } from '@atlaskit/editor-prosemirror/view';
5
5
  import type { OnEditorViewStateUpdated } from '../create-editor/get-plugins';
6
6
  export interface EditorInstance {
7
+ contentComponents: UIComponentFactory[];
8
+ contentTransformer?: Transformer<string>;
7
9
  editorView: EditorView;
8
10
  eventDispatcher: EventDispatcher;
9
- contentComponents: UIComponentFactory[];
10
- pluginHooks: ReactHookFactory[];
11
- primaryToolbarComponents: ToolbarUIComponentFactory[];
12
- secondaryToolbarComponents: UIComponentFactory[];
11
+ insertMenuItems?: MenuItem[];
13
12
  onEditorViewStateUpdatedCallbacks: {
14
- pluginName: string;
15
13
  callback: OnEditorViewStateUpdated;
14
+ pluginName: string;
16
15
  }[];
17
- contentTransformer?: Transformer<string>;
18
- insertMenuItems?: MenuItem[];
16
+ pluginHooks: ReactHookFactory[];
17
+ primaryToolbarComponents: ToolbarUIComponentFactory[];
18
+ secondaryToolbarComponents: UIComponentFactory[];
19
19
  }
@@ -1,6 +1,5 @@
1
1
  import type { EditorView } from '@atlaskit/editor-prosemirror/view';
2
2
  export type EditorOnChangeHandler = (editorView: EditorView, meta: {
3
- source: 'local' | 'remote';
4
3
  /**
5
4
  * Indicates whether or not the change may be unnecessary to listen to (dirty
6
5
  * changes can generally be ignored).
@@ -11,4 +10,5 @@ export type EditorOnChangeHandler = (editorView: EditorView, meta: {
11
10
  * We still fire these events however to avoid a breaking change.
12
11
  */
13
12
  isDirtyChange: boolean;
13
+ source: 'local' | 'remote';
14
14
  }) => void;
@@ -34,57 +34,34 @@ type ExtensionProviders = (ExtensionProvider | Promise<ExtensionProvider>)[];
34
34
  type ExtensionProvidersWithEditorAction = (editorActions?: EditorActions) => ExtensionProviders;
35
35
  export type ExtensionProvidersProp = ExtensionProviders | ExtensionProvidersWithEditorAction;
36
36
  export type BeforeAndAfterToolbarComponents = {
37
- before: ReactComponents;
38
37
  after: ReactComponents;
38
+ before: ReactComponents;
39
39
  };
40
40
  export type PrimaryToolbarComponents = BeforeAndAfterToolbarComponents | ReactComponents;
41
41
  export type BeforeAndAfterContentComponents = {
42
- before: ReactComponents;
43
42
  after: ReactComponents;
43
+ before: ReactComponents;
44
44
  };
45
45
  export type ContentComponents = BeforeAndAfterContentComponents | ReactComponents;
46
46
  interface EditorBaseProps {
47
+ /**
48
+ * This is required for accessing whether a page is a live page or not when rendering the appearance component.
49
+ *
50
+ * All other consumers should use the editorViewModePlugin to access live page and content mode status.
51
+ *
52
+ * @default false
53
+ */
54
+ __livePage?: boolean;
47
55
  appearance?: EditorAppearance;
56
+ assistiveLabel?: string;
48
57
  contentComponents?: ContentComponents;
49
- primaryToolbarIconBefore?: ReactElement;
50
- secondaryToolbarComponents?: ReactComponents;
51
- persistScrollGutter?: boolean;
52
- quickInsert?: QuickInsertOptions;
53
- shouldFocus?: boolean;
54
- disabled?: boolean;
55
- contextPanel?: ReactComponents;
56
- errorReporterHandler?: ErrorReportingHandler;
57
58
  contentTransformerProvider?: (schema: Schema) => Transformer<string>;
58
- maxHeight?: number;
59
- minHeight?: number;
59
+ contextPanel?: ReactComponents;
60
60
  defaultValue?: Node | string | Object;
61
- assistiveLabel?: string;
62
- popupsMountPoint?: HTMLElement;
63
- popupsBoundariesElement?: HTMLElement;
64
- popupsScrollableElement?: HTMLElement;
61
+ disabled?: boolean;
65
62
  editorActions?: EditorActions;
66
- onEditorReady?: (editorActions: EditorActions) => void;
67
- onDestroy?: () => void;
68
- onChange?: EditorOnChangeHandler;
69
- onCancel?: (editorView: EditorView) => void;
70
- /**
71
- * @deprecated do not use, value is hardcoded. Can be mocked for tests. Config exists here: platform/packages/editor/editor-plugin-base/src/pm-plugins/utils/inputTrackingConfig.ts
72
- * @description The nth keystroke after which an input time taken event is sent, 0 to disable it
73
- * @default 100
74
- */
75
- inputSamplingLimit?: number;
63
+ errorReporterHandler?: ErrorReportingHandler;
76
64
  extensionProviders?: ExtensionProvidersProp;
77
- UNSAFE_useAnalyticsContext?: boolean;
78
- /**
79
- * @default undefined
80
- * @description
81
- * Enables the sticky toolbar in the comment/standard editor.
82
- * If a boolean is specified and it's `true`, the sticky toolbar will be enabled, sticking to the top of the scroll parent.
83
- * Instead a reference can be specified to an existing sticky toolbar on the page that the editor toolbar should stay below (experimental).
84
- * if {offsetTop: number} is passed in, the toolbar is sticky and the toolbar's 'top' will be set to the offsetTop
85
- * so the toolbar will sticks to `{offsetTop}` below the scroll parent.
86
- */
87
- useStickyToolbar?: UseStickyToolbarType;
88
65
  /**
89
66
  * @default undefined
90
67
  * @description
@@ -117,32 +94,57 @@ interface EditorBaseProps {
117
94
  [featureFlag: string]: string | boolean;
118
95
  };
119
96
  /**
120
- * This is required for accessing whether a page is a live page or not when rendering the appearance component.
121
- *
122
- * All other consumers should use the editorViewModePlugin to access live page and content mode status.
123
- *
124
- * @default false
97
+ * @deprecated do not use, value is hardcoded. Can be mocked for tests. Config exists here: platform/packages/editor/editor-plugin-base/src/pm-plugins/utils/inputTrackingConfig.ts
98
+ * @description The nth keystroke after which an input time taken event is sent, 0 to disable it
99
+ * @default 100
125
100
  */
126
- __livePage?: boolean;
101
+ inputSamplingLimit?: number;
102
+ maxHeight?: number;
103
+ minHeight?: number;
104
+ onCancel?: (editorView: EditorView) => void;
105
+ onChange?: EditorOnChangeHandler;
106
+ onDestroy?: () => void;
107
+ onEditorReady?: (editorActions: EditorActions) => void;
108
+ persistScrollGutter?: boolean;
109
+ popupsBoundariesElement?: HTMLElement;
110
+ popupsMountPoint?: HTMLElement;
111
+ popupsScrollableElement?: HTMLElement;
112
+ primaryToolbarIconBefore?: ReactElement;
113
+ quickInsert?: QuickInsertOptions;
114
+ secondaryToolbarComponents?: ReactComponents;
115
+ shouldFocus?: boolean;
127
116
  skipValidation?: boolean;
117
+ UNSAFE_useAnalyticsContext?: boolean;
118
+ /**
119
+ * @default undefined
120
+ * @description
121
+ * Enables the sticky toolbar in the comment/standard editor.
122
+ * If a boolean is specified and it's `true`, the sticky toolbar will be enabled, sticking to the top of the scroll parent.
123
+ * Instead a reference can be specified to an existing sticky toolbar on the page that the editor toolbar should stay below (experimental).
124
+ * if {offsetTop: number} is passed in, the toolbar is sticky and the toolbar's 'top' will be set to the offsetTop
125
+ * so the toolbar will sticks to `{offsetTop}` below the scroll parent.
126
+ */
127
+ useStickyToolbar?: UseStickyToolbarType;
128
128
  }
129
129
  export interface EditorSharedPropsWithPlugins {
130
+ allowUndoRedoButtons?: boolean;
131
+ collabEdit?: CollabEditOptions;
130
132
  onSave?: (editorView: EditorView) => void;
131
133
  /**
132
134
  * @deprecated do not use, value is hardcoded. Can be mocked for tests. Config exists here: platform/packages/editor/editor-plugin-base/src/pm-plugins/utils/inputTrackingConfig.ts
133
135
  * @description Control performance metric measurements and tracking
134
136
  */
135
137
  performanceTracking?: PerformanceTracking;
136
- sanitizePrivateContent?: boolean;
137
- collabEdit?: CollabEditOptions;
138
138
  primaryToolbarComponents?: PrimaryToolbarComponents;
139
- allowUndoRedoButtons?: boolean;
139
+ sanitizePrivateContent?: boolean;
140
140
  }
141
141
  export interface EditorProps extends EditorBaseProps, EditorPluginFeatureProps, EditorSharedPropsWithPlugins, EditorProviderProps {
142
142
  assistiveDescribedBy?: string;
143
143
  }
144
144
  export interface EditorNextProps extends EditorBaseProps, EditorSharedPropsWithPlugins, EditorProviderProps {
145
- preset: EditorPresetBuilder<AllPluginNames[], AllEditorPresetPluginTypes[]>;
145
+ assistiveDescribedBy?: string;
146
+ autoformattingProvider?: Providers['autoformattingProvider'];
147
+ emojiProvider?: Providers['emojiProvider'];
146
148
  /**
147
149
  * @deprecated
148
150
  * This prop does nothing and will be removed soon.
@@ -175,73 +177,80 @@ export interface EditorNextProps extends EditorBaseProps, EditorSharedPropsWithP
175
177
  * ```
176
178
  */
177
179
  media?: MediaPluginOptions;
178
- assistiveDescribedBy?: string;
179
- emojiProvider?: Providers['emojiProvider'];
180
+ preset: EditorPresetBuilder<AllPluginNames[], AllEditorPresetPluginTypes[]>;
180
181
  taskDecisionProvider?: Promise<TaskDecisionProvider>;
181
- autoformattingProvider?: Providers['autoformattingProvider'];
182
182
  }
183
183
  export interface EditorProviderProps {
184
184
  activityProvider?: Promise<ActivityProvider>;
185
- searchProvider?: Promise<SearchProvider>;
186
185
  annotationProviders?: AnnotationProviders;
186
+ autoformattingProvider?: Providers['autoformattingProvider'];
187
187
  collabEditProvider?: Providers['collabEditProvider'];
188
- presenceProvider?: Promise<any>;
188
+ contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
189
189
  emojiProvider?: Providers['emojiProvider'];
190
- taskDecisionProvider?: Promise<TaskDecisionProvider>;
191
190
  legacyImageUploadProvider?: Providers['imageUploadProvider'];
192
- mentionProvider?: Promise<MentionProvider>;
193
- autoformattingProvider?: Providers['autoformattingProvider'];
194
191
  macroProvider?: Providers['macroProvider'];
195
- contextIdentifierProvider?: Promise<ContextIdentifierProvider>;
192
+ mentionProvider?: Promise<MentionProvider>;
193
+ presenceProvider?: Promise<any>;
194
+ searchProvider?: Promise<SearchProvider>;
195
+ taskDecisionProvider?: Promise<TaskDecisionProvider>;
196
196
  }
197
197
  export interface EditorPluginFeatureProps {
198
- allowExpand?: boolean | {
199
- allowInsertion?: boolean;
200
- allowInteractiveExpand?: boolean;
201
- };
202
- allowNestedTasks?: boolean;
198
+ allowAnalyticsGASV3?: boolean;
203
199
  allowBlockType?: BlockTypePluginOptions['allowBlockType'];
204
- allowTasksAndDecisions?: boolean;
205
- allowBreakout?: boolean;
206
- allowRule?: boolean;
207
- allowHelpDialog?: boolean;
208
- allowPanel?: boolean | PanelPluginConfig;
209
- allowExtension?: boolean | ExtensionConfig;
210
- allowConfluenceInlineComment?: boolean;
211
- allowTemplatePlaceholders?: boolean | PlaceholderTextPluginOptions;
212
- allowDate?: boolean | DatePluginOptions;
213
- allowLayouts?: boolean | LayoutPluginOptions;
214
- allowStatus?: boolean | {
215
- menuDisabled: boolean;
216
- };
217
- allowTextAlignment?: boolean;
218
- allowIndentation?: boolean;
219
- showIndentationButtons?: boolean;
220
- allowFindReplace?: boolean | FindReplaceOptions;
221
200
  /**
222
201
  * Enable support for the "border" mark.
223
202
  * Refer to ADF Change proposal #65 for more details.
224
203
  */
225
204
  allowBorderMark?: boolean;
205
+ allowBreakout?: boolean;
206
+ allowConfluenceInlineComment?: boolean;
207
+ allowDate?: boolean | DatePluginOptions;
208
+ allowExpand?: boolean | {
209
+ allowInsertion?: boolean;
210
+ allowInteractiveExpand?: boolean;
211
+ };
212
+ allowExtension?: boolean | ExtensionConfig;
213
+ allowFindReplace?: boolean | FindReplaceOptions;
226
214
  /**
227
215
  * Enable support for the "fragment" mark.
228
216
  * Refer to ADF Change proposal #60 for more details.
229
217
  */
230
218
  allowFragmentMark?: boolean;
219
+ allowHelpDialog?: boolean;
220
+ allowIndentation?: boolean;
221
+ allowLayouts?: boolean | LayoutPluginOptions;
222
+ allowNestedTasks?: boolean;
223
+ allowPanel?: boolean | PanelPluginConfig;
224
+ allowRule?: boolean;
225
+ allowStatus?: boolean | {
226
+ menuDisabled: boolean;
227
+ };
228
+ allowTables?: boolean | TablesPluginConfig;
229
+ allowTasksAndDecisions?: boolean;
230
+ allowTemplatePlaceholders?: boolean | PlaceholderTextPluginOptions;
231
+ allowTextAlignment?: boolean;
232
+ allowTextColor?: boolean | TextColorPluginConfig;
231
233
  /**
232
234
  * Set this to false to opt out of the default behaviour of auto scrolling into view
233
235
  * whenever the document is changed
234
236
  */
235
237
  autoScrollIntoView?: boolean;
238
+ codeBlock?: CodeBlockPluginOptions;
236
239
  elementBrowser?: {
237
- showModal?: boolean;
238
- replacePlusMenu?: boolean;
239
- helpUrl?: string;
240
240
  emptyStateHandler?: EmptyStateHandler;
241
+ helpUrl?: string;
242
+ replacePlusMenu?: boolean;
243
+ showModal?: boolean;
241
244
  };
242
- maxContentSize?: number;
243
- saveOnEnter?: boolean;
245
+ extensionHandlers?: ExtensionHandlers;
244
246
  feedbackInfo?: FeedbackInfo;
247
+ insertMenuItems?: MenuItem[];
248
+ /**
249
+ * Configure and extend editor linking behaviour
250
+ */
251
+ linking?: LinkingOptions;
252
+ maxContentSize?: number;
253
+ media?: MediaPluginOptions;
245
254
  mention?: MentionPluginConfig;
246
255
  /**
247
256
  * flag to indicate display name instead of nick name should be inserted for mentions
@@ -249,25 +258,16 @@ export interface EditorPluginFeatureProps {
249
258
  * @deprecated Use mention.mentionInsertDisplayName instead
250
259
  */
251
260
  mentionInsertDisplayName?: boolean;
252
- uploadErrorHandler?: (state: MediaState) => void;
253
- waitForMediaUpload?: boolean;
254
- extensionHandlers?: ExtensionHandlers;
255
- allowTextColor?: boolean | TextColorPluginConfig;
256
- allowTables?: boolean | TablesPluginConfig;
257
- insertMenuItems?: MenuItem[];
258
- /** @deprecated Use linking.smartLinks prop instead. */
259
- UNSAFE_cards?: CardOptions;
261
+ placeholder?: string;
262
+ placeholderBracketHint?: string;
263
+ saveOnEnter?: boolean;
264
+ showIndentationButtons?: boolean;
260
265
  /** @deprecated Use linking.smartLinks prop instead. */
261
266
  smartLinks?: CardOptions;
262
- allowAnalyticsGASV3?: boolean;
263
- codeBlock?: CodeBlockPluginOptions;
264
267
  textFormatting?: TextFormattingPluginOptions;
265
- placeholder?: string;
266
- placeholderBracketHint?: string;
267
- /**
268
- * Configure and extend editor linking behaviour
269
- */
270
- linking?: LinkingOptions;
271
- media?: MediaPluginOptions;
268
+ /** @deprecated Use linking.smartLinks prop instead. */
269
+ UNSAFE_cards?: CardOptions;
270
+ uploadErrorHandler?: (state: MediaState) => void;
271
+ waitForMediaUpload?: boolean;
272
272
  }
273
273
  export {};
@@ -1,5 +1,5 @@
1
1
  export interface MessageDescriptor {
2
- id: string;
3
- description: string;
4
2
  defaultMessage: string;
3
+ description: string;
4
+ id: string;
5
5
  }
@@ -6,9 +6,9 @@ import React from 'react';
6
6
  import { jsx } from '@emotion/react';
7
7
  import type { EditorView } from '@atlaskit/editor-prosemirror/view';
8
8
  export interface Props {
9
- editorView?: EditorView;
10
9
  children?: React.ReactNode;
11
10
  editorDisabled?: boolean;
11
+ editorView?: EditorView;
12
12
  }
13
13
  export declare const ClickAreaBlock: ({ editorView, editorDisabled, children }: Props) => jsx.JSX.Element;
14
14
  export default ClickAreaBlock;
@@ -8,8 +8,8 @@ import type EditorActions from '../../../actions';
8
8
  import type { RenderOnClickHandler } from '../../Addon/types';
9
9
  export interface Props {
10
10
  children?: React.ReactNode;
11
- onClick: (actionOnClick: EditorActions, renderOnClick: RenderOnClickHandler) => void;
12
11
  editorActions: EditorActions;
12
+ onClick: (actionOnClick: EditorActions, renderOnClick: RenderOnClickHandler) => void;
13
13
  togglePopup: () => void;
14
14
  }
15
15
  export default class DropdownWrapper extends React.Component<Props> {
@@ -8,8 +8,8 @@ export interface AddonCommonProps extends AddonActions {
8
8
  icon: React.ReactElement;
9
9
  }
10
10
  export interface AddonProps extends AddonCommonProps {
11
- onClick?: (actions: AddonActions) => void;
12
11
  children?: React.ReactElement[];
12
+ onClick?: (actions: AddonActions) => void;
13
13
  }
14
14
  export interface AddonConfiguration extends AddonCommonProps {
15
15
  text: string;
@@ -9,13 +9,13 @@ import type { EditorViewModePlugin } from '@atlaskit/editor-plugins/editor-viewm
9
9
  import type { MaxContentSizePlugin } from '@atlaskit/editor-plugins/max-content-size';
10
10
  import type { EditorAppearanceComponentProps } from '../../types';
11
11
  export declare const ContentArea: React.ForwardRefExoticComponent<Omit<{
12
- theme?: import("@emotion/react").Theme;
12
+ appearance?: EditorAppearance;
13
13
  colorMode?: "light" | "dark";
14
14
  featureFlags?: import("@atlaskit/editor-common/types").FeatureFlags;
15
- viewMode?: "view" | "edit";
16
- typographyTheme?: "typography" | "typography-adg3" | "typography-modernized" | "typography-refreshed";
17
15
  isScrollable?: boolean;
18
- appearance?: EditorAppearance;
16
+ theme?: import("@emotion/react").Theme;
17
+ typographyTheme?: "typography" | "typography-adg3" | "typography-modernized" | "typography-refreshed";
18
+ viewMode?: "view" | "edit";
19
19
  } & React.HTMLProps<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
20
20
  type AppearanceProps = EditorAppearanceComponentProps<[
21
21
  OptionalPlugin<MaxContentSizePlugin>,
@@ -33,10 +33,10 @@ export default class Editor extends React.Component<AppearanceProps> {
33
33
  render(): jsx.JSX.Element;
34
34
  }
35
35
  interface ChromelessEditorContainerProps {
36
- maxHeight?: number;
37
- minHeight: number;
38
36
  children: React.ReactNode;
39
37
  containerRef?: (ref: HTMLElement | null) => void;
38
+ maxHeight?: number;
39
+ minHeight: number;
40
40
  }
41
41
  export declare const ChromelessEditorContainer: React.FC<ChromelessEditorContainerProps>;
42
42
  export {};
@@ -2,9 +2,9 @@ import React from 'react';
2
2
  import { jsx } from '@emotion/react';
3
3
  import type { UseStickyToolbarType } from '@atlaskit/editor-common/ui';
4
4
  type MainToolbarProps = {
5
- useStickyToolbar?: UseStickyToolbarType;
6
- twoLineEditorToolbar?: boolean;
7
5
  children?: React.ReactNode;
6
+ twoLineEditorToolbar?: boolean;
7
+ useStickyToolbar?: UseStickyToolbarType;
8
8
  };
9
9
  export declare const MainToolbar: ({ useStickyToolbar, twoLineEditorToolbar, children, }: MainToolbarProps) => jsx.JSX.Element;
10
10
  export {};
@@ -4,11 +4,11 @@
4
4
  */
5
5
  import React from 'react';
6
6
  interface ChildWrapperProps {
7
- twoLineEditorToolbar: boolean;
8
- children: React.ReactNode;
9
- role?: string;
10
7
  'aria-label'?: string;
8
+ children: React.ReactNode;
11
9
  'data-testid'?: string;
10
+ role?: string;
11
+ twoLineEditorToolbar: boolean;
12
12
  }
13
13
  export declare const MainToolbarForFirstChildWrapper: React.FC<ChildWrapperProps>;
14
14
  export declare const MainToolbarForSecondChildWrapper: React.FC<ChildWrapperProps>;
@@ -17,38 +17,38 @@ import type EditorActions from '../../../actions';
17
17
  import type { ContentComponents, ReactComponents } from '../../../types';
18
18
  import type { ScrollContainerRefs } from './types';
19
19
  interface FullPageEditorContentAreaProps {
20
- editorAPI: PublicPluginAPI<[OptionalPlugin<ContextPanelPlugin>]> | undefined;
21
20
  appearance: EditorAppearance | undefined;
22
21
  contentComponents: UIComponentFactory[] | undefined;
23
- pluginHooks: ReactHookFactory[] | undefined;
24
22
  contextPanel: ReactComponents | undefined;
25
23
  customContentComponents: ContentComponents | undefined;
26
24
  disabled: boolean | undefined;
27
25
  dispatchAnalyticsEvent: DispatchAnalyticsEvent | undefined;
28
26
  editorActions: EditorActions | undefined;
27
+ editorAPI: PublicPluginAPI<[OptionalPlugin<ContextPanelPlugin>]> | undefined;
29
28
  editorDOMElement: ReactElement;
30
29
  editorView: EditorView;
31
30
  eventDispatcher: EventDispatcher | undefined;
32
- popupsMountPoint: HTMLElement | undefined;
31
+ featureFlags?: FeatureFlags;
32
+ hasHadInteraction?: boolean;
33
+ isEditorToolbarHidden?: boolean;
34
+ pluginHooks: ReactHookFactory[] | undefined;
33
35
  popupsBoundariesElement: HTMLElement | undefined;
36
+ popupsMountPoint: HTMLElement | undefined;
34
37
  popupsScrollableElement: HTMLElement | undefined;
35
38
  providerFactory: ProviderFactory;
36
- wrapperElement: HTMLElement | null;
37
- hasHadInteraction?: boolean;
38
- featureFlags?: FeatureFlags;
39
39
  viewMode: ViewMode | undefined;
40
- isEditorToolbarHidden?: boolean;
40
+ wrapperElement: HTMLElement | null;
41
41
  }
42
42
  export declare const CONTENT_AREA_TEST_ID = "ak-editor-fp-content-area";
43
43
  export declare const EDITOR_CONTAINER = "ak-editor-container";
44
44
  export declare const ScrollContainer: React.ForwardRefExoticComponent<Omit<{
45
- theme?: Theme;
45
+ appearance?: EditorAppearance;
46
46
  colorMode?: "light" | "dark";
47
47
  featureFlags?: FeatureFlags;
48
- viewMode?: "view" | "edit";
49
- typographyTheme?: "typography" | "typography-adg3" | "typography-modernized" | "typography-refreshed";
50
48
  isScrollable?: boolean;
51
- appearance?: EditorAppearance;
49
+ theme?: Theme;
50
+ typographyTheme?: "typography" | "typography-adg3" | "typography-modernized" | "typography-refreshed";
51
+ viewMode?: "view" | "edit";
52
52
  } & React.HTMLProps<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
53
53
  export declare const FullPageContentArea: React.ForwardRefExoticComponent<Omit<import("react-intl-next").WithIntlProps<React.PropsWithChildren<FullPageEditorContentAreaProps & WrappedComponentProps & React.RefAttributes<ScrollContainerRefs>>>, "ref"> & React.RefAttributes<any>> & {
54
54
  WrappedComponent: React.ComponentType<FullPageEditorContentAreaProps & WrappedComponentProps & React.RefAttributes<ScrollContainerRefs>>;
@@ -30,25 +30,25 @@ export type ToolbarEditorPlugins = [
30
30
  ];
31
31
  export interface FullPageToolbarProps {
32
32
  appearance?: EditorAppearance;
33
- providerFactory: ProviderFactory;
33
+ beforeIcon?: ReactElement;
34
+ collabEdit?: CollabEditOptions;
35
+ containerElement: HTMLElement | null;
36
+ customPrimaryToolbarComponents?: PrimaryToolbarComponents;
37
+ disabled: boolean;
38
+ dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
34
39
  editorActions?: EditorActions;
40
+ editorAPI: PublicPluginAPI<ToolbarEditorPlugins> | undefined;
35
41
  editorDOMElement: JSX.Element;
36
42
  editorView: EditorView;
37
43
  eventDispatcher: EventDispatcher;
38
- dispatchAnalyticsEvent?: DispatchAnalyticsEvent;
39
- primaryToolbarComponents?: ToolbarUIComponentFactory[];
40
- customPrimaryToolbarComponents?: PrimaryToolbarComponents;
41
- popupsMountPoint?: HTMLElement;
44
+ featureFlags: FeatureFlags;
45
+ hasMinWidth?: boolean;
42
46
  popupsBoundariesElement?: HTMLElement;
47
+ popupsMountPoint?: HTMLElement;
43
48
  popupsScrollableElement?: HTMLElement;
44
- disabled: boolean;
45
- collabEdit?: CollabEditOptions;
49
+ primaryToolbarComponents?: ToolbarUIComponentFactory[];
50
+ providerFactory: ProviderFactory;
46
51
  showKeyline: boolean;
47
- containerElement: HTMLElement | null;
48
- beforeIcon?: ReactElement;
49
- hasMinWidth?: boolean;
50
- featureFlags: FeatureFlags;
51
- editorAPI: PublicPluginAPI<ToolbarEditorPlugins> | undefined;
52
52
  }
53
53
  export declare const EditorToolbar: React.MemoExoticComponent<(props: FullPageToolbarProps & WrappedComponentProps) => jsx.JSX.Element>;
54
54
  export declare const FullPageToolbar: React.FC<import("react-intl-next").WithIntlProps<FullPageToolbarProps & WrappedComponentProps>> & {
@@ -9,10 +9,10 @@ import type { EditorView } from '@atlaskit/editor-prosemirror/view';
9
9
  type FullPageToolbarNextProps = {
10
10
  beforeIcon?: React.ReactNode;
11
11
  editorAPI?: PublicPluginAPI<[ToolbarPlugin]>;
12
- toolbarDockingPosition?: 'top' | 'none';
13
12
  editorView?: EditorView;
14
13
  popupsMountPoint?: HTMLElement;
15
14
  showKeyline: boolean;
15
+ toolbarDockingPosition?: 'top' | 'none';
16
16
  };
17
17
  export declare const FullPageToolbarNext: ({ editorAPI, beforeIcon, toolbarDockingPosition, editorView, popupsMountPoint, showKeyline, }: FullPageToolbarNextProps) => JSX.Element;
18
18
  export {};