doc: add more comments to element description

wes-goulet · Jan 17, 2024 · 0529d7c · 0529d7c
1 parent f78b31d
commit 0529d7c
Show file tree

Hide file tree

Showing 5 changed files with 226 additions and 76 deletions.
diff --git a/custom-elements.json b/custom-elements.json
@@ -10,6 +10,18 @@
           "kind": "class",
           "description": "A simple side drawer custom element",
           "name": "SideDrawer",
+          "cssParts": [
+            {
+              "description": "The underlying <dialog> element.",
+              "name": "dialog"
+            }
+          ],
+          "slots": [
+            {
+              "description": "The content to go inside the drawer (the default slot)",
+              "name": ""
+            }
+          ],
           "members": [
             {
               "kind": "field",
@@ -21,18 +33,24 @@
               "name": "close",
               "type": {
                 "text": "CustomEvent"
-              }
+              },
+              "description": "Raised when the drawer is closed."
             },
             {
               "name": "open",
               "type": {
                 "text": "CustomEvent"
-              }
+              },
+              "description": "Raised when the drawer is opened."
             }
           ],
           "attributes": [
             {
-              "name": "open"
+              "name": "open",
+              "type": {
+                "text": "boolean"
+              },
+              "description": "Add this attribute to open the drawer."
             }
           ],
           "superclass": {