@vaadin/markdown 25.3.0-alpha9 → 25.3.0-beta1

package/custom-elements.json

@@ -35,6 +35,16 @@
               },
               "description": "The Markdown content.",
               "attribute": "content"
+            },
+            {
+              "kind": "field",
+              "name": "lineBreaks",
+              "privacy": "public",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When set to `true`, single line breaks (\"soft breaks\") within a\nparagraph are converted into `<br>` elements, the same way chat and\nmessage-style Markdown behaves.\n\nBy default, following the original Markdown specification, single line\nbreaks are ignored (collapsed into a space) and a blank line is\nrequired to start a new paragraph.",
+              "attribute": "line-breaks"
             }
           ],
           "attributes": [
@@ -46,6 +56,14 @@
               "description": "The Markdown content.",
               "fieldName": "content"
             },
+            {
+              "name": "line-breaks",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "When set to `true`, single line breaks (\"soft breaks\") within a\nparagraph are converted into `<br>` elements, the same way chat and\nmessage-style Markdown behaves.\n\nBy default, following the original Markdown specification, single line\nbreaks are ignored (collapsed into a space) and a blank line is\nrequired to start a new paragraph.",
+              "fieldName": "lineBreaks"
+            },
             {
               "type": {
                 "text": "string"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vaadin/markdown",
-  "version": "25.3.0-alpha9",
+  "version": "25.3.0-beta1",
   "publishConfig": {
     "access": "public"
   },
@@ -35,23 +35,23 @@
   ],
   "dependencies": {
     "@open-wc/dedupe-mixin": "^1.3.0",
-    "@vaadin/component-base": "25.3.0-alpha9",
-    "@vaadin/vaadin-themable-mixin": "25.3.0-alpha9",
+    "@vaadin/component-base": "25.3.0-beta1",
+    "@vaadin/vaadin-themable-mixin": "25.3.0-beta1",
     "dompurify": "^3.4.10",
     "lit": "^3.0.0",
     "marked": "^18.0.5"
   },
   "devDependencies": {
-    "@vaadin/aura": "25.3.0-alpha9",
-    "@vaadin/chai-plugins": "25.3.0-alpha9",
-    "@vaadin/test-runner-commands": "25.3.0-alpha9",
+    "@vaadin/aura": "25.3.0-beta1",
+    "@vaadin/chai-plugins": "25.3.0-beta1",
+    "@vaadin/test-runner-commands": "25.3.0-beta1",
     "@vaadin/testing-helpers": "^2.0.0",
-    "@vaadin/vaadin-lumo-styles": "25.3.0-alpha9"
+    "@vaadin/vaadin-lumo-styles": "25.3.0-beta1"
   },
   "customElements": "custom-elements.json",
   "web-types": [
     "web-types.json",
     "web-types.lit.json"
   ],
-  "gitHead": "cb915ebde095ec5b94a87af93dd4530f51984c52"
+  "gitHead": "295432e44a6967e1aff36462b2e3e1d0e64eb8cc"
 }

package/src/markdown-helpers.js

@@ -76,10 +76,15 @@ function synchronizeNodes(targetNode, sourceNode) {
 
 /**
  * Updates the content of a target element with the given Markdown parsed as HTML.
+ *
+ * When `lineBreaks` is enabled, single line breaks ("soft breaks") within a
+ * paragraph are converted into `<br>` elements, matching the behavior of
+ * chat/message-style Markdown. By default they are ignored, following the
+ * original Markdown specification.
  */
-export function renderMarkdownToElement(element, markdown) {
+export function renderMarkdownToElement(element, markdown, { lineBreaks = false } = {}) {
   const template = document.createElement('template');
-  template.innerHTML = DOMPurify.sanitize(parse(markdown || ''), {
+  template.innerHTML = DOMPurify.sanitize(parse(markdown || '', { breaks: lineBreaks }), {
     CUSTOM_ELEMENT_HANDLING: {
       tagNameCheck: (_tagName) => true,
     },

package/src/vaadin-markdown.d.ts

@@ -24,6 +24,19 @@ declare class Markdown extends SlotStylesMixin(ElementMixin(ThemableMixin(HTMLEl
    * The Markdown content.
    */
   content: string | null | undefined;
+
+  /**
+   * When set to `true`, single line breaks ("soft breaks") within a
+   * paragraph are converted into `<br>` elements, the same way chat and
+   * message-style Markdown behaves.
+   *
+   * By default, following the original Markdown specification, single line
+   * breaks are ignored (collapsed into a space) and a blank line is
+   * required to start a new paragraph.
+   *
+   * @attr {boolean} line-breaks
+   */
+  lineBreaks: boolean;
 }
 
 declare global {

package/src/vaadin-markdown.js

@@ -59,6 +59,23 @@ class Markdown extends SlotStylesMixin(ElementMixin(ThemableMixin(PolylitMixin(L
         type: String,
         sync: true,
       },
+
+      /**
+       * When set to `true`, single line breaks ("soft breaks") within a
+       * paragraph are converted into `<br>` elements, the same way chat and
+       * message-style Markdown behaves.
+       *
+       * By default, following the original Markdown specification, single line
+       * breaks are ignored (collapsed into a space) and a blank line is
+       * required to start a new paragraph.
+       *
+       * @attr {boolean} line-breaks
+       */
+      lineBreaks: {
+        type: Boolean,
+        value: false,
+        sync: true,
+      },
     };
   }
 
@@ -74,8 +91,8 @@ class Markdown extends SlotStylesMixin(ElementMixin(ThemableMixin(PolylitMixin(L
   updated(props) {
     super.updated(props);
 
-    if (props.has('content')) {
-      renderMarkdownToElement(this, this.content);
+    if (props.has('content') || props.has('lineBreaks')) {
+      renderMarkdownToElement(this, this.content, { lineBreaks: this.lineBreaks });
     }
   }
 }

package/web-types.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/markdown",
-  "version": "25.3.0-alpha9",
+  "version": "25.3.0-beta1",
   "description-markup": "markdown",
   "contributions": {
     "html": {
@@ -19,6 +19,15 @@
                 ]
               }
             },
+            {
+              "name": "line-breaks",
+              "description": "When set to `true`, single line breaks (\"soft breaks\") within a\nparagraph are converted into `<br>` elements, the same way chat and\nmessage-style Markdown behaves.\n\nBy default, following the original Markdown specification, single line\nbreaks are ignored (collapsed into a space) and a blank line is\nrequired to start a new paragraph.",
+              "value": {
+                "type": [
+                  "boolean"
+                ]
+              }
+            },
             {
               "name": "theme",
               "description": "The theme variants to apply to the component.",
@@ -39,6 +48,15 @@
                     "string"
                   ]
                 }
+              },
+              {
+                "name": "lineBreaks",
+                "description": "When set to `true`, single line breaks (\"soft breaks\") within a\nparagraph are converted into `<br>` elements, the same way chat and\nmessage-style Markdown behaves.\n\nBy default, following the original Markdown specification, single line\nbreaks are ignored (collapsed into a space) and a blank line is\nrequired to start a new paragraph.",
+                "value": {
+                  "type": [
+                    "boolean"
+                  ]
+                }
               }
             ],
             "events": []

package/web-types.lit.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/web-types",
   "name": "@vaadin/markdown",
-  "version": "25.3.0-alpha9",
+  "version": "25.3.0-beta1",
   "description-markup": "markdown",
   "framework": "lit",
   "framework-config": {
@@ -25,6 +25,13 @@
               "value": {
                 "kind": "expression"
               }
+            },
+            {
+              "name": "?lineBreaks",
+              "description": "When set to `true`, single line breaks (\"soft breaks\") within a\nparagraph are converted into `<br>` elements, the same way chat and\nmessage-style Markdown behaves.\n\nBy default, following the original Markdown specification, single line\nbreaks are ignored (collapsed into a space) and a blank line is\nrequired to start a new paragraph.",
+              "value": {
+                "kind": "expression"
+              }
             }
           ]
         }