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/dialog",
"version": "24.4.7",
"description-markup": "markdown",
"framework": "lit",
"framework-config": {
"enable-when": {
"node-packages": [
"lit"
]
}
},
"contributions": {
"html": {
"elements": [
{
"name": "vaadin-dialog",
"description": "`` is a Web Component for creating customized modal dialogs.\n\n### Rendering\n\nThe content of the dialog can be populated by using the renderer callback function.\n\nThe renderer function provides `root`, `dialog` arguments.\nGenerate DOM content, append it to the `root` element and control the state\nof the host element by accessing `dialog`. Before generating new content,\nusers are able to check if there is already content in `root` for reusing it.\n\n```html\n` uses `` internal\nthemable component as the actual visible dialog overlay.\n\nSee [``](https://cdn.vaadin.com/vaadin-web-components/24.4.7/#/elements/vaadin-overlay) documentation.\nfor `` parts.\n\nIn addition to `` parts, the following parts are available for styling:\n\nPart name | Description\n-----------------|-------------------------------------------\n`header` | Element wrapping title and header content\n`header-content` | Element wrapping the header content slot\n`title` | Element wrapping the title slot\n`footer` | Element wrapping the footer slot\n\nThe following state attributes are available for styling:\n\nAttribute | Description\n-----------------|--------------------------------------------\n`has-title` | Set when the element has a title\n`has-header` | Set when the element has header renderer\n`has-footer` | Set when the element has footer renderer\n`overflow` | Set to `top`, `bottom`, none or both\n\nNote: the `theme` attribute value set on `` is\npropagated to the internal `` component.\n\nSee [Styling Components](https://vaadin.com/docs/latest/styling/styling-components) documentation.",
"extension": true,
"attributes": [
{
"name": "?opened",
"description": "True if the overlay is currently displayed.",
"value": {
"kind": "expression"
}
},
{
"name": "?noCloseOnOutsideClick",
"description": "Set to true to disable closing dialog on outside click",
"value": {
"kind": "expression"
}
},
{
"name": "?noCloseOnEsc",
"description": "Set to true to disable closing dialog on Escape press",
"value": {
"kind": "expression"
}
},
{
"name": "?modeless",
"description": "Set to true to remove backdrop and allow click events on background elements.",
"value": {
"kind": "expression"
}
},
{
"name": "?draggable",
"description": "Set to true to enable repositioning the dialog by clicking and dragging.\n\nBy default, only the overlay area can be used to drag the element. But,\na child element can be marked as a draggable area by adding a\n\"`draggable`\" class to it, this will by default make all of its children draggable also.\nIf you want a child element to be draggable\nbut still have its children non-draggable (by default), mark it with\n\"`draggable-leaf-only`\" class name.",
"value": {
"kind": "expression"
}
},
{
"name": "?resizable",
"description": "Set to true to enable resizing the dialog by dragging the corners and edges.",
"value": {
"kind": "expression"
}
},
{
"name": ".renderer",
"description": "Custom function for rendering the content of the dialog.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `` element.",
"value": {
"kind": "expression"
}
},
{
"name": ".headerTitle",
"description": "String used for rendering a dialog title.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerTitle` is set, the attribute `has-title` is added to the overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": ".headerRenderer",
"description": "Custom function for rendering the dialog header.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `` element.\n\nIf both `headerTitle` and `headerRenderer` are defined, the title\nand the elements created by the renderer will be placed next to\neach other, with the title coming first.\n\nWhen `headerRenderer` is set, the attribute `has-header` is added to the overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": ".footerRenderer",
"description": "Custom function for rendering the dialog footer.\nReceives two arguments:\n\n- `root` The root container DOM element. Append your content to it.\n- `dialog` The reference to the `` element.\n\nWhen `footerRenderer` is set, the attribute `has-footer` is added to the overlay element.",
"value": {
"kind": "expression"
}
},
{
"name": ".overlayClass",
"description": "A space-delimited list of CSS class names to set on the overlay element.\nThis property does not affect other CSS class names set manually via JS.\n\nNote, if the CSS class name was set with this property, clearing it will\nremove it from the overlay, even if the same class name was also added\nmanually, e.g. by using `classList.add()` in the `renderer` function.",
"value": {
"kind": "expression"
}
},
{
"name": ".ariaLabel",
"description": "Set the `aria-label` attribute for assistive technologies like\nscreen readers. An empty string value for this property (the\ndefault) means that the `aria-label` attribute is not present.",
"value": {
"kind": "expression"
}
},
{
"name": "@resize",
"description": "Fired when the dialog resize is finished.",
"value": {
"kind": "expression"
}
},
{
"name": "@opened-changed",
"description": "Fired when the `opened` property changes.",
"value": {
"kind": "expression"
}
}
]
}
]
}
}
}