confirm-dialogpackage.web-types.lit.json Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of vaadin-webcomponents Show documentation
Show all versions of vaadin-webcomponents Show documentation
Mvnpm composite: Vaadin webcomponents
{
"$schema": "https://json.schemastore.org/web-types",
"name": "@vaadin/confirm-dialog",
"version": "24.4.7",
"description-markup": "markdown",
"framework": "lit",
"framework-config": {
"enable-when": {
"node-packages": [
"lit"
]
}
},
"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.7/#/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",
"extension": true,
"attributes": [
{
"name": "?opened",
"description": "True if the overlay is currently displayed.",
"value": {
"kind": "expression"
}
},
{
"name": "?noCloseOnEsc",
"description": "Set to true to disable closing dialog on Escape press",
"value": {
"kind": "expression"
}
},
{
"name": "?rejectButtonVisible",
"description": "Whether to show reject button or not.",
"value": {
"kind": "expression"
}
},
{
"name": "?cancelButtonVisible",
"description": "Whether to show cancel button or not.",
"value": {
"kind": "expression"
}
},
{
"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": {
"kind": "expression"
}
},
{
"name": ".header",
"description": "Set the confirmation dialog title.",
"value": {
"kind": "expression"
}
},
{
"name": ".message",
"description": "Set the message or confirmation question.",
"value": {
"kind": "expression"
}
},
{
"name": ".confirmText",
"description": "Text displayed on confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".confirmTheme",
"description": "Theme for a confirm-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".rejectText",
"description": "Text displayed on reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".rejectTheme",
"description": "Theme for a reject-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".cancelText",
"description": "Text displayed on cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".cancelTheme",
"description": "Theme for a cancel-button.\nThis only affects the default button, custom slotted buttons will not be altered.",
"value": {
"kind": "expression"
}
},
{
"name": ".overlayClass",
"description": "A space-delimited list of CSS class names\nto set on the underlying overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": "@cancel",
"description": "cancel\nfired when Cancel button or Escape key was pressed.",
"value": {
"kind": "expression"
}
},
{
"name": "@confirm",
"description": "confirm\nfired when Confirm button was pressed.",
"value": {
"kind": "expression"
}
},
{
"name": "@reject",
"description": "reject\nfired when Reject button was pressed.",
"value": {
"kind": "expression"
}
},
{
"name": "@opened-changed",
"description": "Fired when the `opened` property changes.",
"value": {
"kind": "expression"
}
}
]
}
]
}
}
}