@rcarls/rc-markdown-editor 0.3.2 → 0.4.0

package/dist/custom-elements.json

@@ -205,7 +205,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "Formatting toolbar for `<rc-markdown-editor>`. Renders into its own light DOM\nso the parent shadow stylesheet can reach `rc-editor-toolbar button` directly.\n\nActive-format properties are set by the parent editor and reflected as\n`aria-pressed` on the corresponding buttons. Heading level is shown via an\n`<rc-select>`. Code-block language is shown via a `<input>` when active.",
+          "description": "Formatting toolbar for `<rc-markdown-editor>`. Renders themed `rc-button`,\n`rc-select`, and `rc-toolbar` controls into its own light DOM so the parent\neditor can provide their shared appearance.\n\nActive-format properties are set by the parent editor and reflected as\n`aria-pressed` on the corresponding buttons. Heading level is shown via an\n`<rc-select>`. Code-block language is shown via a `<input>` when active.",
           "name": "RcEditorToolbar",
           "members": [
             {
@@ -215,7 +215,7 @@
                 "text": "string"
               },
               "default": "'Formatting'",
-              "description": "`aria-label` applied to the `[role=\"toolbar\"]` container.",
+              "description": "Accessible label applied to the `rc-toolbar` container.",
               "attribute": "label"
             },
             {
@@ -225,6 +225,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether Bold formatting is active at the cursor.",
               "attribute": "active-bold",
               "reflects": true
             },
@@ -235,6 +236,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether Italic formatting is active at the cursor.",
               "attribute": "active-italic",
               "reflects": true
             },
@@ -245,6 +247,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether Underline formatting is active at the cursor.",
               "attribute": "active-underline",
               "reflects": true
             },
@@ -255,6 +258,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether Strikethrough formatting is active at the cursor.",
               "attribute": "active-strikethrough",
               "reflects": true
             },
@@ -265,6 +269,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether inline Code formatting is active at the cursor.",
               "attribute": "active-code",
               "reflects": true
             },
@@ -275,6 +280,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether the cursor is inside a Link.",
               "attribute": "active-link",
               "reflects": true
             },
@@ -285,6 +291,7 @@
                 "text": "HeadingLevel | null"
               },
               "default": "null",
+              "description": "Heading level active at the cursor, or `null` for paragraph text.",
               "attribute": "active-heading"
             },
             {
@@ -294,6 +301,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether the cursor is inside a Blockquote.",
               "attribute": "active-blockquote",
               "reflects": true
             },
@@ -304,6 +312,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether the cursor is inside a Bullet List.",
               "attribute": "active-bullet-list",
               "reflects": true
             },
@@ -314,6 +323,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether the cursor is inside an Ordered List.",
               "attribute": "active-ordered-list",
               "reflects": true
             },
@@ -324,6 +334,7 @@
                 "text": "boolean"
               },
               "default": "false",
+              "description": "Whether the cursor is inside a Code Block.",
               "attribute": "active-code-block",
               "reflects": true
             },
@@ -361,6 +372,11 @@
               "kind": "method",
               "name": "_dispatch",
               "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
               "parameters": [
                 {
                   "name": "action",
@@ -401,6 +417,48 @@
               "kind": "field",
               "name": "_onLangKeyDown",
               "privacy": "protected"
+            },
+            {
+              "kind": "method",
+              "name": "_renderActionButton",
+              "privacy": "protected",
+              "return": {
+                "type": {
+                  "text": "TemplateResult"
+                }
+              },
+              "parameters": [
+                {
+                  "name": "action",
+                  "type": {
+                    "text": "EditorToolbarAction"
+                  }
+                },
+                {
+                  "name": "label",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "title",
+                  "type": {
+                    "text": "string"
+                  }
+                },
+                {
+                  "name": "active",
+                  "type": {
+                    "text": "boolean"
+                  }
+                },
+                {
+                  "name": "icon",
+                  "type": {
+                    "text": "SVGTemplateResult"
+                  }
+                }
+              ]
             }
           ],
           "events": [
@@ -414,15 +472,16 @@
           ],
           "attributes": [
             {
+              "description": "Accessible label applied to the `rc-toolbar` container.",
               "name": "label",
               "type": {
                 "text": "string"
               },
               "default": "'Formatting'",
-              "description": "`aria-label` applied to the `[role=\"toolbar\"]` container.",
               "fieldName": "label"
             },
             {
+              "description": "Whether Bold formatting is active at the cursor.",
               "name": "active-bold",
               "type": {
                 "text": "boolean"
@@ -431,6 +490,7 @@
               "fieldName": "activeBold"
             },
             {
+              "description": "Whether Italic formatting is active at the cursor.",
               "name": "active-italic",
               "type": {
                 "text": "boolean"
@@ -439,6 +499,7 @@
               "fieldName": "activeItalic"
             },
             {
+              "description": "Whether Underline formatting is active at the cursor.",
               "name": "active-underline",
               "type": {
                 "text": "boolean"
@@ -447,6 +508,7 @@
               "fieldName": "activeUnderline"
             },
             {
+              "description": "Whether Strikethrough formatting is active at the cursor.",
               "name": "active-strikethrough",
               "type": {
                 "text": "boolean"
@@ -455,6 +517,7 @@
               "fieldName": "activeStrikethrough"
             },
             {
+              "description": "Whether inline Code formatting is active at the cursor.",
               "name": "active-code",
               "type": {
                 "text": "boolean"
@@ -463,6 +526,7 @@
               "fieldName": "activeCode"
             },
             {
+              "description": "Whether the cursor is inside a Link.",
               "name": "active-link",
               "type": {
                 "text": "boolean"
@@ -471,6 +535,7 @@
               "fieldName": "activeLink"
             },
             {
+              "description": "Heading level active at the cursor, or `null` for paragraph text.",
               "name": "active-heading",
               "type": {
                 "text": "HeadingLevel | null"
@@ -479,6 +544,7 @@
               "fieldName": "activeHeading"
             },
             {
+              "description": "Whether the cursor is inside a Blockquote.",
               "name": "active-blockquote",
               "type": {
                 "text": "boolean"
@@ -487,6 +553,7 @@
               "fieldName": "activeBlockquote"
             },
             {
+              "description": "Whether the cursor is inside a Bullet List.",
               "name": "active-bullet-list",
               "type": {
                 "text": "boolean"
@@ -495,6 +562,7 @@
               "fieldName": "activeBulletList"
             },
             {
+              "description": "Whether the cursor is inside an Ordered List.",
               "name": "active-ordered-list",
               "type": {
                 "text": "boolean"
@@ -503,6 +571,7 @@
               "fieldName": "activeOrderedList"
             },
             {
+              "description": "Whether the cursor is inside a Code Block.",
               "name": "active-code-block",
               "type": {
                 "text": "boolean"
@@ -511,21 +580,21 @@
               "fieldName": "activeCodeBlock"
             },
             {
+              "description": "Language of the code block at the cursor. `null` means not in a code block\n(hides the language input). `''` means no language is set.",
               "name": "code-language",
               "type": {
                 "text": "string | null"
               },
               "default": "null",
-              "description": "Language of the code block at the cursor. `null` means not in a code block\n(hides the language input). `''` means no language is set.",
               "fieldName": "codeLanguage"
             },
             {
+              "description": "Whether the editor is in source mode.",
               "name": "source-mode",
               "type": {
                 "text": "boolean"
               },
               "default": "false",
-              "description": "Whether the editor is in source mode.",
               "fieldName": "sourceMode"
             }
           ],
@@ -556,6 +625,114 @@
           "kind": "class",
           "description": "Rich/source Markdown editor with a formatting toolbar, backed by rc-textarea.\n\n- **Rich mode (default)**: A `contenteditable` div shows micromark-rendered\n  HTML. DOM mutations are converted back to markdown via turndown and\n  written to the backing `<textarea>` for form participation.\n- **Source mode**: An `<rc-textarea>` instance shows the markdown source\n  with live decorations. Toggle via `source-mode` attribute or Ctrl+Shift+S.\n\nConsumer markup follows the same progressive-enhancement contract as\n`<rc-textarea>`:\n\n```html\n<rc-markdown-editor>\n  <label for=\"body\">Content</label>\n  <textarea id=\"body\" name=\"body\"></textarea>\n</rc-markdown-editor>\n```",
           "name": "RcMarkdownEditor",
+          "cssProperties": [
+            {
+              "description": "Font family of the rich-text view",
+              "name": "--rme-font-family",
+              "default": "inherit"
+            },
+            {
+              "description": "Font size of the rich-text view",
+              "name": "--rme-font-size",
+              "default": "inherit"
+            },
+            {
+              "description": "Line height of the rich-text view",
+              "name": "--rme-line-height",
+              "default": "1.6"
+            },
+            {
+              "description": "Padding inside the rich-text view",
+              "name": "--rme-padding",
+              "default": "0.75em 1em"
+            },
+            {
+              "description": "Background color of the rich-text view",
+              "name": "--rme-background",
+              "default": "Canvas"
+            },
+            {
+              "description": "Text color of the rich-text view",
+              "name": "--rme-color",
+              "default": "CanvasText"
+            },
+            {
+              "description": "Border around the rich-text view",
+              "name": "--rme-border",
+              "default": "1px solid ButtonBorder"
+            },
+            {
+              "description": "Border radius of the rich-text view",
+              "name": "--rme-border-radius",
+              "default": "0 0 4px 4px"
+            },
+            {
+              "description": "Focus ring outline on the rich-text view",
+              "name": "--rme-focus-outline",
+              "default": "2px solid Highlight"
+            },
+            {
+              "description": "Font family of the source editor",
+              "name": "--rme-src-font-family",
+              "default": "'Cascadia Code', 'Fira Code', ui-monospace, monospace"
+            },
+            {
+              "description": "Gap between toolbar buttons",
+              "name": "--rme-toolbar-gap",
+              "default": "1px"
+            },
+            {
+              "description": "Minimum inline and block size of toolbar buttons",
+              "name": "--rme-toolbar-button-size",
+              "default": "2rem"
+            },
+            {
+              "description": "Source-mode heading token color",
+              "name": "--rme-src-heading-color",
+              "default": "light-dark(#1d6fc4, #82b4f5)"
+            },
+            {
+              "description": "Source-mode inline/fenced code token color",
+              "name": "--rme-src-code-color",
+              "default": "light-dark(#c94a1a, #f09060)"
+            },
+            {
+              "description": "Source-mode link token color",
+              "name": "--rme-src-link-color",
+              "default": "light-dark(#0370b0, #60b8e8)"
+            },
+            {
+              "description": "Source-mode blockquote token color",
+              "name": "--rme-src-blockquote-color",
+              "default": "light-dark(#2d7a42, #70b880)"
+            },
+            {
+              "description": "Source-mode list marker token color",
+              "name": "--rme-src-list-color",
+              "default": "light-dark(#7a5c0a, #d4ac48)"
+            },
+            {
+              "description": "Source-mode strikethrough token color",
+              "name": "--rme-src-dim-color",
+              "default": "GrayText"
+            }
+          ],
+          "cssParts": [
+            {
+              "description": "The `<rc-editor-toolbar>` element.",
+              "name": "toolbar"
+            },
+            {
+              "description": "The contenteditable rich-text view.",
+              "name": "rich-view"
+            }
+          ],
+          "slots": [
+            {
+              "description": "Accepts a native `<textarea>` element (and optional `<label>`) for form wiring.",
+              "name": ""
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -589,6 +766,7 @@
               "type": {
                 "text": "string"
               },
+              "description": "Initial uncontrolled Markdown value.",
               "attribute": "default-value"
             },
             {
@@ -596,7 +774,9 @@
               "name": "value",
               "type": {
                 "text": "string"
-              }
+              },
+              "description": "Current Markdown value. Host writes are silent.",
+              "attribute": "value"
             },
             {
               "kind": "field",
@@ -630,6 +810,7 @@
               "type": {
                 "text": "boolean"
               },
+              "description": "Initial uncontrolled source-mode state.",
               "attribute": "default-source-mode"
             },
             {
@@ -638,6 +819,7 @@
               "type": {
                 "text": "boolean"
               },
+              "description": "Controlled: show the markdown source editor instead of the rich view.\nHost writes are silent; toolbar/keyboard toggles dispatch `rc-mode-change`.",
               "attribute": "source-mode",
               "reflects": true
             },
@@ -759,6 +941,15 @@
               "privacy": "protected",
               "default": "null"
             },
+            {
+              "kind": "field",
+              "name": "_renderedMode",
+              "type": {
+                "text": "EditorMode | null"
+              },
+              "privacy": "protected",
+              "default": "null"
+            },
             {
               "kind": "field",
               "name": "_firstUpdatedDone",
@@ -1125,40 +1316,49 @@
           ],
           "attributes": [
             {
+              "description": "Show the formatting toolbar.",
+              "name": "toolbar",
               "type": {
                 "text": "boolean"
               },
-              "description": "Show the formatting toolbar.",
-              "name": "toolbar",
               "default": "true",
               "fieldName": "toolbar"
             },
             {
+              "description": "Controlled: show the markdown source editor instead of the rich view.\nHost writes are silent; toolbar/keyboard toggles dispatch `rc-mode-change`.",
+              "name": "source-mode",
               "type": {
                 "text": "boolean"
               },
-              "description": "Controlled: show the markdown source editor.",
-              "name": "source-mode",
               "fieldName": "sourceMode"
             },
             {
+              "description": "Initial uncontrolled source-mode state.",
+              "name": "default-source-mode",
               "type": {
                 "text": "boolean"
               },
-              "description": "Uncontrolled initial source-mode state.",
-              "name": "default-source-mode",
               "fieldName": "defaultSourceMode"
             },
             {
+              "description": "Make the editor read-only.",
+              "name": "read-only",
               "type": {
                 "text": "boolean"
               },
-              "description": "Make the editor read-only.",
-              "name": "read-only",
               "default": "false",
               "fieldName": "readOnly"
             },
             {
+              "description": "Current Markdown value. Host writes are silent.",
+              "name": "value",
+              "type": {
+                "text": "string"
+              },
+              "fieldName": "value"
+            },
+            {
+              "description": "Initial uncontrolled Markdown value.",
               "name": "default-value",
               "type": {
                 "text": "string"