@procore/text-editor 1.0.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/.jest/ckeditorMock.js +2 -0
  2. package/.jest/ckeditorUtilsMock.js +14 -0
  3. package/CHANGELOG.md +30 -0
  4. package/dist/DebouncedTextEditor/DebouncedTextEditor.js +1 -1
  5. package/dist/DebouncedTextEditor/DebouncedTextEditor.js.map +1 -1
  6. package/dist/DebouncedTextEditor/index.js.map +1 -1
  7. package/dist/TextEditor/CKTextEditor.js +15 -9
  8. package/dist/TextEditor/CKTextEditor.js.map +1 -1
  9. package/dist/TextEditor/EditorError.js.map +1 -1
  10. package/dist/TextEditor/Providers/FeatureFlagProvider.js.map +1 -1
  11. package/dist/TextEditor/StickyToolbar/index.js.map +1 -1
  12. package/dist/TextEditor/StickyToolbar/useStickyToolbar.js.map +1 -1
  13. package/dist/TextEditor/StickyToolbar/useStickyToolbar.types.js.map +1 -1
  14. package/dist/TextEditor/TextEditor.js.map +1 -1
  15. package/dist/TextEditor/TextEditor.styles.d.ts +7 -8
  16. package/dist/TextEditor/TextEditor.styles.js +5 -5
  17. package/dist/TextEditor/TextEditor.styles.js.map +1 -1
  18. package/dist/TextEditor/TextEditor.types.d.ts +1 -1
  19. package/dist/TextEditor/TextEditor.types.js.map +1 -1
  20. package/dist/TextEditor/TextEditorI18nProvider.js.map +1 -1
  21. package/dist/TextEditor/TextEditorProvider.js.map +1 -1
  22. package/dist/TextEditor/TextEditorProvider.types.d.ts +1 -1
  23. package/dist/TextEditor/TextEditorProvider.types.js.map +1 -1
  24. package/dist/TextEditor/TinyMCETextEditor.js.map +1 -1
  25. package/dist/TextEditor/index.d.ts +1 -1
  26. package/dist/TextEditor/index.js +0 -1
  27. package/dist/TextEditor/index.js.map +1 -1
  28. package/dist/TextEditor/license_key.js.map +1 -1
  29. package/dist/TextEditor/plugins/CutPlugin/CutCommand.js +21 -29
  30. package/dist/TextEditor/plugins/CutPlugin/CutCommand.js.map +1 -1
  31. package/dist/TextEditor/plugins/CutPlugin/CutPlugin.js +2 -2
  32. package/dist/TextEditor/plugins/CutPlugin/CutPlugin.js.map +1 -1
  33. package/dist/TextEditor/plugins/CutPlugin/index.js.map +1 -1
  34. package/dist/TextEditor/plugins/IndentPaddingToMarginPlugin/IndentPaddingToMarginPlugin.js.map +1 -1
  35. package/dist/TextEditor/plugins/IndentPaddingToMarginPlugin/index.js.map +1 -1
  36. package/dist/TextEditor/plugins/NormalizeTableWidthPlugin/NormalizeTableWidthPlugin.js.map +1 -1
  37. package/dist/TextEditor/plugins/NormalizeTableWidthPlugin/index.js.map +1 -1
  38. package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextCommand.js +20 -28
  39. package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextCommand.js.map +1 -1
  40. package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextPlugin.js +2 -2
  41. package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextPlugin.js.map +1 -1
  42. package/dist/TextEditor/plugins/PasteAsTextPlugin/index.js.map +1 -1
  43. package/dist/TextEditor/plugins/PastePlugin/PasteCommand.js +54 -62
  44. package/dist/TextEditor/plugins/PastePlugin/PasteCommand.js.map +1 -1
  45. package/dist/TextEditor/plugins/PastePlugin/PastePlugin.js +2 -2
  46. package/dist/TextEditor/plugins/PastePlugin/PastePlugin.js.map +1 -1
  47. package/dist/TextEditor/plugins/PastePlugin/index.js.map +1 -1
  48. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.d.ts +1 -1
  49. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js +50 -59
  50. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js.map +1 -1
  51. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/index.js.map +1 -1
  52. package/dist/TextEditor/plugins/TabSpacesPlugin/TabSpacesPlugin.js.map +1 -1
  53. package/dist/TextEditor/plugins/TabSpacesPlugin/index.js.map +1 -1
  54. package/dist/TextEditor/textEditorTheming/icons.js.map +1 -1
  55. package/dist/TextEditor/textEditorTheming/index.js.map +1 -1
  56. package/dist/TextEditor/textEditorTheming/textEditorTheming.styles.d.ts +0 -1
  57. package/dist/TextEditor/textEditorTheming/textEditorTheming.styles.js.map +1 -1
  58. package/dist/TextEditor/useCKEditorCss.js.map +1 -1
  59. package/dist/TextEditor/useCKEditorFocusScope.js.map +1 -1
  60. package/dist/TextEditor/useTabAsNavigation.js.map +1 -1
  61. package/dist/TextEditor/utils/config.js +29 -4
  62. package/dist/TextEditor/utils/config.js.map +1 -1
  63. package/dist/TextEditor/utils/imageAttributes.js.map +1 -1
  64. package/dist/TextEditor/utils/imageUrls.js.map +1 -1
  65. package/dist/TextEditor/utils/index.js.map +1 -1
  66. package/dist/TextEditor/utils/locale.js +12 -1
  67. package/dist/TextEditor/utils/locale.js.map +1 -1
  68. package/dist/TextEditor/utils/richTextEditorHandlers.d.ts +2 -2
  69. package/dist/TextEditor/utils/richTextEditorHandlers.js +62 -81
  70. package/dist/TextEditor/utils/richTextEditorHandlers.js.map +1 -1
  71. package/dist/TextEditorOutput/TextEditorOutput.js.map +1 -1
  72. package/dist/TextEditorOutput/TextEditorOutput.styles.d.ts +0 -1
  73. package/dist/TextEditorOutput/TextEditorOutput.styles.js +2 -2
  74. package/dist/TextEditorOutput/TextEditorOutput.styles.js.map +1 -1
  75. package/dist/TextEditorOutput/TextEditorOutput.types.d.ts +0 -1
  76. package/dist/TextEditorOutput/TextEditorOutput.types.js.map +1 -1
  77. package/dist/TextEditorOutput/TextEditorOutput.utils.js +12 -4
  78. package/dist/TextEditorOutput/TextEditorOutput.utils.js.map +1 -1
  79. package/dist/TextEditorOutput/index.js.map +1 -1
  80. package/dist/_storyHelpers/constants.js.map +1 -1
  81. package/dist/_typedoc/TextEditor/TextEditor.types.json +153 -153
  82. package/dist/_typedoc/TextEditor/TextEditorProvider.types.json +4 -4
  83. package/dist/_typedoc/TextEditorOutput/TextEditorOutput.types.json +9 -9
  84. package/dist/_utils/propsTypedoc.d.ts +3 -3
  85. package/dist/_utils/propsTypedoc.js +1 -3
  86. package/dist/_utils/propsTypedoc.js.map +1 -1
  87. package/dist/ckeditor5-premium-features.d.js.map +1 -1
  88. package/dist/index.js.map +1 -1
  89. package/dist/locales/de-DE.json +17 -0
  90. package/dist/locales/en-AU.json +17 -0
  91. package/dist/locales/en-CA.json +17 -0
  92. package/dist/locales/en-GB.json +17 -0
  93. package/dist/locales/es-ES.json +17 -0
  94. package/dist/locales/es.json +17 -0
  95. package/dist/locales/fr-CA.json +17 -0
  96. package/dist/locales/fr-FR.json +17 -0
  97. package/dist/locales/is-IS.json +17 -0
  98. package/dist/locales/it-IT.json +17 -0
  99. package/dist/locales/ja-JP.json +17 -0
  100. package/dist/locales/nb-NO.json +17 -0
  101. package/dist/locales/pl-PL.json +17 -0
  102. package/dist/locales/pt-BR.json +17 -0
  103. package/dist/locales/pt-PT.json +17 -0
  104. package/dist/locales/th-TH.json +17 -0
  105. package/dist/locales/zh-SG.json +17 -0
  106. package/dist/locales/zh-TW.json +17 -0
  107. package/dist/stories/util.js.map +1 -1
  108. package/dist/utils/debounce.js +1 -1
  109. package/dist/utils/debounce.js.map +1 -1
  110. package/jestConfig.js +0 -2
  111. package/package.json +44 -42
  112. package/.jest/translationMock.js +0 -12
@@ -9,38 +9,38 @@
9
9
  "typeDetail": "<span class=\"tsd-signature-type\">Pick</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">I18njs</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">&quot;t&quot;</span><span class=\"tsd-signature-symbol\">&gt;</span>",
10
10
  "description": "",
11
11
  "descriptionHtml": "",
12
- "sourceFile": "TextEditor/TextEditor.types.ts",
13
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
12
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
13
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
14
14
  },
15
15
  {
16
16
  "name": "onError",
17
17
  "required": false,
18
18
  "type": "Function",
19
- "typeDetail": "on<wbr/>Error<span class=\"tsd-signature-symbol\">(</span>message<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
19
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>message: <span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
20
20
  "description": "",
21
21
  "descriptionHtml": "",
22
- "sourceFile": "TextEditor/TextEditor.types.ts",
23
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L35"
22
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
23
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L35"
24
24
  },
25
25
  {
26
26
  "name": "onWarning",
27
27
  "required": false,
28
28
  "type": "Function",
29
- "typeDetail": "on<wbr/>Warning<span class=\"tsd-signature-symbol\">(</span>message<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
29
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>message: <span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
30
30
  "description": "",
31
31
  "descriptionHtml": "",
32
- "sourceFile": "TextEditor/TextEditor.types.ts",
33
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L36"
32
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
33
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L36"
34
34
  },
35
35
  {
36
36
  "name": "upload",
37
37
  "required": true,
38
38
  "type": "Function",
39
- "typeDetail": "upload<span class=\"tsd-signature-symbol\">(</span>file<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">File</span>, context<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-symbol\">{ </span>signal<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">AbortSignal</span><span class=\"tsd-signature-symbol\"> }</span>, callbacks<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-symbol\">{ </span>onProgress<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">any</span><span class=\"tsd-signature-symbol\"> }</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Promise</span><span class=\"tsd-signature-symbol\">&lt;</span><a class=\"tsd-signature-type\" data-tsd-kind=\"Interface\">TextEditorImageUploadResult</a><span class=\"tsd-signature-symbol\">&gt;</span>",
39
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>file: <span class=\"tsd-signature-type\">File</span>, context: <span class=\"tsd-signature-symbol\">{</span> signal<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">AbortSignal</span> <span class=\"tsd-signature-symbol\">}</span>, callbacks: <span class=\"tsd-signature-symbol\">{</span> onProgress?<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-symbol\">(</span>uploaded: <span class=\"tsd-signature-type\">number</span>, total?: <span class=\"tsd-signature-type\">number</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span> <span class=\"tsd-signature-symbol\">}</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">Promise</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">TextEditorImageUploadResult</span><span class=\"tsd-signature-symbol\">&gt;</span>",
40
40
  "description": "Uploads the selected image and returns durable backend-approved image URLs.",
41
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Uploads the selected image and returns durable backend-approved image URLs.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.4.2</p>\n</dd></dl></div>",
42
- "sourceFile": "TextEditor/TextEditor.types.ts",
43
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L29"
41
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Uploads the selected image and returns durable backend-approved image URLs.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.4.2</p></dd></dl></div>",
42
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
43
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L29"
44
44
  }
45
45
  ],
46
46
  "description": ""
@@ -54,9 +54,9 @@
54
54
  "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
55
55
  "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
56
56
  "description": "Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.",
57
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.5.0</p>\n</dd></dl></div>",
58
- "sourceFile": "TextEditor/TextEditor.types.ts",
59
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
57
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.5.0</p></dd></dl></div>",
58
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
59
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
60
60
  },
61
61
  {
62
62
  "name": "projectId",
@@ -65,8 +65,8 @@
65
65
  "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
66
66
  "description": "",
67
67
  "descriptionHtml": "",
68
- "sourceFile": "TextEditor/TextEditor.types.ts",
69
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
68
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
69
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
70
70
  },
71
71
  {
72
72
  "name": "toolName",
@@ -74,9 +74,9 @@
74
74
  "type": "<span class=\"tsd-signature-type\">string</span>",
75
75
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
76
76
  "description": "Identifier of the tool hosting the editor (e.g. `rfis`, `submittal_log`).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.",
77
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Identifier of the tool hosting the editor (e.g. <code>rfis</code>, <code>submittal_log</code>).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.7.0</p>\n</dd></dl></div>",
78
- "sourceFile": "TextEditor/TextEditor.types.ts",
79
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
77
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Identifier of the tool hosting the editor (e.g. <code>rfis</code>, <code>submittal_log</code>).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.7.0</p></dd></dl></div>",
78
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
79
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
80
80
  }
81
81
  ],
82
82
  "description": ""
@@ -91,8 +91,8 @@
91
91
  "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
92
92
  "description": "",
93
93
  "descriptionHtml": "",
94
- "sourceFile": "TextEditor/TextEditor.types.ts",
95
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
94
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
95
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
96
96
  },
97
97
  {
98
98
  "name": "prostoreFileId",
@@ -100,19 +100,19 @@
100
100
  "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
101
101
  "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
102
102
  "description": "Durable ProstoreFile id. The text editor embeds this ID in saved markup to\nmark the image as a first-party upload (backend email/PDF sanitizers rely on\nit). The persisted URL is a permanent, publicly fetchable Prostore URL, so\nit renders as-is in the app, emails, and exports.",
103
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Durable ProstoreFile id. The text editor embeds this ID in saved markup to\nmark the image as a first-party upload (backend email/PDF sanitizers rely on\nit). The persisted URL is a permanent, publicly fetchable Prostore URL, so\nit renders as-is in the app, emails, and exports.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.6.0</p>\n</dd></dl></div>",
104
- "sourceFile": "TextEditor/TextEditor.types.ts",
105
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L18"
103
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Durable ProstoreFile id. The text editor embeds this ID in saved markup to\nmark the image as a first-party upload (backend email/PDF sanitizers rely on\nit). The persisted URL is a permanent, publicly fetchable Prostore URL, so\nit renders as-is in the app, emails, and exports.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.6.0</p></dd></dl></div>",
104
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
105
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L18"
106
106
  },
107
107
  {
108
108
  "name": "urls",
109
109
  "required": true,
110
- "type": "<span class=\"tsd-signature-symbol\">{ </span>default<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</span>",
111
- "typeDetail": "<span class=\"tsd-signature-symbol\">{ </span>default<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> }</span>",
110
+ "type": "<span class=\"tsd-signature-symbol\">{</span> default<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span> <span class=\"tsd-signature-symbol\">}</span>",
111
+ "typeDetail": "<span class=\"tsd-signature-symbol\">{</span> default<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span> <span class=\"tsd-signature-symbol\">}</span>",
112
112
  "description": "",
113
113
  "descriptionHtml": "",
114
- "sourceFile": "TextEditor/TextEditor.types.ts",
115
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L7"
114
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
115
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L7"
116
116
  },
117
117
  {
118
118
  "name": "width",
@@ -121,8 +121,8 @@
121
121
  "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
122
122
  "description": "",
123
123
  "descriptionHtml": "",
124
- "sourceFile": "TextEditor/TextEditor.types.ts",
125
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L19"
124
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
125
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L19"
126
126
  }
127
127
  ],
128
128
  "description": ""
@@ -136,9 +136,9 @@
136
136
  "type": "<span class=\"tsd-signature-type\">string</span>",
137
137
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
138
138
  "description": "Accessible description for the editor's editable area.\nThis text provides additional context to screen reader users. It will be\nannounced after the label when the user focuses the editor.",
139
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible description for the editor&#39;s editable area.\nThis text provides additional context to screen reader users. It will be\nannounced after the label when the user focuses the editor.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p>\n</dd></dl></div>",
140
- "sourceFile": "TextEditor/TextEditor.types.ts",
141
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L123"
139
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible description for the editor's editable area.\nThis text provides additional context to screen reader users. It will be\nannounced after the label when the user focuses the editor.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p></dd></dl></div>",
140
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
141
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L123"
142
142
  },
143
143
  {
144
144
  "name": "aria-label",
@@ -146,9 +146,9 @@
146
146
  "type": "<span class=\"tsd-signature-type\">string</span>",
147
147
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
148
148
  "description": "Accessible label for the editor's editable area. This text will be\nannounced by screen readers when the user focuses the editor. It should\nmatch or include the visible label associated with this editor field.\nIf not provided, screen readers will announce a generic \"Rich Text Editor\" message.",
149
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible label for the editor&#39;s editable area. This text will be\nannounced by screen readers when the user focuses the editor. It should\nmatch or include the visible label associated with this editor field.\nIf not provided, screen readers will announce a generic &quot;Rich Text Editor&quot; message.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p>\n</dd></dl></div>",
150
- "sourceFile": "TextEditor/TextEditor.types.ts",
151
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L114"
149
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible label for the editor's editable area. This text will be\nannounced by screen readers when the user focuses the editor. It should\nmatch or include the visible label associated with this editor field.\nIf not provided, screen readers will announce a generic &quot;Rich Text Editor&quot; message.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p></dd></dl></div>",
150
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
151
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L114"
152
152
  },
153
153
  {
154
154
  "name": "companyId",
@@ -156,9 +156,9 @@
156
156
  "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
157
157
  "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
158
158
  "description": "Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.",
159
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.5.0</p>\n</dd></dl></div>",
160
- "sourceFile": "TextEditor/TextEditor.types.ts",
161
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
159
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.5.0</p></dd></dl></div>",
160
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
161
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
162
162
  },
163
163
  {
164
164
  "name": "disabled",
@@ -166,9 +166,9 @@
166
166
  "type": "<span class=\"tsd-signature-type\">boolean</span>",
167
167
  "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
168
168
  "description": "Indicates if the editor is disabled",
169
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is disabled</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
170
- "sourceFile": "TextEditor/TextEditor.types.ts",
171
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L89"
169
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is disabled</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
170
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
171
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L89"
172
172
  },
173
173
  {
174
174
  "name": "enforceCKEditor",
@@ -176,9 +176,9 @@
176
176
  "type": "<span class=\"tsd-signature-type\">true</span>",
177
177
  "typeDetail": "<span class=\"tsd-signature-type\">true</span>",
178
178
  "description": "Opt in to CKEditor immediately, bypassing the gradual feature flag rollout.\nUse this only when you explicitly want to ignore the rollout schedule.\nWhen enabled, the LaunchDarkly flag is bypassed and CKEditor is rendered directly.",
179
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Opt in to CKEditor immediately, bypassing the gradual feature flag rollout.\nUse this only when you explicitly want to ignore the rollout schedule.\nWhen enabled, the LaunchDarkly flag is bypassed and CKEditor is rendered directly.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p>\n</dd></dl></div>",
180
- "sourceFile": "TextEditor/TextEditor.types.ts",
181
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L229"
179
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Opt in to CKEditor immediately, bypassing the gradual feature flag rollout.\nUse this only when you explicitly want to ignore the rollout schedule.\nWhen enabled, the LaunchDarkly flag is bypassed and CKEditor is rendered directly.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p></dd></dl></div>",
180
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
181
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L229"
182
182
  },
183
183
  {
184
184
  "name": "error",
@@ -186,9 +186,9 @@
186
186
  "type": "<span class=\"tsd-signature-type\">boolean</span>",
187
187
  "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
188
188
  "description": "Indicates if the editor is in an error state",
189
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is in an error state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
190
- "sourceFile": "TextEditor/TextEditor.types.ts",
191
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L96"
189
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is in an error state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
190
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
191
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L96"
192
192
  },
193
193
  {
194
194
  "name": "id",
@@ -196,9 +196,9 @@
196
196
  "type": "<span class=\"tsd-signature-type\">string</span>",
197
197
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
198
198
  "description": "Unique identifier for the editor",
199
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Unique identifier for the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
200
- "sourceFile": "TextEditor/TextEditor.types.ts",
201
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L65"
199
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Unique identifier for the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
200
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
201
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L65"
202
202
  },
203
203
  {
204
204
  "name": "init",
@@ -206,9 +206,9 @@
206
206
  "type": "<span class=\"tsd-signature-type\">InitOptions</span>",
207
207
  "typeDetail": "<span class=\"tsd-signature-type\">InitOptions</span>",
208
208
  "description": "TinyMCE init configuration. Merged with internal defaults; use this to\npass custom content_style, paste hooks, or other TinyMCE-specific options.\nHas no effect when CKEditor is active.",
209
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>TinyMCE init configuration. Merged with internal defaults; use this to\npass custom content_style, paste hooks, or other TinyMCE-specific options.\nHas no effect when CKEditor is active.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p>\n</dd></dl></div>",
210
- "sourceFile": "TextEditor/TextEditor.types.ts",
211
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L212"
209
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>TinyMCE init configuration. Merged with internal defaults; use this to\npass custom content_style, paste hooks, or other TinyMCE-specific options.\nHas no effect when CKEditor is active.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p></dd></dl></div>",
210
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
211
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L212"
212
212
  },
213
213
  {
214
214
  "name": "initialValue",
@@ -216,11 +216,11 @@
216
216
  "type": "<span class=\"tsd-signature-type\">string</span>",
217
217
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
218
218
  "description": "Initial value of the editor",
219
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Initial value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p><code>initialValue</code> has been deprecated and will be removed in a future version.\nPlease use the <code>value</code> prop instead</p>\n</dd><dt>deprecatedsince</dt><dd><p>0.0.1</p>\n</dd><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
219
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Initial value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
220
220
  "deprecated": "`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead",
221
221
  "deprecatedSince": "0.0.1",
222
- "sourceFile": "TextEditor/TextEditor.types.ts",
223
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L75"
222
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
223
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L75"
224
224
  },
225
225
  {
226
226
  "name": "locale",
@@ -228,149 +228,149 @@
228
228
  "type": "<span class=\"tsd-signature-type\">string</span>",
229
229
  "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
230
230
  "description": "Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.",
231
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
232
- "sourceFile": "TextEditor/TextEditor.types.ts",
233
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L130"
234
- },
235
- {
236
- "name": "placeholder",
237
- "required": false,
238
- "type": "<span class=\"tsd-signature-type\">string</span>",
239
- "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
240
- "description": "Placeholder text shown when the editor is empty",
241
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Placeholder text shown when the editor is empty</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p>\n</dd></dl></div>",
242
- "sourceFile": "TextEditor/TextEditor.types.ts",
243
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L203"
244
- },
245
- {
246
- "name": "projectId",
247
- "required": false,
248
- "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
249
- "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
250
- "description": "",
251
- "descriptionHtml": "",
252
- "sourceFile": "TextEditor/TextEditor.types.ts",
253
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
254
- },
255
- {
256
- "name": "readonly",
257
- "required": false,
258
- "type": "<span class=\"tsd-signature-type\">boolean</span>",
259
- "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
260
- "description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
261
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.2.0</p>\n</dd></dl></div>",
262
- "sourceFile": "TextEditor/TextEditor.types.ts",
263
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L104"
264
- },
265
- {
266
- "name": "rows",
267
- "required": false,
268
- "type": "<span class=\"tsd-signature-type\">number</span>",
269
- "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
270
- "description": "Number of rows to control the editor height. When set, the editor height\nis fixed. When omitted, the editor grows with content.",
271
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Number of rows to control the editor height. When set, the editor height\nis fixed. When omitted, the editor grows with content.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p>\n</dd></dl></div>",
272
- "sourceFile": "TextEditor/TextEditor.types.ts",
273
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L220"
274
- },
275
- {
276
- "name": "toolName",
277
- "required": false,
278
- "type": "<span class=\"tsd-signature-type\">string</span>",
279
- "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
280
- "description": "Identifier of the tool hosting the editor (e.g. `rfis`, `submittal_log`).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.",
281
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Identifier of the tool hosting the editor (e.g. <code>rfis</code>, <code>submittal_log</code>).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.7.0</p>\n</dd></dl></div>",
282
- "sourceFile": "TextEditor/TextEditor.types.ts",
283
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
284
- },
285
- {
286
- "name": "value",
287
- "required": false,
288
- "type": "<span class=\"tsd-signature-type\">string</span>",
289
- "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
290
- "description": "The current value of the editor",
291
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The current value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
292
- "sourceFile": "TextEditor/TextEditor.types.ts",
293
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
231
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
232
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
233
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L130"
294
234
  },
295
235
  {
296
236
  "name": "onAfterDestroy",
297
237
  "required": false,
298
238
  "type": "Function",
299
- "typeDetail": "on<wbr/>After<wbr/>Destroy<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
239
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
300
240
  "description": "Callback fired after the editor instance is destroyed",
301
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired after the editor instance is destroyed</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
302
- "sourceFile": "TextEditor/TextEditor.types.ts",
303
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L180"
241
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired after the editor instance is destroyed</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
242
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
243
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L180"
304
244
  },
305
245
  {
306
246
  "name": "onBlur",
307
247
  "required": false,
308
248
  "type": "Function",
309
- "typeDetail": "on<wbr/>Blur<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EventInfo</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">unknown</span><span class=\"tsd-signature-symbol\">&gt;</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
249
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>event: <span class=\"tsd-signature-type\">EventInfo</span>, editor: <span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
310
250
  "description": "Callback fired when the editor loses focus",
311
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor loses focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
312
- "sourceFile": "TextEditor/TextEditor.types.ts",
313
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L153"
251
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor loses focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
252
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
253
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L153"
314
254
  },
315
255
  {
316
256
  "name": "onChange",
317
257
  "required": false,
318
258
  "type": "Function",
319
- "typeDetail": "on<wbr/>Change<span class=\"tsd-signature-symbol\">(</span>value<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span>, isDirty<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
259
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>value: <span class=\"tsd-signature-type\">string</span>, isDirty?: <span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
320
260
  "description": "Callback fired when the editor content changes",
321
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor content changes</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
322
- "sourceFile": "TextEditor/TextEditor.types.ts",
323
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L139"
261
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor content changes</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
262
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
263
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L139"
324
264
  },
325
265
  {
326
266
  "name": "onDirty",
327
267
  "required": false,
328
268
  "type": "Function",
329
- "typeDetail": "on<wbr/>Dirty<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
269
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
330
270
  "description": "Callback fired when the editor becomes dirty (content differs from initial value)",
331
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor becomes dirty (content differs from initial value)</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
332
- "sourceFile": "TextEditor/TextEditor.types.ts",
333
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L187"
271
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor becomes dirty (content differs from initial value)</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
272
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
273
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L187"
334
274
  },
335
275
  {
336
276
  "name": "onError",
337
277
  "required": false,
338
278
  "type": "Function",
339
- "typeDetail": "on<wbr/>Error<span class=\"tsd-signature-symbol\">(</span>error<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Error</span>, details<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-symbol\">{ </span>phase<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">&quot;initialization&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;runtime&quot;</span><span class=\"tsd-signature-symbol\">; </span>willEditorRestart<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> }</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
279
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>error: <span class=\"tsd-signature-type\">Error</span>, details: <span class=\"tsd-signature-symbol\">{</span> phase<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">&quot;initialization&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;runtime&quot;</span><span class=\"tsd-signature-symbol\">; </span>willEditorRestart?<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">boolean</span> <span class=\"tsd-signature-symbol\">}</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
340
280
  "description": "Callback fired when an error occurs in the editor",
341
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when an error occurs in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
342
- "sourceFile": "TextEditor/TextEditor.types.ts",
343
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L160"
281
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when an error occurs in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
282
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
283
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L160"
344
284
  },
345
285
  {
346
286
  "name": "onFocus",
347
287
  "required": false,
348
288
  "type": "Function",
349
- "typeDetail": "on<wbr/>Focus<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EventInfo</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">unknown</span><span class=\"tsd-signature-symbol\">&gt;</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
289
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>event: <span class=\"tsd-signature-type\">EventInfo</span>, editor: <span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
350
290
  "description": "Callback fired when the editor gains focus",
351
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor gains focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
352
- "sourceFile": "TextEditor/TextEditor.types.ts",
353
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L146"
291
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor gains focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
292
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
293
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L146"
354
294
  },
355
295
  {
356
296
  "name": "onInit",
357
297
  "required": false,
358
298
  "type": "Function",
359
- "typeDetail": "on<wbr/>Init<span class=\"tsd-signature-symbol\">(</span>editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
299
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>editor: <span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
360
300
  "description": "Callback fired when the editor is ready",
361
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor is ready</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
362
- "sourceFile": "TextEditor/TextEditor.types.ts",
363
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L173"
301
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor is ready</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
302
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
303
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L173"
364
304
  },
365
305
  {
366
306
  "name": "onKeyDown",
367
307
  "required": false,
368
308
  "type": "Function",
369
- "typeDetail": "on<wbr/>Key<wbr/>Down<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">KeyboardEvent</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
309
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span>event: <span class=\"tsd-signature-type\">KeyboardEvent</span>, editor: <span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
370
310
  "description": "Callback fired when a key is pressed in the editor",
371
- "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when a key is pressed in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
372
- "sourceFile": "TextEditor/TextEditor.types.ts",
373
- "sourceUrl": "https://github.com/procore/core/blob/bb2ee27/packages/text-editor/src/TextEditor/TextEditor.types.ts#L196"
311
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when a key is pressed in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
312
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
313
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L196"
314
+ },
315
+ {
316
+ "name": "placeholder",
317
+ "required": false,
318
+ "type": "<span class=\"tsd-signature-type\">string</span>",
319
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
320
+ "description": "Placeholder text shown when the editor is empty",
321
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Placeholder text shown when the editor is empty</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p></dd></dl></div>",
322
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
323
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L203"
324
+ },
325
+ {
326
+ "name": "projectId",
327
+ "required": false,
328
+ "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
329
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
330
+ "description": "",
331
+ "descriptionHtml": "",
332
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
333
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
334
+ },
335
+ {
336
+ "name": "readonly",
337
+ "required": false,
338
+ "type": "<span class=\"tsd-signature-type\">boolean</span>",
339
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
340
+ "description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
341
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.2.0</p></dd></dl></div>",
342
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
343
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L104"
344
+ },
345
+ {
346
+ "name": "rows",
347
+ "required": false,
348
+ "type": "<span class=\"tsd-signature-type\">number</span>",
349
+ "typeDetail": "<span class=\"tsd-signature-type\">number</span>",
350
+ "description": "Number of rows to control the editor height. When set, the editor height\nis fixed. When omitted, the editor grows with content.",
351
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Number of rows to control the editor height. When set, the editor height\nis fixed. When omitted, the editor grows with content.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.0.0</p></dd></dl></div>",
352
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
353
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L220"
354
+ },
355
+ {
356
+ "name": "toolName",
357
+ "required": false,
358
+ "type": "<span class=\"tsd-signature-type\">string</span>",
359
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
360
+ "description": "Identifier of the tool hosting the editor (e.g. `rfis`, `submittal_log`).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.",
361
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Identifier of the tool hosting the editor (e.g. <code>rfis</code>, <code>submittal_log</code>).\nRequired to enable image uploads: it is sent with each upload for\nattribution/audit and is validated by the backend against known tools.\nWhen omitted, the editor renders without the Procore image-upload plugin.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.7.0</p></dd></dl></div>",
362
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
363
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
364
+ },
365
+ {
366
+ "name": "value",
367
+ "required": false,
368
+ "type": "<span class=\"tsd-signature-type\">string</span>",
369
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
370
+ "description": "The current value of the editor",
371
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>The current value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p></dd></dl></div>",
372
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
373
+ "sourceUrl": "https://github.com/procore/core/blob/8b69fd24db849f5514b8a2a86f1bfc61cb1ead77/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
374
374
  }
375
375
  ],
376
376
  "description": ""