@llumi/design-system 0.1.0 → 1.0.0

package/README.md

@@ -44,7 +44,9 @@ import "@llumi/design-system/review";
 <script type="module">
   const review = document.querySelector("llumi-review");
   review.addEventListener("llumi-review-submit", (e) => {
-    console.log(e.detail); // ReviewResult
+    const { result, clearPersisted } = e.detail;
+    // ...send `result` to the server, then on success:
+    clearPersisted();
   });
 </script>
 ```
@@ -82,6 +84,7 @@ each comment's `targetId`.
 | `bar-position` | `top-left` \| `top-center` \| `top-right` \| `bottom-left` \| `bottom-center` \| `bottom-right` | `bottom-center` | Initial corner for the floating toolbar (which is also draggable). |
 | `shortcut` | string ([tinykeys](https://github.com/jamiebuilds/tinykeys) syntax) | `$mod+Shift+M` | Keyboard shortcut that toggles annotate mode. |
 | `default-mode` | `idle` \| `annotating` | `idle` | Whether annotate mode is on at mount. |
+| `persist` | `string` (attribute) | — | When set to a non-empty value, mirrors the review draft to `localStorage` under that key and restores it on load. A persisted draft takes precedence over `initialData`. Restored selection highlights are painted when annotate mode is active (consistent with how `initialData` behaves). |
 
 ### Properties (set in JS — complex values)
 
@@ -90,6 +93,12 @@ each comment's `targetId`.
 | `initialData` | `ReviewResult` | Pre-populate existing comments / overall comment. |
 | `customTargets` | `CustomTarget[]` | Resolve comment targets from arbitrary selectors (advanced). |
 
+### Methods
+
+| Method | Description |
+| --- | --- |
+| `clearPersisted()` | Clears the persisted draft for this element's `persist` key. No-op when `persist` is unset. Call after a confirmed server save. |
+
 ```ts
 const review = document.querySelector("llumi-review");
 review.initialData = {
@@ -100,12 +109,12 @@ review.initialData = {
 
 ### Events
 
-Both are `CustomEvent<ReviewResult>` and bubble (composed):
+Both events bubble and are composed:
 
-| Event | Fires |
-| --- | --- |
-| `llumi-review-change` | On every edit (comment added/edited/deleted, overall comment changed). |
-| `llumi-review-submit` | When the user clicks Submit / Approve. |
+| Event | Detail type | Fires |
+| --- | --- | --- |
+| `llumi-review-change` | `ReviewResult` | On every edit (comment added/edited/deleted, overall comment changed). |
+| `llumi-review-submit` | `{ result: ReviewResult, clearPersisted: () => void }` | When the user clicks Submit / Approve. `clearPersisted` clears the localStorage draft — call it after a confirmed server save. |
 
 ```ts
 type ReviewResult =

package/custom-elements.json

@@ -621,7 +621,7 @@
       "declarations": [
         {
           "kind": "class",
-          "description": "`<llumi-review>` — wraps light-DOM content for element- and text-selection\nreview comments. Both events carry a `ReviewResult` detail and are composed.",
+          "description": "`<llumi-review>` — wraps light-DOM content for element- and text-selection\nreview comments. Both events bubble and are composed.",
           "name": "LlumiReview",
           "members": [
             {
@@ -646,6 +646,15 @@
               },
               "privacy": "private"
             },
+            {
+              "kind": "field",
+              "name": "persistence",
+              "type": {
+                "text": "ReviewPersistence"
+              },
+              "privacy": "private",
+              "default": "noopPersistence"
+            },
             {
               "kind": "field",
               "name": "manager",
@@ -746,17 +755,51 @@
               "privacy": "private",
               "readonly": true
             },
+            {
+              "kind": "field",
+              "name": "persistKey",
+              "type": {
+                "text": "string | null"
+              },
+              "privacy": "private",
+              "readonly": true
+            },
             {
               "kind": "method",
-              "name": "emitResult",
+              "name": "buildDetailResult",
               "privacy": "private",
+              "return": {
+                "type": {
+                  "text": "ReviewResult"
+                }
+              },
               "parameters": [
                 {
-                  "name": "type",
+                  "name": "result",
                   "type": {
-                    "text": "string"
+                    "text": "ReviewResult"
                   }
-                },
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "emitChange",
+              "privacy": "private",
+              "parameters": [
+                {
+                  "name": "result",
+                  "type": {
+                    "text": "ReviewResult"
+                  }
+                }
+              ]
+            },
+            {
+              "kind": "method",
+              "name": "emitSubmit",
+              "privacy": "private",
+              "parameters": [
                 {
                   "name": "result",
                   "type": {
@@ -765,6 +808,16 @@
                 }
               ]
             },
+            {
+              "kind": "method",
+              "name": "clearPersisted",
+              "return": {
+                "type": {
+                  "text": "void"
+                }
+              },
+              "description": "Clears the persisted draft for this element. No-op when persistence is off."
+            },
             {
               "kind": "method",
               "name": "mountChrome",
@@ -875,12 +928,18 @@
           ],
           "events": [
             {
-              "description": "On every edit (comment added/edited/deleted, or overall comment changed).",
-              "name": "llumi-review-change"
+              "name": "llumi-review-change",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "On every edit (comment added/edited/deleted, or overall comment changed). `detail` is a `ReviewResult`."
             },
             {
-              "description": "When the user clicks Submit / Approve.",
-              "name": "llumi-review-submit"
+              "name": "llumi-review-submit",
+              "type": {
+                "text": "CustomEvent"
+              },
+              "description": "When the user clicks Submit / Approve. `detail` is `{ result: ReviewResult, clearPersisted: () => void }`; call `clearPersisted()` after a confirmed server save to discard the persisted draft."
             }
           ],
           "attributes": [