@contentful/field-editor-rich-text 2.0.0-next.2 → 2.0.0-next.20

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 (145) hide show
  1. package/README.md +4 -0
  2. package/dist/ContentfulEditorProvider.d.ts +6 -5
  3. package/dist/RichTextEditor.d.ts +2 -3
  4. package/dist/Toolbar/{EmbedEntityWidget.d.ts → components/EmbedEntityWidget.d.ts} +0 -1
  5. package/dist/{plugins/EmbeddedEntity/index.d.ts → Toolbar/components/EmbeddedEntityDropdownButton.d.ts} +1 -2
  6. package/dist/Toolbar/{StickyToolbarWrapper.d.ts → components/StickyToolbarWrapper.d.ts} +0 -0
  7. package/dist/Toolbar/index.d.ts +0 -1
  8. package/dist/dialogs/renderRichTextDialog.d.ts +0 -1
  9. package/dist/field-editor-rich-text.cjs.development.js +5335 -4357
  10. package/dist/field-editor-rich-text.cjs.development.js.map +1 -1
  11. package/dist/field-editor-rich-text.cjs.production.min.js +1 -1
  12. package/dist/field-editor-rich-text.cjs.production.min.js.map +1 -1
  13. package/dist/field-editor-rich-text.esm.js +5450 -4472
  14. package/dist/field-editor-rich-text.esm.js.map +1 -1
  15. package/dist/helpers/editor.d.ts +22 -27
  16. package/dist/helpers/environment.d.ts +1 -0
  17. package/dist/helpers/extractNodes.d.ts +6 -0
  18. package/dist/helpers/transformers.d.ts +8 -0
  19. package/dist/helpers/validations.d.ts +1 -1
  20. package/dist/plugins/Break/createExitBreakPlugin.d.ts +2 -0
  21. package/dist/plugins/Break/createResetNodePlugin.d.ts +2 -0
  22. package/dist/plugins/Break/createSoftBreakPlugin.d.ts +2 -0
  23. package/dist/plugins/Break/index.d.ts +5 -0
  24. package/dist/plugins/DragAndDrop/index.d.ts +2 -2
  25. package/dist/plugins/EmbeddedEntityBlock/LinkedEntityBlock.d.ts +3 -2
  26. package/dist/plugins/EmbeddedEntityBlock/ToolbarIcon.d.ts +1 -3
  27. package/dist/plugins/EmbeddedEntityBlock/Util.d.ts +2 -1
  28. package/dist/plugins/EmbeddedEntityBlock/index.d.ts +3 -9
  29. package/dist/plugins/EmbeddedEntityInline/FetchingWrappedInlineEntryCard.d.ts +1 -0
  30. package/dist/plugins/EmbeddedEntityInline/index.d.ts +3 -5
  31. package/dist/plugins/Heading/components/Heading.d.ts +11 -0
  32. package/dist/plugins/Heading/components/ToolbarHeadingButton.d.ts +4 -0
  33. package/dist/plugins/Heading/createHeadingPlugin.d.ts +2 -0
  34. package/dist/plugins/Heading/index.d.ts +2 -20
  35. package/dist/plugins/Hr/index.d.ts +3 -5
  36. package/dist/plugins/Hyperlink/EntryAssetTooltip.d.ts +0 -1
  37. package/dist/plugins/Hyperlink/HyperlinkModal.d.ts +4 -6
  38. package/dist/plugins/Hyperlink/index.d.ts +2 -6
  39. package/dist/plugins/Hyperlink/truncate.d.ts +1 -0
  40. package/dist/plugins/Hyperlink/utils.d.ts +3 -0
  41. package/dist/plugins/List/components/List.d.ts +3 -0
  42. package/dist/plugins/List/components/ListItem.d.ts +2 -0
  43. package/dist/plugins/List/components/ToolbarListButton.d.ts +4 -0
  44. package/dist/plugins/List/createListPlugin.d.ts +2 -0
  45. package/dist/plugins/List/index.d.ts +2 -15
  46. package/dist/plugins/List/insertListBreak.d.ts +2 -0
  47. package/dist/plugins/List/insertListFragment.d.ts +3 -0
  48. package/dist/plugins/List/transforms/deleteBackwardList.d.ts +2 -0
  49. package/dist/plugins/List/transforms/insertListItem.d.ts +5 -0
  50. package/dist/plugins/List/transforms/toggleList.d.ts +4 -0
  51. package/dist/plugins/List/transforms/unwrapList.d.ts +5 -0
  52. package/dist/plugins/List/utils.d.ts +15 -0
  53. package/dist/plugins/List/withList.d.ts +4 -0
  54. package/dist/plugins/Marks/Bold.d.ts +11 -0
  55. package/dist/plugins/Marks/Code.d.ts +11 -0
  56. package/dist/plugins/Marks/Italic.d.ts +11 -0
  57. package/dist/plugins/Marks/Underline.d.ts +11 -0
  58. package/dist/plugins/Marks/components/MarkToolbarButton.d.ts +13 -0
  59. package/dist/plugins/Marks/helpers.d.ts +4 -0
  60. package/dist/plugins/Marks/index.d.ts +2 -0
  61. package/dist/plugins/Normalizer/baseRules.d.ts +2 -0
  62. package/dist/plugins/Normalizer/createNormalizerPlugin.d.ts +2 -0
  63. package/dist/plugins/Normalizer/index.d.ts +2 -0
  64. package/dist/plugins/Normalizer/types.d.ts +40 -0
  65. package/dist/plugins/Normalizer/utils.d.ts +8 -0
  66. package/dist/plugins/Normalizer/withNormalizer.d.ts +2 -0
  67. package/dist/plugins/Paragraph/Paragraph.d.ts +2 -0
  68. package/dist/plugins/Paragraph/createParagraphPlugin.d.ts +2 -0
  69. package/dist/plugins/Paragraph/index.d.ts +1 -7
  70. package/dist/plugins/Paragraph/utils.d.ts +2 -0
  71. package/dist/plugins/PasteHTML/createPasteHTMLPlugin.d.ts +8 -0
  72. package/dist/plugins/PasteHTML/index.d.ts +1 -0
  73. package/dist/plugins/PasteHTML/utils/sanitizeHTML.d.ts +1 -0
  74. package/dist/plugins/PasteHTML/utils/sanitizeSheets.d.ts +4 -0
  75. package/dist/plugins/Quote/components/Quote.d.ts +2 -0
  76. package/dist/plugins/Quote/components/ToolbarQuoteButton.d.ts +4 -0
  77. package/dist/plugins/Quote/createQuotePlugin.d.ts +2 -0
  78. package/dist/plugins/Quote/index.d.ts +2 -13
  79. package/dist/plugins/Quote/shouldResetQuote.d.ts +8 -0
  80. package/dist/plugins/Quote/toggleQuote.d.ts +5 -0
  81. package/dist/plugins/Quote/withQuote.d.ts +3 -0
  82. package/dist/plugins/SelectOnBackspace/createSelectOnBackspacePlugin.d.ts +2 -0
  83. package/dist/plugins/SelectOnBackspace/index.d.ts +1 -0
  84. package/dist/plugins/Table/actions/addColumn.d.ts +4 -3
  85. package/dist/plugins/Table/actions/addRow.d.ts +3 -3
  86. package/dist/plugins/Table/actions/setHeader.d.ts +2 -2
  87. package/dist/plugins/Table/addTableTrackingEvents.d.ts +2 -0
  88. package/dist/plugins/Table/components/Cell.d.ts +2 -0
  89. package/dist/plugins/Table/components/HeaderCell.d.ts +2 -0
  90. package/dist/plugins/Table/components/Row.d.ts +2 -0
  91. package/dist/plugins/Table/components/Table.d.ts +2 -0
  92. package/dist/plugins/Table/components/TableActions.d.ts +4 -0
  93. package/dist/plugins/Table/components/ToolbarButton.d.ts +4 -0
  94. package/dist/plugins/Table/createTablePlugin.d.ts +2 -0
  95. package/dist/plugins/Table/helpers.d.ts +15 -5
  96. package/dist/plugins/Table/index.d.ts +2 -189
  97. package/dist/plugins/Text/createTextPlugin.d.ts +2 -0
  98. package/dist/plugins/Text/index.d.ts +1 -2
  99. package/dist/plugins/Tracking/createTrackingPlugin.d.ts +10 -0
  100. package/dist/plugins/Tracking/index.d.ts +1 -0
  101. package/dist/plugins/Tracking/utils.d.ts +2 -0
  102. package/dist/plugins/TrailingParagraph/index.d.ts +2 -1
  103. package/dist/plugins/Voids/createVoidsPlugin.d.ts +2 -0
  104. package/dist/plugins/Voids/index.d.ts +1 -0
  105. package/dist/plugins/Voids/transformVoid.d.ts +6 -0
  106. package/dist/plugins/index.d.ts +5 -179
  107. package/dist/plugins/links-tracking.d.ts +6 -0
  108. package/dist/plugins/shared/EntityStatusIcon.d.ts +0 -1
  109. package/dist/plugins/shared/FetchingWrappedAssetCard.d.ts +1 -1
  110. package/dist/plugins/shared/FetchingWrappedEntryCard.d.ts +3 -3
  111. package/dist/plugins/shared/ToolbarButton.d.ts +0 -1
  112. package/dist/test-utils/assertOutput.d.ts +7 -0
  113. package/dist/test-utils/createEditor.d.ts +10 -4
  114. package/dist/test-utils/index.d.ts +2 -0
  115. package/dist/test-utils/jsx.d.ts +2 -2
  116. package/dist/test-utils/mockPlugin.d.ts +2 -0
  117. package/dist/test-utils/randomId.d.ts +4 -0
  118. package/dist/test-utils/setEmptyDataAttribute.d.ts +6 -0
  119. package/dist/test-utils/validation.d.ts +1 -0
  120. package/dist/types.d.ts +34 -9
  121. package/dist/useNormalizedSlateValue.d.ts +7 -0
  122. package/dist/useOnValueChanged.d.ts +7 -0
  123. package/package.json +28 -17
  124. package/CHANGELOG.md +0 -410
  125. package/dist/TrackingProvider.d.ts +0 -11
  126. package/dist/helpers/deserializer.d.ts +0 -3
  127. package/dist/helpers/normalizers.d.ts +0 -15
  128. package/dist/helpers/sanitizeSlateDoc.d.ts +0 -18
  129. package/dist/helpers/truncate.d.ts +0 -1
  130. package/dist/plugins/Bold/index.d.ts +0 -12
  131. package/dist/plugins/Code/index.d.ts +0 -12
  132. package/dist/plugins/CommandPalette/CommandPanel/InViewport/InViewport.d.ts +0 -37
  133. package/dist/plugins/InsertBeforeFirstVoidBlock/index.d.ts +0 -2
  134. package/dist/plugins/Italic/index.d.ts +0 -12
  135. package/dist/plugins/List/getListInsertFragment.d.ts +0 -6
  136. package/dist/plugins/NewLine/index.d.ts +0 -2
  137. package/dist/plugins/Paste/index.d.ts +0 -2
  138. package/dist/plugins/Paste/sanitizers/helpers.d.ts +0 -7
  139. package/dist/plugins/Paste/sanitizers/index.d.ts +0 -3
  140. package/dist/plugins/Paste/sanitizers/removeComments.d.ts +0 -2
  141. package/dist/plugins/Paste/sanitizers/sanitizeEntityBlocks.d.ts +0 -6
  142. package/dist/plugins/Paste/sanitizers/sanitizeTables.d.ts +0 -2
  143. package/dist/plugins/Table/TableActions.d.ts +0 -5
  144. package/dist/plugins/Table/normalizers.d.ts +0 -2
  145. package/dist/plugins/Underline/index.d.ts +0 -12
package/README.md CHANGED
@@ -12,3 +12,7 @@ This editor app is built on top of [Slate](https://github.com/ianstormtaylor/sla
12
12
  import 'codemirror/lib/codemirror.css';
13
13
  import { RichTextEditor } from '@contentful/field-editor-rich-text';
14
14
  ```
15
+
16
+ ## Credits
17
+
18
+ This package is based on [Slate](https://www.slatejs.org/) & [Plate](https://plate.udecode.io/) and also borrows some of their code. Without them this project would not have been possible.
@@ -1,8 +1,9 @@
1
1
  /// <reference types="react" />
2
2
  import { FieldExtensionSDK } from '@contentful/app-sdk';
3
+ import { RichTextEditor } from './types';
3
4
  export declare function getContentfulEditorId(sdk: FieldExtensionSDK): string;
4
- interface useContentfulEditorHookProps {
5
- sdk: FieldExtensionSDK;
6
- }
7
- export declare const ContentfulEditorProvider: import("react").FC<useContentfulEditorHookProps>, useContentfulEditor: any;
8
- export {};
5
+ export declare const editorContext: import("react").Context<string>;
6
+ export declare const ContentfulEditorIdProvider: import("react").Provider<string>;
7
+ export declare function useContentfulEditorId(id?: string): string;
8
+ export declare function useContentfulEditor(id?: string): import("@udecode/plate-core").PlateEditor<RichTextEditor>;
9
+ export declare function useContentfulEditorRef(id?: string): import("@udecode/plate-core").PlateEditor<RichTextEditor>;
@@ -1,7 +1,6 @@
1
- /// <reference types="react" />
2
- import * as Contentful from '@contentful/rich-text-types';
3
- import { RichTextTrackingActionHandler } from './TrackingProvider';
4
1
  import { FieldExtensionSDK } from '@contentful/app-sdk';
2
+ import * as Contentful from '@contentful/rich-text-types';
3
+ import { RichTextTrackingActionHandler } from './plugins/Tracking';
5
4
  declare type ConnectedProps = {
6
5
  sdk: FieldExtensionSDK;
7
6
  onAction?: RichTextTrackingActionHandler;
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  export interface EmbedEntityWidgetProps {
3
2
  isDisabled?: boolean;
4
3
  canInsertBlocks?: boolean;
@@ -1,5 +1,5 @@
1
1
  import * as React from 'react';
2
- interface EmbeddedEntityDropdownButtonProps {
2
+ export interface EmbeddedEntityDropdownButtonProps {
3
3
  children: React.ReactNode;
4
4
  isDisabled: boolean | undefined;
5
5
  isOpen: boolean;
@@ -7,4 +7,3 @@ interface EmbeddedEntityDropdownButtonProps {
7
7
  onToggle: () => void;
8
8
  }
9
9
  export declare function EmbeddedEntityDropdownButton({ children, isDisabled, isOpen, onClose, onToggle, }: EmbeddedEntityDropdownButtonProps): JSX.Element;
10
- export {};
@@ -1,4 +1,3 @@
1
- /// <reference types="react" />
2
1
  declare type ToolbarProps = {
3
2
  isDisabled?: boolean;
4
3
  };
@@ -1,3 +1,2 @@
1
- /// <reference types="react" />
2
1
  import { DialogExtensionSDK } from '@contentful/app-sdk';
3
2
  export declare const renderRichTextDialog: (sdk: DialogExtensionSDK) => JSX.Element;