@scalably/ui 0.5.1 → 0.5.3

package/dist/index.d.cts

@@ -2424,6 +2424,22 @@ interface RichTextEditorProps {
  * - Renders a toolbar with common formatting controls.
  * - Mimics the design system's input styling (label, error, helper text).
  *
+ * **Supported HTML Tags:**
+ * The editor supports the following HTML tags through TipTap extensions:
+ * - **Text formatting**: `<p>`, `<h1>`, `<h2>`, `<h3>`, `<strong>`, `<em>`, `<u>`, `<code>`, `<blockquote>`, `<s>` (strikethrough)
+ * - **Advanced formatting**: `<sub>` (subscript), `<sup>` (superscript), `<mark>` (highlight)
+ * - **Lists**: `<ul>`, `<ol>`, `<li>`
+ * - **Links**: `<a>`
+ * - **Media**: `<img>`, `<iframe>` (YouTube embeds)
+ * - **Tables**: `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`
+ * - **Semantic**: `<figure>`, `<figcaption>`, `<span>` (with classes/styles preserved)
+ * - **Alignment**: Text alignment via `style="text-align: ..."` on paragraphs and headings
+ * - **Other**: `<hr>`, `<br>`
+ *
+ * **Important:** TipTap uses a schema-based system. HTML tags not explicitly
+ * supported by extensions will be stripped or converted during parsing. If you
+ * need additional tag support, custom extensions must be added.
+ *
  * **Viewing Content:**
  * To display the HTML content created with this editor in read-only mode,
  * use the `RichTextViewer` component. It ensures content rendered in "view"

package/dist/index.d.ts

@@ -2424,6 +2424,22 @@ interface RichTextEditorProps {
  * - Renders a toolbar with common formatting controls.
  * - Mimics the design system's input styling (label, error, helper text).
  *
+ * **Supported HTML Tags:**
+ * The editor supports the following HTML tags through TipTap extensions:
+ * - **Text formatting**: `<p>`, `<h1>`, `<h2>`, `<h3>`, `<strong>`, `<em>`, `<u>`, `<code>`, `<blockquote>`, `<s>` (strikethrough)
+ * - **Advanced formatting**: `<sub>` (subscript), `<sup>` (superscript), `<mark>` (highlight)
+ * - **Lists**: `<ul>`, `<ol>`, `<li>`
+ * - **Links**: `<a>`
+ * - **Media**: `<img>`, `<iframe>` (YouTube embeds)
+ * - **Tables**: `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`
+ * - **Semantic**: `<figure>`, `<figcaption>`, `<span>` (with classes/styles preserved)
+ * - **Alignment**: Text alignment via `style="text-align: ..."` on paragraphs and headings
+ * - **Other**: `<hr>`, `<br>`
+ *
+ * **Important:** TipTap uses a schema-based system. HTML tags not explicitly
+ * supported by extensions will be stripped or converted during parsing. If you
+ * need additional tag support, custom extensions must be added.
+ *
  * **Viewing Content:**
  * To display the HTML content created with this editor in read-only mode,
  * use the `RichTextViewer` component. It ensures content rendered in "view"