@procore/text-editor 1.0.1 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jest/ckeditorMock.js +3 -0
- package/.jest/ckeditorUtilsMock.js +14 -0
- package/.jest/setupTests.js +1 -2
- package/CHANGELOG.md +24 -0
- package/README.md +15 -0
- package/dist/DebouncedTextEditor/DebouncedTextEditor.js +1 -1
- package/dist/DebouncedTextEditor/DebouncedTextEditor.js.map +1 -1
- package/dist/DebouncedTextEditor/index.js.map +1 -1
- package/dist/TextEditor/CKTextEditor.js +12 -8
- package/dist/TextEditor/CKTextEditor.js.map +1 -1
- package/dist/TextEditor/EditorError.js.map +1 -1
- package/dist/TextEditor/Providers/FeatureFlagProvider.js.map +1 -1
- package/dist/TextEditor/StickyToolbar/index.js.map +1 -1
- package/dist/TextEditor/StickyToolbar/useStickyToolbar.js.map +1 -1
- package/dist/TextEditor/StickyToolbar/useStickyToolbar.types.js.map +1 -1
- package/dist/TextEditor/TextEditor.js.map +1 -1
- package/dist/TextEditor/TextEditor.styles.d.ts +7 -8
- package/dist/TextEditor/TextEditor.styles.js +6 -6
- package/dist/TextEditor/TextEditor.styles.js.map +1 -1
- package/dist/TextEditor/TextEditor.types.d.ts +29 -9
- package/dist/TextEditor/TextEditor.types.js.map +1 -1
- package/dist/TextEditor/TextEditorI18nProvider.js.map +1 -1
- package/dist/TextEditor/TextEditorProvider.js.map +1 -1
- package/dist/TextEditor/TextEditorProvider.types.d.ts +1 -1
- package/dist/TextEditor/TextEditorProvider.types.js.map +1 -1
- package/dist/TextEditor/TinyMCETextEditor.js +2 -1
- package/dist/TextEditor/TinyMCETextEditor.js.map +1 -1
- package/dist/TextEditor/index.d.ts +1 -1
- package/dist/TextEditor/index.js +0 -1
- package/dist/TextEditor/index.js.map +1 -1
- package/dist/TextEditor/license_key.js.map +1 -1
- package/dist/TextEditor/plugins/CutPlugin/CutCommand.js +21 -29
- package/dist/TextEditor/plugins/CutPlugin/CutCommand.js.map +1 -1
- package/dist/TextEditor/plugins/CutPlugin/CutPlugin.js +2 -2
- package/dist/TextEditor/plugins/CutPlugin/CutPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/CutPlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/IndentPaddingToMarginPlugin/IndentPaddingToMarginPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/IndentPaddingToMarginPlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/NormalizeTableWidthPlugin/NormalizeTableWidthPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/NormalizeTableWidthPlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextCommand.js +20 -28
- package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextCommand.js.map +1 -1
- package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextPlugin.js +2 -2
- package/dist/TextEditor/plugins/PasteAsTextPlugin/PasteAsTextPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/PasteAsTextPlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/PastePlugin/PasteCommand.js +54 -62
- package/dist/TextEditor/plugins/PastePlugin/PasteCommand.js.map +1 -1
- package/dist/TextEditor/plugins/PastePlugin/PastePlugin.js +2 -2
- package/dist/TextEditor/plugins/PastePlugin/PastePlugin.js.map +1 -1
- package/dist/TextEditor/plugins/PastePlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.d.ts +7 -1
- package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js +162 -71
- package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/ProcoreImageUploadPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/ProcoreImageUploadPlugin/index.js.map +1 -1
- package/dist/TextEditor/plugins/TabSpacesPlugin/TabSpacesPlugin.js.map +1 -1
- package/dist/TextEditor/plugins/TabSpacesPlugin/index.js.map +1 -1
- package/dist/TextEditor/textEditorTheming/icons.js.map +1 -1
- package/dist/TextEditor/textEditorTheming/index.js.map +1 -1
- package/dist/TextEditor/textEditorTheming/textEditorTheming.styles.d.ts +0 -1
- package/dist/TextEditor/textEditorTheming/textEditorTheming.styles.js.map +1 -1
- package/dist/TextEditor/useCKEditorCss.js.map +1 -1
- package/dist/TextEditor/useCKEditorFocusScope.js.map +1 -1
- package/dist/TextEditor/useTabAsNavigation.js.map +1 -1
- package/dist/TextEditor/utils/config.js +30 -5
- package/dist/TextEditor/utils/config.js.map +1 -1
- package/dist/TextEditor/utils/imageAttributes.js.map +1 -1
- package/dist/TextEditor/utils/imageUrls.js.map +1 -1
- package/dist/TextEditor/utils/index.js.map +1 -1
- package/dist/TextEditor/utils/locale.js +12 -1
- package/dist/TextEditor/utils/locale.js.map +1 -1
- package/dist/TextEditor/utils/richTextEditorHandlers.d.ts +5 -2
- package/dist/TextEditor/utils/richTextEditorHandlers.js +138 -99
- package/dist/TextEditor/utils/richTextEditorHandlers.js.map +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.js.map +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.styles.d.ts +0 -1
- package/dist/TextEditorOutput/TextEditorOutput.styles.js +2 -2
- package/dist/TextEditorOutput/TextEditorOutput.styles.js.map +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.types.d.ts +0 -1
- package/dist/TextEditorOutput/TextEditorOutput.types.js.map +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.utils.js +1 -1
- package/dist/TextEditorOutput/TextEditorOutput.utils.js.map +1 -1
- package/dist/TextEditorOutput/index.js.map +1 -1
- package/dist/_storyHelpers/constants.js.map +1 -1
- package/dist/_typedoc/TextEditor/TextEditor.types.json +432 -158
- package/dist/_typedoc/TextEditor/TextEditorProvider.types.json +4 -4
- package/dist/_typedoc/TextEditorOutput/TextEditorOutput.types.json +9 -9
- package/dist/_typedoc/deprecations.json +1 -1
- package/dist/_utils/propsTypedoc.d.ts +3 -3
- package/dist/_utils/propsTypedoc.js +1 -3
- package/dist/_utils/propsTypedoc.js.map +1 -1
- package/dist/ckeditor5-premium-features.d.js.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/locales/en.json +1 -0
- package/dist/stories/util.js.map +1 -1
- package/dist/utils/debounce.js +1 -1
- package/dist/utils/debounce.js.map +1 -1
- package/jestConfig.js +0 -2
- package/package.json +49 -47
- package/.jest/translationMock.js +0 -12
|
@@ -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/30db3ef62c93214770a670ede426a76e83e299ad/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 "Rich Text Editor" 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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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\">"initialization"</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">"runtime"</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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L112"
|
|
236
|
+
}
|
|
237
|
+
],
|
|
238
|
+
"description": ""
|
|
239
|
+
},
|
|
2
240
|
"TextEditorImageUploadHandlers": {
|
|
3
241
|
"name": "TextEditorImageUploadHandlers",
|
|
4
242
|
"properties": [
|
|
@@ -9,38 +247,38 @@
|
|
|
9
247
|
"typeDetail": "<span class=\"tsd-signature-type\">Pick</span><span class=\"tsd-signature-symbol\"><</span><span class=\"tsd-signature-type\">I18njs</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">"t"</span><span class=\"tsd-signature-symbol\">></span>",
|
|
10
248
|
"description": "",
|
|
11
249
|
"descriptionHtml": "",
|
|
12
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
13
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
250
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
251
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
|
|
14
252
|
},
|
|
15
253
|
{
|
|
16
254
|
"name": "onError",
|
|
17
255
|
"required": false,
|
|
18
256
|
"type": "Function",
|
|
19
|
-
"typeDetail": "
|
|
257
|
+
"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
258
|
"description": "",
|
|
21
259
|
"descriptionHtml": "",
|
|
22
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
23
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
260
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
261
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L35"
|
|
24
262
|
},
|
|
25
263
|
{
|
|
26
264
|
"name": "onWarning",
|
|
27
265
|
"required": false,
|
|
28
266
|
"type": "Function",
|
|
29
|
-
"typeDetail": "
|
|
267
|
+
"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
268
|
"description": "",
|
|
31
269
|
"descriptionHtml": "",
|
|
32
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
33
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
270
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
271
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L36"
|
|
34
272
|
},
|
|
35
273
|
{
|
|
36
274
|
"name": "upload",
|
|
37
275
|
"required": true,
|
|
38
276
|
"type": "Function",
|
|
39
|
-
"typeDetail": "
|
|
277
|
+
"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\"><</span><span class=\"tsd-signature-type\">TextEditorImageUploadResult</span><span class=\"tsd-signature-symbol\">></span>",
|
|
40
278
|
"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
|
|
42
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
43
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
280
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
281
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L29"
|
|
44
282
|
}
|
|
45
283
|
],
|
|
46
284
|
"description": ""
|
|
@@ -54,9 +292,9 @@
|
|
|
54
292
|
"type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
55
293
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
56
294
|
"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
|
|
58
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
59
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
296
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
297
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
|
|
60
298
|
},
|
|
61
299
|
{
|
|
62
300
|
"name": "projectId",
|
|
@@ -65,8 +303,8 @@
|
|
|
65
303
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
66
304
|
"description": "",
|
|
67
305
|
"descriptionHtml": "",
|
|
68
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
69
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
306
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
307
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
|
|
70
308
|
},
|
|
71
309
|
{
|
|
72
310
|
"name": "toolName",
|
|
@@ -74,9 +312,9 @@
|
|
|
74
312
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
75
313
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
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
|
-
"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
|
|
78
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
79
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
316
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
317
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
|
|
80
318
|
}
|
|
81
319
|
],
|
|
82
320
|
"description": ""
|
|
@@ -91,8 +329,8 @@
|
|
|
91
329
|
"typeDetail": "<span class=\"tsd-signature-type\">number</span>",
|
|
92
330
|
"description": "",
|
|
93
331
|
"descriptionHtml": "",
|
|
94
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
95
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
332
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
333
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
|
|
96
334
|
},
|
|
97
335
|
{
|
|
98
336
|
"name": "prostoreFileId",
|
|
@@ -100,19 +338,19 @@
|
|
|
100
338
|
"type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
101
339
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
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
|
-
"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
|
|
104
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
105
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
342
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
343
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L18"
|
|
106
344
|
},
|
|
107
345
|
{
|
|
108
346
|
"name": "urls",
|
|
109
347
|
"required": true,
|
|
110
|
-
"type": "<span class=\"tsd-signature-symbol\">{
|
|
111
|
-
"typeDetail": "<span class=\"tsd-signature-symbol\">{
|
|
348
|
+
"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>",
|
|
349
|
+
"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
350
|
"description": "",
|
|
113
351
|
"descriptionHtml": "",
|
|
114
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
115
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
352
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
353
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L7"
|
|
116
354
|
},
|
|
117
355
|
{
|
|
118
356
|
"name": "width",
|
|
@@ -121,12 +359,43 @@
|
|
|
121
359
|
"typeDetail": "<span class=\"tsd-signature-type\">number</span>",
|
|
122
360
|
"description": "",
|
|
123
361
|
"descriptionHtml": "",
|
|
124
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
125
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
362
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
363
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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": [
|
|
@@ -136,9 +405,9 @@
|
|
|
136
405
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
137
406
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
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
|
-
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible description for the editor
|
|
140
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
141
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
409
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
410
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L153"
|
|
142
411
|
},
|
|
143
412
|
{
|
|
144
413
|
"name": "aria-label",
|
|
@@ -146,9 +415,9 @@
|
|
|
146
415
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
147
416
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
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
|
-
"descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible label for the editor
|
|
150
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
151
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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 "Rich Text Editor" message.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p></dd></dl></div>",
|
|
419
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
420
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L144"
|
|
152
421
|
},
|
|
153
422
|
{
|
|
154
423
|
"name": "companyId",
|
|
@@ -156,9 +425,9 @@
|
|
|
156
425
|
"type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
157
426
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
158
427
|
"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
|
|
160
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
161
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
429
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
430
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L46"
|
|
162
431
|
},
|
|
163
432
|
{
|
|
164
433
|
"name": "disabled",
|
|
@@ -166,9 +435,9 @@
|
|
|
166
435
|
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
167
436
|
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
168
437
|
"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
|
|
170
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
171
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
439
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
440
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L119"
|
|
172
441
|
},
|
|
173
442
|
{
|
|
174
443
|
"name": "enforceCKEditor",
|
|
@@ -176,9 +445,9 @@
|
|
|
176
445
|
"type": "<span class=\"tsd-signature-type\">true</span>",
|
|
177
446
|
"typeDetail": "<span class=\"tsd-signature-type\">true</span>",
|
|
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
|
-
"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
|
|
180
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
181
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
449
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
450
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L251"
|
|
182
451
|
},
|
|
183
452
|
{
|
|
184
453
|
"name": "error",
|
|
@@ -186,9 +455,9 @@
|
|
|
186
455
|
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
187
456
|
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
188
457
|
"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
|
|
190
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
191
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
459
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
460
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L126"
|
|
192
461
|
},
|
|
193
462
|
{
|
|
194
463
|
"name": "id",
|
|
@@ -196,9 +465,9 @@
|
|
|
196
465
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
197
466
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
198
467
|
"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
|
|
200
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
201
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
469
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
470
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L95"
|
|
202
471
|
},
|
|
203
472
|
{
|
|
204
473
|
"name": "init",
|
|
@@ -206,9 +475,9 @@
|
|
|
206
475
|
"type": "<span class=\"tsd-signature-type\">InitOptions</span>",
|
|
207
476
|
"typeDetail": "<span class=\"tsd-signature-type\">InitOptions</span>",
|
|
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
|
-
"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
|
|
210
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
211
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
479
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
480
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L242"
|
|
212
481
|
},
|
|
213
482
|
{
|
|
214
483
|
"name": "initialValue",
|
|
@@ -216,11 +485,11 @@
|
|
|
216
485
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
217
486
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
218
487
|
"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>
|
|
488
|
+
"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
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
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
223
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
491
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
492
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L105"
|
|
224
493
|
},
|
|
225
494
|
{
|
|
226
495
|
"name": "locale",
|
|
@@ -228,156 +497,161 @@
|
|
|
228
497
|
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
229
498
|
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
230
499
|
"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
|
|
232
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
233
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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/51bb21d314/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/51bb21d314/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/51bb21d314/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/51bb21d314/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/51bb21d314/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/51bb21d314/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
|
|
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>",
|
|
501
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
502
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L160"
|
|
294
503
|
},
|
|
295
504
|
{
|
|
296
505
|
"name": "onAfterDestroy",
|
|
297
506
|
"required": false,
|
|
298
507
|
"type": "Function",
|
|
299
|
-
"typeDetail": "
|
|
508
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
|
|
300
509
|
"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
|
|
302
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
303
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
511
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
512
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L210"
|
|
304
513
|
},
|
|
305
514
|
{
|
|
306
515
|
"name": "onBlur",
|
|
307
516
|
"required": false,
|
|
308
517
|
"type": "Function",
|
|
309
|
-
"typeDetail": "
|
|
518
|
+
"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
519
|
"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
|
|
312
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
313
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
521
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
522
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L183"
|
|
314
523
|
},
|
|
315
524
|
{
|
|
316
525
|
"name": "onChange",
|
|
317
526
|
"required": false,
|
|
318
527
|
"type": "Function",
|
|
319
|
-
"typeDetail": "
|
|
528
|
+
"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
529
|
"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
|
|
322
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
323
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
531
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
532
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L169"
|
|
324
533
|
},
|
|
325
534
|
{
|
|
326
535
|
"name": "onDirty",
|
|
327
536
|
"required": false,
|
|
328
537
|
"type": "Function",
|
|
329
|
-
"typeDetail": "
|
|
538
|
+
"typeDetail": "<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">): </span><span class=\"tsd-signature-type\">void</span>",
|
|
330
539
|
"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
|
|
332
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
333
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
541
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
542
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L217"
|
|
334
543
|
},
|
|
335
544
|
{
|
|
336
545
|
"name": "onError",
|
|
337
546
|
"required": false,
|
|
338
547
|
"type": "Function",
|
|
339
|
-
"typeDetail": "
|
|
548
|
+
"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\">"initialization"</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">"runtime"</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
549
|
"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
|
|
342
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
343
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
551
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
552
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L190"
|
|
344
553
|
},
|
|
345
554
|
{
|
|
346
555
|
"name": "onFocus",
|
|
347
556
|
"required": false,
|
|
348
557
|
"type": "Function",
|
|
349
|
-
"typeDetail": "
|
|
558
|
+
"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
559
|
"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
|
|
352
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
353
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
561
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
562
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L176"
|
|
354
563
|
},
|
|
355
564
|
{
|
|
356
565
|
"name": "onInit",
|
|
357
566
|
"required": false,
|
|
358
567
|
"type": "Function",
|
|
359
|
-
"typeDetail": "
|
|
568
|
+
"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
569
|
"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
|
|
362
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
363
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
571
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
572
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L203"
|
|
364
573
|
},
|
|
365
574
|
{
|
|
366
575
|
"name": "onKeyDown",
|
|
367
576
|
"required": false,
|
|
368
577
|
"type": "Function",
|
|
369
|
-
"typeDetail": "
|
|
578
|
+
"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
579
|
"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
|
|
372
|
-
"sourceFile": "TextEditor/TextEditor.types.ts",
|
|
373
|
-
"sourceUrl": "https://github.com/procore/core/blob/
|
|
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>",
|
|
581
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
582
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L226"
|
|
583
|
+
},
|
|
584
|
+
{
|
|
585
|
+
"name": "placeholder",
|
|
586
|
+
"required": false,
|
|
587
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
588
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
589
|
+
"description": "Placeholder text shown when the editor is empty",
|
|
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>",
|
|
591
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
592
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L233"
|
|
593
|
+
},
|
|
594
|
+
{
|
|
595
|
+
"name": "projectId",
|
|
596
|
+
"required": false,
|
|
597
|
+
"type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
598
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">number</span>",
|
|
599
|
+
"description": "",
|
|
600
|
+
"descriptionHtml": "",
|
|
601
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
602
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L47"
|
|
603
|
+
},
|
|
604
|
+
{
|
|
605
|
+
"name": "readonly",
|
|
606
|
+
"required": false,
|
|
607
|
+
"type": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
608
|
+
"typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
|
|
609
|
+
"description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
|
|
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>",
|
|
611
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
612
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L134"
|
|
613
|
+
},
|
|
614
|
+
{
|
|
615
|
+
"name": "toolName",
|
|
616
|
+
"required": false,
|
|
617
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
618
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
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.",
|
|
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>",
|
|
621
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
622
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/packages/text-editor/src/TextEditor/TextEditor.types.ts#L56"
|
|
623
|
+
},
|
|
624
|
+
{
|
|
625
|
+
"name": "value",
|
|
626
|
+
"required": false,
|
|
627
|
+
"type": "<span class=\"tsd-signature-type\">string</span>",
|
|
628
|
+
"typeDetail": "<span class=\"tsd-signature-type\">string</span>",
|
|
629
|
+
"description": "The current value of the editor",
|
|
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>",
|
|
631
|
+
"sourceFile": "packages/text-editor/src/TextEditor/TextEditor.types.ts",
|
|
632
|
+
"sourceUrl": "https://github.com/procore/core/blob/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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/30db3ef62c93214770a670ede426a76e83e299ad/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
|
}
|