custom-elements.json

{
  "version": "experimental",
  "tags": [
    {
      "name": "my-element",
      "path": "./src/my-element.ts",
      "description": "An example element.",
      "attributes": [
        {
          "name": "name",
          "description": "The name to say \"Hello\" to.",
          "type": "string",
          "default": "\"World\""
        },
        {
          "name": "evt",
          "type": "KeyboardEvent | undefined"
        },
        {
          "name": "count",
          "description": "The number of times the button has been clicked.",
          "type": "number",
          "default": "0"
        }
      ],
      "properties": [
        {
          "name": "name",
          "attribute": "name",
          "description": "The name to say \"Hello\" to.",
          "type": "string",
          "default": "\"World\""
        },
        {
          "name": "evt",
          "attribute": "evt",
          "type": "KeyboardEvent | undefined"
        },
        {
          "name": "count",
          "attribute": "count",
          "description": "The number of times the button has been clicked.",
          "type": "number",
          "default": "0"
        },
        {
          "name": "handleKey"
        },
        {
          "name": "renderRoot",
          "description": "Node or ShadowRoot into which element DOM should be rendered. Defaults\nto an open shadowRoot.",
          "type": "HTMLElement | ShadowRoot"
        },
        {
          "name": "isUpdatePending",
          "type": "boolean"
        },
        {
          "name": "hasUpdated",
          "type": "boolean"
        },
        {
          "name": "updateComplete",
          "description": "Returns a Promise that resolves when the element has completed updating.\nThe Promise value is a boolean that is `true` if the element completed the\nupdate without triggering another update. The Promise result is `false` if\na property was set inside `updated()`. If the Promise is rejected, an\nexception was thrown during the update.\n\nTo await additional asynchronous work, override the `getUpdateComplete`\nmethod. For example, it is sometimes useful to await a rendered element\nbefore fulfilling this Promise. To do this, first await\n`super.getUpdateComplete()`, then any subsequent state.",
          "type": "Promise<boolean>"
        }
      ],
      "slots": [
        {
          "name": "",
          "description": "This element has a slot"
        }
      ],
      "cssParts": [
        {
          "name": "button",
          "description": "The button"
        }
      ]
    }
  ]
}