@procore/text-editor 0.0.3 → 0.2.0

package/dist/_typedoc/TextEditor/TextEditor.types.json

@@ -2,15 +2,35 @@
   "TextEditorProps": {
     "name": "TextEditorProps",
     "properties": [
+      {
+        "name": "aria-description",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible description for the editor&#39;s editable area.\nThis text provides additional context to screen reader users. It will be\nannounced after the label when the user focuses the editor.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p>\n</dd></dl></div>",
+        "sourceFile": "TextEditor/TextEditor.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L68"
+      },
+      {
+        "name": "aria-label",
+        "required": false,
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
+        "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.",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Accessible label for the editor&#39;s editable area. This text will be\nannounced by screen readers when the user focuses the editor. It should\nmatch or include the visible label associated with this editor field.\nIf not provided, screen readers will announce a generic &quot;Rich Text Editor&quot; message.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.1.0</p>\n</dd></dl></div>",
+        "sourceFile": "TextEditor/TextEditor.types.ts",
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L59"
+      },
       {
         "name": "disabled",
         "required": false,
         "type": "<span class=\"tsd-signature-type\">boolean</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
         "description": "Indicates if the editor is disabled",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is disabled</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L34"
       },
       {
         "name": "error",
@@ -18,9 +38,9 @@
         "type": "<span class=\"tsd-signature-type\">boolean</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
         "description": "Indicates if the editor is in an error state",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Indicates if the editor is in an error state</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L41"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L41"
       },
       {
         "name": "id",
@@ -28,9 +48,9 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "Unique identifier for the editor",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Unique identifier for the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L10"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L10"
       },
       {
         "name": "initialValue",
@@ -38,31 +58,31 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "Initial value of the editor",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Initial value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p><code>initialValue</code> has been deprecated and will be removed in a future version.\nPlease use the <code>value</code> prop instead</p>\n</dd><dt>deprecatedsince</dt><dd><p>10.20.0</p>\n</dd><dt>since</dt><dd><p>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Initial value of the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>deprecated</dt><dd><p><code>initialValue</code> has been deprecated and will be removed in a future version.\nPlease use the <code>value</code> prop instead</p>\n</dd><dt>deprecatedsince</dt><dd><p>0.0.1</p>\n</dd><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "deprecated": "`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead",
-        "deprecatedSince": "10.20.0",
+        "deprecatedSince": "0.0.1",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L20"
       },
       {
         "name": "locale",
         "required": false,
-        "type": "<span class=\"tsd-signature-type\">Locale</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">Locale</span>",
+        "type": "<span class=\"tsd-signature-type\">string</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Locale which will be used for localization. Can be passed directly or\nset by wrapping components in I18n provider.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L48"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L75"
       },
       {
-        "name": "plugins",
+        "name": "readonly",
         "required": false,
-        "type": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">[]</span>",
-        "typeDetail": "<span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">[]</span>",
-        "description": "Array of plugin names to add to the editor in addition to the defaults.\nThis provides backward compatibility with the deprecated TinyMCE version of the editor.\nSupports plugin names like 'link', 'image', 'table', etc.",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Array of plugin names to add to the editor in addition to the defaults.\nThis provides backward compatibility with the deprecated TinyMCE version of the editor.\nSupports plugin names like &#39;link&#39;, &#39;image&#39;, &#39;table&#39;, etc.</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.26.0</p>\n</dd></dl></div>",
+        "type": "<span class=\"tsd-signature-type\">boolean</span>",
+        "typeDetail": "<span class=\"tsd-signature-type\">boolean</span>",
+        "description": "Indicates if the editor is in readonly mode.\nWhen true, renders the content using TextEditorOutput instead of the editable editor.",
+        "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>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L57"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L49"
       },
       {
         "name": "value",
@@ -70,19 +90,9 @@
         "type": "<span class=\"tsd-signature-type\">string</span>",
         "typeDetail": "<span class=\"tsd-signature-type\">string</span>",
         "description": "The current value of the editor",
-        "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>10.19.0</p>\n</dd></dl></div>",
-        "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L27"
-      },
-      {
-        "name": "config",
-        "required": false,
-        "type": "Function",
-        "typeDetail": "config<span class=\"tsd-signature-symbol\">(</span>defaultConfig<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EditorConfig</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EditorConfig</span>",
-        "description": "Configuration function for customizing the editor",
-        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Configuration function for customizing the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>12.26.0</p>\n</dd></dl></div>",
+        "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>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L66"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L27"
       },
       {
         "name": "onAfterDestroy",
@@ -90,9 +100,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>After<wbr/>Destroy<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired after the editor instance is destroyed",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired after the editor instance is destroyed</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L116"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L125"
       },
       {
         "name": "onBlur",
@@ -100,9 +110,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Blur<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EventInfo</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">unknown</span><span class=\"tsd-signature-symbol\">&gt;</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when the editor loses focus",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor loses focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L89"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L98"
       },
       {
         "name": "onChange",
@@ -110,9 +120,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Change<span class=\"tsd-signature-symbol\">(</span>value<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">string</span>, isDirty<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when the editor content changes",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor content changes</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L75"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L84"
       },
       {
         "name": "onDirty",
@@ -120,9 +130,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Dirty<span class=\"tsd-signature-symbol\">(</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when the editor becomes dirty (content differs from initial value)",
-        "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>12.26.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor becomes dirty (content differs from initial value)</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L123"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L132"
       },
       {
         "name": "onError",
@@ -130,9 +140,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Error<span class=\"tsd-signature-symbol\">(</span>error<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">Error</span>, details<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-symbol\">{ </span>phase<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">&quot;initialization&quot;</span><span class=\"tsd-signature-symbol\"> | </span><span class=\"tsd-signature-type\">&quot;runtime&quot;</span><span class=\"tsd-signature-symbol\">; </span>willEditorRestart<span class=\"tsd-signature-symbol\">?: </span><span class=\"tsd-signature-type\">boolean</span><span class=\"tsd-signature-symbol\"> }</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when an error occurs in the editor",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when an error occurs in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L96"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L105"
       },
       {
         "name": "onFocus",
@@ -140,9 +150,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Focus<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">EventInfo</span><span class=\"tsd-signature-symbol\">&lt;</span><span class=\"tsd-signature-type\">string</span><span class=\"tsd-signature-symbol\">, </span><span class=\"tsd-signature-type\">unknown</span><span class=\"tsd-signature-symbol\">&gt;</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when the editor gains focus",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor gains focus</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L82"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L91"
       },
       {
         "name": "onInit",
@@ -150,9 +160,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Init<span class=\"tsd-signature-symbol\">(</span>editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when the editor is ready",
-        "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>10.19.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when the editor is ready</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L109"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L118"
       },
       {
         "name": "onKeyDown",
@@ -160,9 +170,9 @@
         "type": "Function",
         "typeDetail": "on<wbr/>Key<wbr/>Down<span class=\"tsd-signature-symbol\">(</span>event<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">KeyboardEvent</span>, editor<span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">ClassicEditor</span><span class=\"tsd-signature-symbol\">)</span><span class=\"tsd-signature-symbol\">: </span><span class=\"tsd-signature-type\">void</span>",
         "description": "Callback fired when a key is pressed in the editor",
-        "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>12.29.0</p>\n</dd></dl></div>",
+        "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Callback fired when a key is pressed in the editor</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>0.0.1</p>\n</dd></dl></div>",
         "sourceFile": "TextEditor/TextEditor.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditor.types.ts#L132"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditor.types.ts#L141"
       }
     ],
     "description": ""

package/dist/_typedoc/TextEditor/TextEditorProvider.types.json

@@ -10,7 +10,7 @@
         "description": "",
         "descriptionHtml": "",
         "sourceFile": "TextEditor/TextEditorProvider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditorProvider.types.ts#L9"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditorProvider.types.ts#L9"
       },
       {
         "name": "features",
@@ -20,7 +20,7 @@
         "description": "- `stickyToolbar` - Have the editor toolbar stick to the top when content is longer than the page length.\n- `tabAsNavigation` - Have `Tab` key exit the editor. Support `Alt`/`Opt` + `Tab` as triple space indent.",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<ul>\n<li><code>stickyToolbar</code> - Have the editor toolbar stick to the top when content is longer than the page length.</li>\n<li><code>tabAsNavigation</code> - Have <code>Tab</code> key exit the editor. Support <code>Alt</code>/<code>Opt</code> + <code>Tab</code> as triple space indent.</li>\n</ul>\n</div></div>",
         "sourceFile": "TextEditor/TextEditorProvider.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditor/TextEditorProvider.types.ts#L14"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditor/TextEditorProvider.types.ts#L14"
       }
     ],
     "description": ""

package/dist/_typedoc/TextEditorOutput/TextEditorOutput.types.json

@@ -10,7 +10,7 @@
         "description": "Additional classNames",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional classNames</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.24.0</p>\n</dd></dl></div>",
         "sourceFile": "TextEditorOutput/TextEditorOutput.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L14"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L14"
       },
       {
         "name": "style",
@@ -20,7 +20,7 @@
         "description": "Additional CSS styles",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Additional CSS styles</p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.24.0</p>\n</dd></dl></div>",
         "sourceFile": "TextEditorOutput/TextEditorOutput.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L21"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L21"
       },
       {
         "name": "value",
@@ -30,7 +30,7 @@
         "description": "Formatted text from `TextEditor`",
         "descriptionHtml": "<div class=\"tsd-comment tsd-typography\"><div class=\"lead\">\n<p>Formatted text from <code>TextEditor</code></p>\n</div><dl class=\"tsd-comment-tags\"><dt>since</dt><dd><p>10.24.0</p>\n</dd></dl></div>",
         "sourceFile": "TextEditorOutput/TextEditorOutput.types.ts",
-        "sourceUrl": "https://github.com/procore/core/blob/672f459/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L7"
+        "sourceUrl": "https://github.com/procore/core/blob/5a7d81e/packages/text-editor/src/TextEditorOutput/TextEditorOutput.types.ts#L7"
       }
     ],
     "description": ""

package/dist/_typedoc/deprecations.json

@@ -1 +1 @@
-[{"interface":"TextEditorProps","property":"initialValue","deprecatedSince":"10.20.0","message":"`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead","deprecationKind":"prop"}]
+[{"interface":"TextEditorProps","property":"initialValue","deprecatedSince":"0.0.1","message":"`initialValue` has been deprecated and will be removed in a future version.\nPlease use the `value` prop instead","deprecationKind":"prop"}]

package/dist/index.d.ts

@@ -1,2 +1,3 @@
+export * from './DebouncedTextEditor';
 export * from './TextEditor';
 export * from './TextEditorOutput';

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from './DebouncedTextEditor';
 export * from './TextEditor';
 export * from './TextEditorOutput';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './TextEditor'\nexport * from './TextEditorOutput'\n"],"mappings":"AAAA,cAAc,cAAc;AAC5B,cAAc,oBAAoB"}
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export * from './DebouncedTextEditor'\nexport * from './TextEditor'\nexport * from './TextEditorOutput'\n"],"mappings":"AAAA,cAAc,uBAAuB;AACrC,cAAc,cAAc;AAC5B,cAAc,oBAAoB"}

package/dist/utils/debounce.d.ts

@@ -0,0 +1 @@
+export declare function debounce<T extends (...args: any[]) => void>(func: T, wait: number, immediate?: boolean): (this: ThisParameterType<T>, ...args: Parameters<T>) => void;

package/dist/utils/debounce.js

@@ -0,0 +1,24 @@
+export function debounce(func, wait) {
+  var immediate = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+  var timeout = null;
+  return function () {
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+    var context = this;
+    var callNow = immediate && timeout === null;
+    if (timeout !== null) {
+      clearTimeout(timeout);
+    }
+    timeout = setTimeout(function () {
+      timeout = null;
+      if (!immediate) {
+        func.apply(context, args);
+      }
+    }, wait);
+    if (callNow) {
+      func.apply(context, args);
+    }
+  };
+}
+//# sourceMappingURL=debounce.js.map

package/dist/utils/debounce.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debounce.js","names":["debounce","func","wait","immediate","arguments","length","undefined","timeout","_len","args","Array","_key","context","callNow","clearTimeout","setTimeout","apply"],"sources":["../../src/utils/debounce.ts"],"sourcesContent":["export function debounce<T extends (...args: any[]) => void>(\n  func: T,\n  wait: number,\n  immediate: boolean = false\n) {\n  let timeout: ReturnType<typeof setTimeout> | null = null\n\n  return function (this: ThisParameterType<T>, ...args: Parameters<T>): void {\n    const context = this\n\n    const callNow = immediate && timeout === null\n\n    if (timeout !== null) {\n      clearTimeout(timeout)\n    }\n\n    timeout = setTimeout(() => {\n      timeout = null\n      if (!immediate) {\n        func.apply(context, args)\n      }\n    }, wait)\n\n    if (callNow) {\n      func.apply(context, args)\n    }\n  }\n}\n"],"mappings":"AAAA,OAAO,SAASA,QAAQA,CACtBC,IAAO,EACPC,IAAY,EAEZ;EAAA,IADAC,SAAkB,GAAAC,SAAA,CAAAC,MAAA,QAAAD,SAAA,QAAAE,SAAA,GAAAF,SAAA,MAAG,KAAK;EAE1B,IAAIG,OAA6C,GAAG,IAAI;EAExD,OAAO,YAAoE;IAAA,SAAAC,IAAA,GAAAJ,SAAA,CAAAC,MAAA,EAA3BI,IAAI,OAAAC,KAAA,CAAAF,IAAA,GAAAG,IAAA,MAAAA,IAAA,GAAAH,IAAA,EAAAG,IAAA;MAAJF,IAAI,CAAAE,IAAA,IAAAP,SAAA,CAAAO,IAAA;IAAA;IAClD,IAAMC,OAAO,GAAG,IAAI;IAEpB,IAAMC,OAAO,GAAGV,SAAS,IAAII,OAAO,KAAK,IAAI;IAE7C,IAAIA,OAAO,KAAK,IAAI,EAAE;MACpBO,YAAY,CAACP,OAAO,CAAC;IACvB;IAEAA,OAAO,GAAGQ,UAAU,CAAC,YAAM;MACzBR,OAAO,GAAG,IAAI;MACd,IAAI,CAACJ,SAAS,EAAE;QACdF,IAAI,CAACe,KAAK,CAACJ,OAAO,EAAEH,IAAI,CAAC;MAC3B;IACF,CAAC,EAAEP,IAAI,CAAC;IAER,IAAIW,OAAO,EAAE;MACXZ,IAAI,CAACe,KAAK,CAACJ,OAAO,EAAEH,IAAI,CAAC;IAC3B;EACF,CAAC;AACH"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@procore/text-editor",
-  "version": "0.0.3",
+  "version": "0.2.0",
   "description": "Rich text editor component based on CKEditor 5",
   "author": "Procore Technologies",
   "homepage": "https://github.com/procore/core/tree/main/packages/text-editor",
@@ -12,16 +12,16 @@
   "bugs": "https://github.com/procore/core/issues",
   "license": "SEE LICENSE IN LICENSE",
   "keywords": [
-    "javascript",
+    "ckeditor",
     "components",
-    "react",
+    "javascript",
     "js",
     "jsx",
     "library",
     "procore",
-    "text-editor",
+    "react",
     "rich-text",
-    "ckeditor"
+    "text-editor"
   ],
   "publishConfig": {
     "access": "public"
@@ -30,8 +30,8 @@
     ".": "./dist/index.js",
     "./jestConfig": {
       "types": "./jestConfig.d.ts",
-      "require": "./jestConfig.js",
-      "import": "./jestConfig.js"
+      "import": "./jestConfig.js",
+      "require": "./jestConfig.js"
     },
     "./dist/_typedoc/*.json": "./dist/_typedoc/*.json",
     "./dist/_typedoc/**/*.json": "./dist/_typedoc/**/*.json"
@@ -55,6 +55,8 @@
     "build:esm": "BUNDLING=true babel src --out-dir dist --extensions '.ts,.tsx,.js,.snap' -s --copy-files --no-copy-ignored",
     "build:typedoc": "ts-node typedoc.ts",
     "build:types": "tsc --declaration --emitDeclarationOnly -p tsconfig.prod.json",
+    "chromatic": "dotenvx run -- chromatic",
+    "chromatic:ci": "chromatic --ci  --storybook-build-dir ./storybook-static --project-token=${CHROMATIC_TEXT_EDITOR_TOKEN} --exit-once-uploaded --only-changed --skip=\"dependabot*\"",
     "clean": "rimraf dist",
     "dev": "NODE_ENV=development yarn run dev:ts",
     "dev:ts": "tsc -p tsconfig.prod.json --watch",
@@ -67,7 +69,7 @@
     "test:watch": "yarn run test --watch"
   },
   "peerDependencies": {
-    "@procore/core-react": "^12.33.0",
+    "@procore/core-react": "^12.40.0",
     "@procore/globalization-toolkit": ">= 3 < 4",
     "ckeditor5": "^46.0.1",
     "react": ">=16.8.0 < 19",
@@ -77,7 +79,7 @@
   "dependencies": {
     "@ckeditor/ckeditor5-react": "^11.0.0",
     "@procore/core-i18n-js": "^10.30.0",
-    "@procore/core-icons": "^12.11.0",
+    "@procore/core-icons": "^12.13.0",
     "@react-aria/focus": "3.16.2",
     "@react-aria/utils": "3.23.2",
     "sanitize-html": "^2.17.0"
@@ -91,8 +93,7 @@
     "@babel/preset-react": "7.18.6",
     "@babel/preset-typescript": "7.18.6",
     "@babel/register": "7.18.9",
-    "@ckeditor/ckeditor5-dev-webpack-plugin": "^31.1.13",
-    "@procore/core-react": "^12.33.0",
+    "@procore/core-react": "^12.40.0",
     "@procore/globalization-toolkit": "3.0.0",
     "@storybook/addon-webpack5-compiler-swc": "^4.0.2",
     "@storybook/jest": "^0.2.3",
@@ -130,7 +131,7 @@
     "react": "18.3.1",
     "react-dom": "18.3.1",
     "rimraf": "^6.0.1",
-    "storybook": "^9.1.16",
+    "storybook": "^9.1.17",
     "style-loader": "^4.0.0",
     "styled-components": "6.1.18",
     "ts-jest": "^29.0.5",

package/dist/TextEditor/utils/plugins.d.ts

@@ -1,7 +0,0 @@
-import type { EditorConfig, Plugin } from 'ckeditor5';
-/** Gets CKEditor plugin objects from TinyMCE string plugin names */
-export declare const getPluginsFromStringArray: (pluginNames?: string[]) => (typeof Plugin)[];
-/** Gets toolbar items that should be added for the given string plugin names. */
-export declare const getToolbarItemsFromStringArray: (pluginNames?: string[]) => string[];
-/** Enhances an editor config by adding plugins and toolbar items from TinyMCE string array */
-export declare const addPluginsFromStringArray: (config: EditorConfig, pluginNames?: string[]) => EditorConfig;