docs: annotate quads-changed event

zazuko · Nov 25, 2024 · 76843c2 · 76843c2
1 parent 7185df6
commit 76843c2
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 6 deletions.
diff --git a/packages/rdf-snippet/README.md b/packages/rdf-snippet/README.md
@@ -60,10 +60,10 @@ package.
 
 ## Events
 
-| Event           | Type                              |
-|-----------------|-----------------------------------|
-| `quads-changed` | `CustomEvent<{ value: any[]; }>`  |
-| `value-changed` | `CustomEvent<{ value: string; }>` |
+| Event           | Type                              | Description                                |
+|-----------------|-----------------------------------|--------------------------------------------|
+| `quads-changed` | `CustomEvent<{ value: Quad[] }>`  | dispatched when the input quads are parsed |
+| `value-changed` | `CustomEvent<{ value: string; }>` |                                            |
 
 ## CSS Shadow Parts
 

diff --git a/packages/rdf-snippet/custom-elements.json b/packages/rdf-snippet/custom-elements.json
@@ -210,8 +210,9 @@
             {
               "name": "quads-changed",
               "type": {
-                "text": "CustomEvent"
-              }
+                "text": "CustomEvent<{ value: Quad[] }>"
+              },
+              "description": "dispatched when the input quads are parsed"
             },
             {
               "name": "value-changed",

diff --git a/packages/rdf-snippet/src/RdfSnippet.js b/packages/rdf-snippet/src/RdfSnippet.js
@@ -75,6 +75,8 @@ const formatLabels = {
  * @csspart input - selection button for the input format
  * @csspart output - selection button for the output formats
  * @csspart selected - the currently selected format button
+ *
+ * @event {CustomEvent<{ value: Quad[] }>} quads-changed - dispatched when the input quads are parsed
  */
 export class RdfSnippet extends LitElement {
   static get properties() {