@dmitryvim/form-builder 0.2.29 → 0.2.32

package/README.md

@@ -304,6 +304,7 @@ See [Integration Guide](docs/integration.md) for detailed setup instructions.
 - **File**: Single file upload with compact dropzone, tile preview, and type restrictions
 - **Files**: Multiple file upload with 80px tile grid, per-file upload progress, and drag-and-drop
 - **Container**: Nested containers with repeatable array support
+- **Markdown**: Display-only text block rendered from markdown syntax (v0.2.30+); never included in form data output
 
 ### File Handling
 
@@ -821,6 +822,56 @@ An editable 2D grid with plain-text cells, cell merging, and full keyboard navig
 - Readonly mode renders a static `<table>`
 - Full i18n support (6 translation keys: `tableAddRow`, `tableAddColumn`, `tableRemoveRow`, `tableRemoveColumn`, `tableMergeCells`, `tableSplitCell`)
 
+### Markdown Element (v0.2.30+)
+
+A display-only element that renders markdown as safe HTML. It never appears in `getFormData()` output.
+
+**Schema:**
+
+```json
+{
+  "type": "markdown",
+  "content": "# Welcome\n\nPlease fill in **all required fields** below.\n\nSee the [guidelines](https://example.com) for details."
+}
+```
+
+**With optional key and conditional visibility:**
+
+```json
+{
+  "type": "markdown",
+  "key": "terms-note",
+  "content": "## Terms Apply\n\nBy submitting you agree to our [terms](https://example.com/terms).",
+  "enableIf": { "key": "agreed", "equals": "yes" }
+}
+```
+
+**Properties:**
+
+| Property    | Type     | Required | Description                                              |
+| ----------- | -------- | -------- | -------------------------------------------------------- |
+| `type`      | `string` | Yes      | Must be `"markdown"`                                     |
+| `content`   | `string` | Yes      | Markdown source text                                     |
+| `key`       | `string` | No       | Optional identifier; field never contributes to form data |
+| `enableIf`  | object   | No       | Conditional visibility (same as other field types)       |
+
+**Supported markdown syntax:**
+
+- Headings: `# H1` through `###### H6`
+- Emphasis: `**bold**`, `*italic*`, `~~strikethrough~~`
+- Inline code: `` `code` ``
+- Fenced code blocks: ` ```language ... ``` `
+- Links: `[text](url)`
+- Lists: ordered (`1.`) and unordered (`-`, `*`)
+- Blockquotes: `> text`
+- Horizontal rules: `---`
+
+**XSS Protection:**
+
+- Raw `<`, `>`, `&` characters in content are escaped before parsing — HTML tags in markdown source cannot render as DOM elements
+- `javascript:`, `data:`, `vbscript:` href schemes are stripped from all links
+- All rendered links get `target="_blank" rel="noopener noreferrer"`
+
 ## Documentation
 
 - **API Reference** - See above for core methods and theming