All Downloads are FREE. Search and download functionalities are using the official Maven repository.

package.web-types.json Maven / Gradle / Ivy

There is a newer version: 24.5.4
Show newest version
{
  "$schema": "https://json.schemastore.org/web-types",
  "name": "@vaadin/confirm-dialog",
  "version": "24.4.11",
  "description-markup": "markdown",
  "contributions": {
    "html": {
      "elements": [
        {
          "name": "vaadin-confirm-dialog",
          "description": "`` is a Web Component for showing alerts and asking for user confirmation.\n\n```\n\n  There are unsaved changes. Do you really want to leave?\n\n```\n\n### Styling\n\nThe `` is not themable. Apply styles to ``\ncomponent and use its shadow parts for styling.\nSee [``](https://cdn.vaadin.com/vaadin-web-components/24.4.11/#/elements/vaadin-overlay) for the overlay styling documentation.\n\nIn addition to `` parts, the following parts are available for theming:\n\nPart name        | Description\n-----------------|-------------------------------------------\n`header`         | The header element wrapper\n`message`        | The message element wrapper\n`footer`         | The footer element that wraps the buttons\n`cancel-button`  | The \"Cancel\" button wrapper\n`confirm-button` | The \"Confirm\" button wrapper\n`reject-button`  | The \"Reject\" button wrapper\n\nUse `confirmTheme`, `cancelTheme` and `rejectTheme` properties to customize buttons theme.\nAlso, the `theme` attribute value set on `` is propagated to the\n`` component.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.\n\n### Custom content\n\nThe following slots are available for providing custom content:\n\nSlot name         | Description\n------------------|---------------------------\n`header`          | Slot for header element\n`cancel-button`   | Slot for \"Cancel\" button\n`confirm-button`  | Slot for \"Confirm\" button\n`reject-button`   | Slot for \"Reject\" button",
          "attributes": [
            {
              "name": "accessible-description-ref",
              "description": "Sets the `aria-describedby` attribute of the overlay element.\n\nBy default, all elements inside the message area are linked\nthrough the `aria-describedby` attribute. However, there are\ncases where this can confuse screen reader users (e.g. the dialog\nmay present a password confirmation form). For these cases,\nit's better to associate only the elements that will help describe\nthe confirmation dialog through this API.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            },
            {
              "name": "opened",
              "description": "True if the overlay is currently displayed.",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "header",
              "description": "Set the confirmation dialog title.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "message",
              "description": "Set the message or confirmation question.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            },
            {
              "name": "confirm-text",
              "description": "Text displayed on confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "confirm-theme",
              "description": "Theme for a confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "no-close-on-esc",
              "description": "Set to true to disable closing dialog on Escape press",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "reject-button-visible",
              "description": "Whether to show reject button or not.",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "reject-text",
              "description": "Text displayed on reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "reject-theme",
              "description": "Theme for a reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "cancel-button-visible",
              "description": "Whether to show cancel button or not.",
              "value": {
                "type": [
                  "boolean"
                ]
              }
            },
            {
              "name": "cancel-text",
              "description": "Text displayed on cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "cancel-theme",
              "description": "Theme for a cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
              "value": {
                "type": [
                  "string"
                ]
              }
            },
            {
              "name": "overlay-class",
              "description": "A space-delimited list of CSS class names\nto set on the underlying overlay element.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            },
            {
              "name": "theme",
              "description": "The theme variants to apply to the component.",
              "value": {
                "type": [
                  "string",
                  "null",
                  "undefined"
                ]
              }
            }
          ],
          "js": {
            "properties": [
              {
                "name": "accessibleDescriptionRef",
                "description": "Sets the `aria-describedby` attribute of the overlay element.\n\nBy default, all elements inside the message area are linked\nthrough the `aria-describedby` attribute. However, there are\ncases where this can confuse screen reader users (e.g. the dialog\nmay present a password confirmation form). For these cases,\nit's better to associate only the elements that will help describe\nthe confirmation dialog through this API.",
                "value": {
                  "type": [
                    "string",
                    "null",
                    "undefined"
                  ]
                }
              },
              {
                "name": "opened",
                "description": "True if the overlay is currently displayed.",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              },
              {
                "name": "header",
                "description": "Set the confirmation dialog title.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "message",
                "description": "Set the message or confirmation question.",
                "value": {
                  "type": [
                    "string",
                    "null",
                    "undefined"
                  ]
                }
              },
              {
                "name": "confirmText",
                "description": "Text displayed on confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "confirmTheme",
                "description": "Theme for a confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "noCloseOnEsc",
                "description": "Set to true to disable closing dialog on Escape press",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              },
              {
                "name": "rejectButtonVisible",
                "description": "Whether to show reject button or not.",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              },
              {
                "name": "rejectText",
                "description": "Text displayed on reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "rejectTheme",
                "description": "Theme for a reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "cancelButtonVisible",
                "description": "Whether to show cancel button or not.",
                "value": {
                  "type": [
                    "boolean"
                  ]
                }
              },
              {
                "name": "cancelText",
                "description": "Text displayed on cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "cancelTheme",
                "description": "Theme for a cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
                "value": {
                  "type": [
                    "string"
                  ]
                }
              },
              {
                "name": "overlayClass",
                "description": "A space-delimited list of CSS class names\nto set on the underlying overlay element.",
                "value": {
                  "type": [
                    "string",
                    "null",
                    "undefined"
                  ]
                }
              }
            ],
            "events": [
              {
                "name": "cancel",
                "description": "cancel\nfired when Cancel button or Escape key was pressed."
              },
              {
                "name": "confirm",
                "description": "confirm\nfired when Confirm button was pressed."
              },
              {
                "name": "reject",
                "description": "reject\nfired when Reject button was pressed."
              },
              {
                "name": "opened-changed",
                "description": "Fired when the `opened` property changes."
              }
            ]
          }
        }
      ]
    }
  }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy