@procore/text-editor 1.1.0 → 1.2.1

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 (50) hide show
  1. package/.jest/ckeditorMock.js +1 -0
  2. package/.jest/setupTests.js +1 -2
  3. package/CHANGELOG.md +17 -0
  4. package/README.md +15 -0
  5. package/dist/TextEditor/CKTextEditor.js +7 -3
  6. package/dist/TextEditor/CKTextEditor.js.map +1 -1
  7. package/dist/TextEditor/TextEditor.styles.d.ts +15 -7
  8. package/dist/TextEditor/TextEditor.styles.js +6 -6
  9. package/dist/TextEditor/TextEditor.styles.js.map +1 -1
  10. package/dist/TextEditor/TextEditor.types.d.ts +28 -8
  11. package/dist/TextEditor/TextEditor.types.js.map +1 -1
  12. package/dist/TextEditor/TinyMCETextEditor.js +2 -1
  13. package/dist/TextEditor/TinyMCETextEditor.js.map +1 -1
  14. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.d.ts +6 -0
  15. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js +114 -14
  16. package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js.map +1 -1
  17. package/dist/TextEditor/utils/config.js +3 -3
  18. package/dist/TextEditor/utils/config.js.map +1 -1
  19. package/dist/TextEditor/utils/richTextEditorHandlers.d.ts +4 -1
  20. package/dist/TextEditor/utils/richTextEditorHandlers.js +79 -21
  21. package/dist/TextEditor/utils/richTextEditorHandlers.js.map +1 -1
  22. package/dist/TextEditorOutput/TextEditorOutput.styles.d.ts +3 -1
  23. package/dist/TextEditorOutput/TextEditorOutput.styles.js +2 -2
  24. package/dist/TextEditorOutput/TextEditorOutput.styles.js.map +1 -1
  25. package/dist/TextEditorOutput/TextEditorOutput.utils.js +7 -3
  26. package/dist/TextEditorOutput/TextEditorOutput.utils.js.map +1 -1
  27. package/dist/_typedoc/TextEditor/TextEditor.types.json +323 -49
  28. package/dist/_typedoc/TextEditor/TextEditorProvider.types.json +2 -2
  29. package/dist/_typedoc/TextEditorOutput/TextEditorOutput.types.json +3 -3
  30. package/dist/_typedoc/deprecations.json +1 -1
  31. package/dist/locales/de-DE.json +1 -0
  32. package/dist/locales/en-AU.json +1 -0
  33. package/dist/locales/en-CA.json +1 -0
  34. package/dist/locales/en-GB.json +1 -0
  35. package/dist/locales/en.json +1 -0
  36. package/dist/locales/es-ES.json +1 -0
  37. package/dist/locales/es.json +1 -0
  38. package/dist/locales/fr-CA.json +1 -0
  39. package/dist/locales/fr-FR.json +1 -0
  40. package/dist/locales/is-IS.json +1 -0
  41. package/dist/locales/it-IT.json +1 -0
  42. package/dist/locales/ja-JP.json +1 -0
  43. package/dist/locales/nb-NO.json +1 -0
  44. package/dist/locales/pl-PL.json +1 -0
  45. package/dist/locales/pt-BR.json +1 -0
  46. package/dist/locales/pt-PT.json +1 -0
  47. package/dist/locales/th-TH.json +1 -0
  48. package/dist/locales/zh-SG.json +1 -0
  49. package/dist/locales/zh-TW.json +1 -0
  50. package/package.json +10 -10
@@ -1,4 +1,242 @@
1
1
  {
2
+ "TextEditorBaseProps": {
3
+ "name": "TextEditorBaseProps",
4
+ "properties": [
5
+ {
6
+ "name": "aria-description",
7
+ "required": false,
8
+ "type": "<span class=\"tsd-signature-type\">string</span>",
9
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
10
+ "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.",
11
+ "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>",
12
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
13
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L153"
14
+ },
15
+ {
16
+ "name": "aria-label",
17
+ "required": false,
18
+ "type": "<span class=\"tsd-signature-type\">string</span>",
19
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
20
+ "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.",
21
+ "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>",
22
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
23
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L144"
24
+ },
25
+ {
26
+ "name": "companyId",
27
+ "required": false,
28
+ "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
29
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
30
+ "description": "Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.",
31
+ "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>",
32
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
33
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
34
+ },
35
+ {
36
+ "name": "disabled",
37
+ "required": false,
38
+ "type": "<span class=\"tsd-signature-type\">boolean</span>",
39
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
40
+ "description": "Indicates if the editor is disabled",
41
+ "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>",
42
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
43
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L119"
44
+ },
45
+ {
46
+ "name": "enforceCKEditor",
47
+ "required": false,
48
+ "type": "<span class=\"tsd-signature-type\">true</span>",
49
+ "typeDetail": "<span class=\"tsd-signature-type\">true</span>",
50
+ "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.",
51
+ "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>",
52
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
53
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L251"
54
+ },
55
+ {
56
+ "name": "error",
57
+ "required": false,
58
+ "type": "<span class=\"tsd-signature-type\">boolean</span>",
59
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
60
+ "description": "Indicates if the editor is in an error state",
61
+ "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>",
62
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
63
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L126"
64
+ },
65
+ {
66
+ "name": "id",
67
+ "required": false,
68
+ "type": "<span class=\"tsd-signature-type\">string</span>",
69
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
70
+ "description": "Unique identifier for the editor",
71
+ "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>",
72
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
73
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L95"
74
+ },
75
+ {
76
+ "name": "init",
77
+ "required": false,
78
+ "type": "<span class=\"tsd-signature-type\">InitOptions</span>",
79
+ "typeDetail": "<span class=\"tsd-signature-type\">InitOptions</span>",
80
+ "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.",
81
+ "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>",
82
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
83
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L242"
84
+ },
85
+ {
86
+ "name": "initialValue",
87
+ "required": false,
88
+ "type": "<span class=\"tsd-signature-type\">string</span>",
89
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
90
+ "description": "Initial value of the editor",
91
+ "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>",
92
+ "deprecated": "`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead",
93
+ "deprecatedSince": "0.0.1",
94
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
95
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L105"
96
+ },
97
+ {
98
+ "name": "locale",
99
+ "required": false,
100
+ "type": "<span class=\"tsd-signature-type\">string</span>",
101
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
102
+ "description": "Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.",
103
+ "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>",
104
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
105
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L160"
106
+ },
107
+ {
108
+ "name": "onAfterDestroy",
109
+ "required": false,
110
+ "type": "Function",
111
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
112
+ "description": "Callback fired after the editor instance is destroyed",
113
+ "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>",
114
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
115
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L210"
116
+ },
117
+ {
118
+ "name": "onBlur",
119
+ "required": false,
120
+ "type": "Function",
121
+ "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>",
122
+ "description": "Callback fired when the editor loses focus",
123
+ "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>",
124
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
125
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L183"
126
+ },
127
+ {
128
+ "name": "onChange",
129
+ "required": false,
130
+ "type": "Function",
131
+ "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>",
132
+ "description": "Callback fired when the editor content changes",
133
+ "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>",
134
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
135
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L169"
136
+ },
137
+ {
138
+ "name": "onDirty",
139
+ "required": false,
140
+ "type": "Function",
141
+ "typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
142
+ "description": "Callback fired when the editor becomes dirty (content differs from initial value)",
143
+ "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>",
144
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
145
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L217"
146
+ },
147
+ {
148
+ "name": "onError",
149
+ "required": false,
150
+ "type": "Function",
151
+ "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>",
152
+ "description": "Callback fired when an error occurs in the editor",
153
+ "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>",
154
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
155
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L190"
156
+ },
157
+ {
158
+ "name": "onFocus",
159
+ "required": false,
160
+ "type": "Function",
161
+ "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>",
162
+ "description": "Callback fired when the editor gains focus",
163
+ "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>",
164
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
165
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L176"
166
+ },
167
+ {
168
+ "name": "onInit",
169
+ "required": false,
170
+ "type": "Function",
171
+ "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>",
172
+ "description": "Callback fired when the editor is ready",
173
+ "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>",
174
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
175
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L203"
176
+ },
177
+ {
178
+ "name": "onKeyDown",
179
+ "required": false,
180
+ "type": "Function",
181
+ "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>",
182
+ "description": "Callback fired when a key is pressed in the editor",
183
+ "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>",
184
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
185
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L226"
186
+ },
187
+ {
188
+ "name": "placeholder",
189
+ "required": false,
190
+ "type": "<span class=\"tsd-signature-type\">string</span>",
191
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
192
+ "description": "Placeholder text shown when the editor is empty",
193
+ "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>",
194
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
195
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L233"
196
+ },
197
+ {
198
+ "name": "projectId",
199
+ "required": false,
200
+ "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
201
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
202
+ "description": "",
203
+ "descriptionHtml": "",
204
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
205
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
206
+ },
207
+ {
208
+ "name": "readonly",
209
+ "required": false,
210
+ "type": "<span class=\"tsd-signature-type\">boolean</span>",
211
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
212
+ "description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
213
+ "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>",
214
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
215
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L134"
216
+ },
217
+ {
218
+ "name": "toolName",
219
+ "required": false,
220
+ "type": "<span class=\"tsd-signature-type\">string</span>",
221
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
222
+ "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.",
223
+ "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>",
224
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
225
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
226
+ },
227
+ {
228
+ "name": "value",
229
+ "required": false,
230
+ "type": "<span class=\"tsd-signature-type\">string</span>",
231
+ "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
232
+ "description": "The current value of the editor",
233
+ "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>",
234
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
235
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L112"
236
+ }
237
+ ],
238
+ "description": ""
239
+ },
2
240
  "TextEditorImageUploadHandlers": {
3
241
  "name": "TextEditorImageUploadHandlers",
4
242
  "properties": [
@@ -10,7 +248,7 @@
10
248
  "description": "",
11
249
  "descriptionHtml": "",
12
250
  "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"
251
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
14
252
  },
15
253
  {
16
254
  "name": "onError",
@@ -20,7 +258,7 @@
20
258
  "description": "",
21
259
  "descriptionHtml": "",
22
260
  "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"
261
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L35"
24
262
  },
25
263
  {
26
264
  "name": "onWarning",
@@ -30,7 +268,7 @@
30
268
  "description": "",
31
269
  "descriptionHtml": "",
32
270
  "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"
271
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L36"
34
272
  },
35
273
  {
36
274
  "name": "upload",
@@ -40,7 +278,7 @@
40
278
  "description": "Uploads the selected image and returns durable backend-approved image URLs.",
41
279
  "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
280
  "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"
281
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L29"
44
282
  }
45
283
  ],
46
284
  "description": ""
@@ -56,7 +294,7 @@
56
294
  "description": "Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.",
57
295
  "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
296
  "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"
297
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
60
298
  },
61
299
  {
62
300
  "name": "projectId",
@@ -66,7 +304,7 @@
66
304
  "description": "",
67
305
  "descriptionHtml": "",
68
306
  "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"
307
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
70
308
  },
71
309
  {
72
310
  "name": "toolName",
@@ -76,7 +314,7 @@
76
314
  "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
315
  "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
316
  "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"
317
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
80
318
  }
81
319
  ],
82
320
  "description": ""
@@ -92,7 +330,7 @@
92
330
  "description": "",
93
331
  "descriptionHtml": "",
94
332
  "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"
333
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
96
334
  },
97
335
  {
98
336
  "name": "prostoreFileId",
@@ -102,7 +340,7 @@
102
340
  "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
341
  "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
342
  "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"
343
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L18"
106
344
  },
107
345
  {
108
346
  "name": "urls",
@@ -112,7 +350,7 @@
112
350
  "description": "",
113
351
  "descriptionHtml": "",
114
352
  "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"
353
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L7"
116
354
  },
117
355
  {
118
356
  "name": "width",
@@ -122,11 +360,42 @@
122
360
  "description": "",
123
361
  "descriptionHtml": "",
124
362
  "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"
363
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L19"
126
364
  }
127
365
  ],
128
366
  "description": ""
129
367
  },
368
+ "KeyDownListener": {
369
+ "name": "KeyDownListener",
370
+ "properties": [],
371
+ "description": ""
372
+ },
373
+ "TextEditorHeightProps": {
374
+ "name": "TextEditorHeightProps",
375
+ "properties": [
376
+ {
377
+ "name": "extendable",
378
+ "required": false,
379
+ "type": "<span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
380
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
381
+ "description": "When true, the `rows` height acts as a minimum instead of a fixed\nsize: the editor starts at that height and grows with content beyond\nit. When false or omitted, the `rows` height is fixed and overflowing\ncontent scrolls.",
382
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>When true, the <code>rows</code> height acts as a minimum instead of a fixed\nsize: the editor starts at that height and grows with content beyond\nit. When false or omitted, the <code>rows</code> height is fixed and overflowing\ncontent scrolls.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.1.0</p></dd></dl></div>",
383
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
384
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
385
+ },
386
+ {
387
+ "name": "rows",
388
+ "required": false,
389
+ "type": "<span class=\"tsd-signature-type\">number</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
390
+ "typeDetail": "<span class=\"tsd-signature-type\">number</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
391
+ "description": "Number of rows to control the editor height. When set, the editor\nheight is fixed. When omitted, the editor grows with content.",
392
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Number of rows to control the editor height. When set, the editor\nheight is 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>",
393
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
394
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L72"
395
+ }
396
+ ],
397
+ "description": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Height behavior. <code>extendable</code> is only accepted together with <code>rows</code>:\nwithout <code>rows</code> the editor always auto-grows, so <code>extendable</code> would be\nmeaningless and is rejected at the type level.</p>\n</div></div>"
398
+ },
130
399
  "TextEditorProps": {
131
400
  "name": "TextEditorProps",
132
401
  "properties": [
@@ -138,7 +407,7 @@
138
407
  "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
408
  "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
409
  "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"
410
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L153"
142
411
  },
143
412
  {
144
413
  "name": "aria-label",
@@ -148,7 +417,7 @@
148
417
  "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
418
  "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
419
  "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"
420
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L144"
152
421
  },
153
422
  {
154
423
  "name": "companyId",
@@ -158,7 +427,7 @@
158
427
  "description": "Required to enable image uploads. When omitted, the editor renders without\nthe Procore image-upload plugin.",
159
428
  "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
429
  "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"
430
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
162
431
  },
163
432
  {
164
433
  "name": "disabled",
@@ -168,7 +437,7 @@
168
437
  "description": "Indicates if the editor is disabled",
169
438
  "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
439
  "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"
440
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L119"
172
441
  },
173
442
  {
174
443
  "name": "enforceCKEditor",
@@ -178,7 +447,7 @@
178
447
  "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
448
  "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
449
  "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"
450
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L251"
182
451
  },
183
452
  {
184
453
  "name": "error",
@@ -188,7 +457,7 @@
188
457
  "description": "Indicates if the editor is in an error state",
189
458
  "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
459
  "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"
460
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L126"
192
461
  },
193
462
  {
194
463
  "name": "id",
@@ -198,7 +467,7 @@
198
467
  "description": "Unique identifier for the editor",
199
468
  "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
469
  "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"
470
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L95"
202
471
  },
203
472
  {
204
473
  "name": "init",
@@ -208,7 +477,7 @@
208
477
  "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
478
  "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
479
  "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"
480
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L242"
212
481
  },
213
482
  {
214
483
  "name": "initialValue",
@@ -220,7 +489,7 @@
220
489
  "deprecated": "`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead",
221
490
  "deprecatedSince": "0.0.1",
222
491
  "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"
492
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L105"
224
493
  },
225
494
  {
226
495
  "name": "locale",
@@ -230,7 +499,7 @@
230
499
  "description": "Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.",
231
500
  "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
501
  "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"
502
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L160"
234
503
  },
235
504
  {
236
505
  "name": "onAfterDestroy",
@@ -240,7 +509,7 @@
240
509
  "description": "Callback fired after the editor instance is destroyed",
241
510
  "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
511
  "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"
512
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L210"
244
513
  },
245
514
  {
246
515
  "name": "onBlur",
@@ -250,7 +519,7 @@
250
519
  "description": "Callback fired when the editor loses focus",
251
520
  "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
521
  "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"
522
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L183"
254
523
  },
255
524
  {
256
525
  "name": "onChange",
@@ -260,7 +529,7 @@
260
529
  "description": "Callback fired when the editor content changes",
261
530
  "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
531
  "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"
532
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L169"
264
533
  },
265
534
  {
266
535
  "name": "onDirty",
@@ -270,7 +539,7 @@
270
539
  "description": "Callback fired when the editor becomes dirty (content differs from initial value)",
271
540
  "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
541
  "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"
542
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L217"
274
543
  },
275
544
  {
276
545
  "name": "onError",
@@ -280,7 +549,7 @@
280
549
  "description": "Callback fired when an error occurs in the editor",
281
550
  "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
551
  "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"
552
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L190"
284
553
  },
285
554
  {
286
555
  "name": "onFocus",
@@ -290,7 +559,7 @@
290
559
  "description": "Callback fired when the editor gains focus",
291
560
  "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
561
  "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"
562
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L176"
294
563
  },
295
564
  {
296
565
  "name": "onInit",
@@ -300,7 +569,7 @@
300
569
  "description": "Callback fired when the editor is ready",
301
570
  "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
571
  "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"
572
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L203"
304
573
  },
305
574
  {
306
575
  "name": "onKeyDown",
@@ -310,7 +579,7 @@
310
579
  "description": "Callback fired when a key is pressed in the editor",
311
580
  "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
581
  "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"
582
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L226"
314
583
  },
315
584
  {
316
585
  "name": "placeholder",
@@ -320,7 +589,7 @@
320
589
  "description": "Placeholder text shown when the editor is empty",
321
590
  "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
591
  "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"
592
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L233"
324
593
  },
325
594
  {
326
595
  "name": "projectId",
@@ -330,7 +599,7 @@
330
599
  "description": "",
331
600
  "descriptionHtml": "",
332
601
  "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"
602
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
334
603
  },
335
604
  {
336
605
  "name": "readonly",
@@ -340,17 +609,7 @@
340
609
  "description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
341
610
  "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
611
  "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"
612
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L134"
354
613
  },
355
614
  {
356
615
  "name": "toolName",
@@ -360,7 +619,7 @@
360
619
  "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
620
  "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
621
  "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"
622
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
364
623
  },
365
624
  {
366
625
  "name": "value",
@@ -370,14 +629,29 @@
370
629
  "description": "The current value of the editor",
371
630
  "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
631
  "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"
632
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L112"
633
+ },
634
+ {
635
+ "name": "extendable",
636
+ "required": false,
637
+ "type": "<span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
638
+ "typeDetail": "<span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
639
+ "description": "When true, the `rows` height acts as a minimum instead of a fixed\nsize: the editor starts at that height and grows with content beyond\nit. When false or omitted, the `rows` height is fixed and overflowing\ncontent scrolls.",
640
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>When true, the <code>rows</code> height acts as a minimum instead of a fixed\nsize: the editor starts at that height and grows with content beyond\nit. When false or omitted, the <code>rows</code> height is fixed and overflowing\ncontent scrolls.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>1.1.0</p></dd></dl></div>",
641
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
642
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
643
+ },
644
+ {
645
+ "name": "rows",
646
+ "required": false,
647
+ "type": "<span class=\"tsd-signature-type\">number</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
648
+ "typeDetail": "<span class=\"tsd-signature-type\">number</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">never</span>",
649
+ "description": "Number of rows to control the editor height. When set, the editor\nheight is fixed. When omitted, the editor grows with content.",
650
+ "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Number of rows to control the editor height. When set, the editor\nheight is 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>",
651
+ "sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
652
+ "sourceUrl": "https://github.com/procore/core/blob/74a2a6e9ef458b346a066a8f63dbc2f5ee1110ea/packages/text-editor/src/TextEditor/TextEditor.types.ts#L72"
374
653
  }
375
654
  ],
376
655
  "description": ""
377
- },
378
- "KeyDownListener": {
379
- "name": "KeyDownListener",
380
- "properties": [],
381
- "description": ""
382
656
  }
383
657
  }