@revealbi/ui/web-types.json

{
  "$schema": "https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json",
  "name": "@revealbi/ui",
  "version": "0.3.0",
  "description-markup": "markdown",
  "contributions": {
    "html": {
      "elements": [
        {
          "name": "rv-dialog",
          "description": "Dialogs appear above the page and require the user's immediate attention. They inform users about critical information, require users to make decisions, or involve multiple tasks.\n---\n\n\n### **Methods:**\n - **show(): _Promise<any>_** - Shows the dialog.\n- **close(source: _any | \"close-button\" | \"overlay\"_): _void_** - Hides the dialog.\n\n### **Slots:**\n - **default** - The dialog's main content.\n- **header-actions** - Optional actions to add to the header.\n- **footer** - The dialog's footer, usually one or more buttons representing various options.\n\n### **CSS Properties:**\n - **--width** - The preferred width of the dialog. Note that the dialog will shrink to accommodate smaller screens. _(default: undefined)_\n- **--header-spacing** - The amount of padding to use for the header. _(default: undefined)_\n- **--body-spacing** - The amount of padding to use for the body. _(default: undefined)_\n- **--footer-spacing** - The amount of padding to use for the footer. _(default: undefined)_\n\n### **CSS Parts:**\n - **overlay** - The overlay that covers the screen behind the dialog.\n- **panel** - The dialog's panel (where the dialog and its content are rendered).\n- **header** - The dialog's header. This element wraps the title and header actions.\n- **header-actions** - Optional actions to add to the header.\n- **title** - The dialog's title.\n- **close-button** - The close button.\n- **content** - The dialog's content.\n- **footer** - The dialog's footer.",
          "doc-url": "",
          "attributes": [
            {
              "name": "title",
              "description": "The dialog's title as displayed in the header.",
              "value": { "type": "string", "default": "\"\"" }
            },
            {
              "name": "open",
              "description": "Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can\nuse the `show()` and `close()` methods and this attribute will reflect the dialog's open state.",
              "value": { "type": "boolean", "default": "false" }
            }
          ],
          "slots": [
            { "name": "default", "description": "The dialog's main content." },
            {
              "name": "header-actions",
              "description": "Optional actions to add to the header."
            },
            {
              "name": "footer",
              "description": "The dialog's footer, usually one or more buttons representing various options."
            }
          ],
          "events": [],
          "js": {
            "properties": [
              {
                "name": "title",
                "description": "The dialog's title as displayed in the header.",
                "type": "string"
              },
              {
                "name": "open",
                "description": "Indicates whether or not the dialog is open. You can toggle this attribute to show and hide the dialog, or you can\nuse the `show()` and `close()` methods and this attribute will reflect the dialog's open state.",
                "type": "boolean"
              }
            ],
            "events": []
          }
        }
      ]
    }
  }
}